Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoIdentityProvider.CreateResourceServer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new OAuth2.0 resource server and defines custom scopes within it.

Synopsis

data CreateResourceServer = CreateResourceServer' {
- scopes :: Maybe [ResourceServerScopeType]
- userPoolId :: Text
- identifier :: Text
- name :: Text
}
newCreateResourceServer :: Text -> Text -> Text -> CreateResourceServer
createResourceServer_scopes :: Lens' CreateResourceServer (Maybe [ResourceServerScopeType])
createResourceServer_userPoolId :: Lens' CreateResourceServer Text
createResourceServer_identifier :: Lens' CreateResourceServer Text
createResourceServer_name :: Lens' CreateResourceServer Text
data CreateResourceServerResponse = CreateResourceServerResponse' {
- httpStatus :: Int
- resourceServer :: ResourceServerType
}
newCreateResourceServerResponse :: Int -> ResourceServerType -> CreateResourceServerResponse
createResourceServerResponse_httpStatus :: Lens' CreateResourceServerResponse Int
createResourceServerResponse_resourceServer :: Lens' CreateResourceServerResponse ResourceServerType

Creating a Request

data CreateResourceServer Source #

See: newCreateResourceServer smart constructor.

Constructors

CreateResourceServer'

Fields

scopes :: Maybe [ResourceServerScopeType]
A list of scopes. Each scope is a key-value map with the keys name and description.
userPoolId :: Text
The user pool ID for the user pool.
identifier :: Text
A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com.
name :: Text
A friendly name for the resource server.

Instances

Instances details

ToJSON CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods toJSON :: CreateResourceServer -> Value # toEncoding :: CreateResourceServer -> Encoding # toJSONList :: [CreateResourceServer] -> Value # toEncodingList :: [CreateResourceServer] -> Encoding #
ToHeaders CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods toHeaders :: CreateResourceServer -> [Header] #
ToPath CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods toPath :: CreateResourceServer -> ByteString #
ToQuery CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods toQuery :: CreateResourceServer -> QueryString #
AWSRequest CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Associated Types type AWSResponse CreateResourceServer # Methods request :: (Service -> Service) -> CreateResourceServer -> Request CreateResourceServer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateResourceServer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateResourceServer))) #
Generic CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Associated Types type Rep CreateResourceServer :: Type -> Type # Methods from :: CreateResourceServer -> Rep CreateResourceServer x # to :: Rep CreateResourceServer x -> CreateResourceServer #
Read CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods readsPrec :: Int -> ReadS CreateResourceServer # readList :: ReadS [CreateResourceServer] # readPrec :: ReadPrec CreateResourceServer # readListPrec :: ReadPrec [CreateResourceServer] #
Show CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods showsPrec :: Int -> CreateResourceServer -> ShowS # show :: CreateResourceServer -> String # showList :: [CreateResourceServer] -> ShowS #
NFData CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods rnf :: CreateResourceServer -> () #
Eq CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods (==) :: CreateResourceServer -> CreateResourceServer -> Bool # (/=) :: CreateResourceServer -> CreateResourceServer -> Bool #
Hashable CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods hashWithSalt :: Int -> CreateResourceServer -> Int # hash :: CreateResourceServer -> Int #
type AWSResponse CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer type AWSResponse CreateResourceServer = CreateResourceServerResponse
type Rep CreateResourceServer Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer type Rep CreateResourceServer = D1 ('MetaData "CreateResourceServer" "Amazonka.CognitoIdentityProvider.CreateResourceServer" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "CreateResourceServer'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "scopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceServerScopeType])) :: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateResourceServer Source #

Arguments

:: Text	`CreateResourceServer`
-> Text	`CreateResourceServer`
-> Text	`CreateResourceServer`
-> CreateResourceServer

Create a value of CreateResourceServer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateResourceServer, createResourceServer_scopes - A list of scopes. Each scope is a key-value map with the keys name and description.

CreateResourceServer, createResourceServer_userPoolId - The user pool ID for the user pool.

CreateResourceServer, createResourceServer_identifier - A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com.

CreateResourceServer, createResourceServer_name - A friendly name for the resource server.

Request Lenses

createResourceServer_scopes :: Lens' CreateResourceServer (Maybe [ResourceServerScopeType]) Source #

A list of scopes. Each scope is a key-value map with the keys name and description.

createResourceServer_userPoolId :: Lens' CreateResourceServer Text Source #

The user pool ID for the user pool.

createResourceServer_identifier :: Lens' CreateResourceServer Text Source #

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com.

createResourceServer_name :: Lens' CreateResourceServer Text Source #

A friendly name for the resource server.

Destructuring the Response

data CreateResourceServerResponse Source #

See: newCreateResourceServerResponse smart constructor.

Constructors

CreateResourceServerResponse'
Fields httpStatus :: Int The response's http status code. resourceServer :: ResourceServerType The newly created resource server.

Instances

Instances details

Generic CreateResourceServerResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Associated Types type Rep CreateResourceServerResponse :: Type -> Type # Methods from :: CreateResourceServerResponse -> Rep CreateResourceServerResponse x # to :: Rep CreateResourceServerResponse x -> CreateResourceServerResponse #
Read CreateResourceServerResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods readsPrec :: Int -> ReadS CreateResourceServerResponse # readList :: ReadS [CreateResourceServerResponse] # readPrec :: ReadPrec CreateResourceServerResponse # readListPrec :: ReadPrec [CreateResourceServerResponse] #
Show CreateResourceServerResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods showsPrec :: Int -> CreateResourceServerResponse -> ShowS # show :: CreateResourceServerResponse -> String # showList :: [CreateResourceServerResponse] -> ShowS #
NFData CreateResourceServerResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods rnf :: CreateResourceServerResponse -> () #
Eq CreateResourceServerResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer Methods (==) :: CreateResourceServerResponse -> CreateResourceServerResponse -> Bool # (/=) :: CreateResourceServerResponse -> CreateResourceServerResponse -> Bool #
type Rep CreateResourceServerResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateResourceServer type Rep CreateResourceServerResponse = D1 ('MetaData "CreateResourceServerResponse" "Amazonka.CognitoIdentityProvider.CreateResourceServer" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "CreateResourceServerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "resourceServer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceServerType)))

newCreateResourceServerResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateResourceServerResponse'`
-> ResourceServerType	`$sel:resourceServer:CreateResourceServerResponse'`
-> CreateResourceServerResponse

Create a value of CreateResourceServerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateResourceServerResponse', createResourceServerResponse_httpStatus - The response's http status code.

$sel:resourceServer:CreateResourceServerResponse', createResourceServerResponse_resourceServer - The newly created resource server.

Response Lenses

createResourceServerResponse_httpStatus :: Lens' CreateResourceServerResponse Int Source #

The response's http status code.

createResourceServerResponse_resourceServer :: Lens' CreateResourceServerResponse ResourceServerType Source #

The newly created resource server.