Network.AWS.CognitoIdentityProvider.CreateUserPoolClient

Creates the user pool client.

Creating a Request

createUserPoolClient

Arguments

:: Text

cupcUserPoolId

-> Text

cupcClientName

-> CreateUserPoolClient

Creates a value of CreateUserPoolClient with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cupcRefreshTokenValidity - The time limit, in days, after which the refresh token is no longer valid and cannot be used.
• cupcExplicitAuthFlows - The explicit authentication flows.
• cupcSupportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.
• cupcLogoutURLs - A list of allowed logout URLs for the identity providers.
• cupcAllowedOAuthFlowsUserPoolClient - Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
• cupcGenerateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.
• cupcDefaultRedirectURI - The default redirect URI. Must be in the CallbackURLs list.
• cupcWriteAttributes - The write attributes.
• cupcReadAttributes - The read attributes.
• cupcAllowedOAuthScopes - A list of allowed OAuth scopes. Currently supported values are "phone" , "email" , "openid" , and Cognito .
• cupcAllowedOAuthFlows - Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
• cupcAnalyticsConfiguration - The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
• cupcCallbackURLs - A list of allowed callback URLs for the identity providers.
• cupcUserPoolId - The user pool ID for the user pool where you want to create a user pool client.
• cupcClientName - The client name for the user pool client you would like to create.

data CreateUserPoolClient

Represents the request to create a user pool client.

See: createUserPoolClient smart constructor.

Instances

Eq CreateUserPoolClient

Methods

(==) :: CreateUserPoolClient -> CreateUserPoolClient -> Bool

(/=) :: CreateUserPoolClient -> CreateUserPoolClient -> Bool

Data CreateUserPoolClient

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateUserPoolClient -> c CreateUserPoolClient

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateUserPoolClient

toConstr :: CreateUserPoolClient -> Constr

dataTypeOf :: CreateUserPoolClient -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateUserPoolClient)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateUserPoolClient)

gmapT :: (forall b. Data b => b -> b) -> CreateUserPoolClient -> CreateUserPoolClient

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateUserPoolClient -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateUserPoolClient -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateUserPoolClient -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateUserPoolClient -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateUserPoolClient -> m CreateUserPoolClient

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUserPoolClient -> m CreateUserPoolClient

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUserPoolClient -> m CreateUserPoolClient

Read CreateUserPoolClient

Methods

readsPrec :: Int -> ReadS CreateUserPoolClient

readList :: ReadS [CreateUserPoolClient]

readPrec :: ReadPrec CreateUserPoolClient

readListPrec :: ReadPrec [CreateUserPoolClient]

Show CreateUserPoolClient

Methods

showsPrec :: Int -> CreateUserPoolClient -> ShowS

show :: CreateUserPoolClient -> String

showList :: [CreateUserPoolClient] -> ShowS

Generic CreateUserPoolClient

Associated Types

type Rep CreateUserPoolClient :: * -> *

Methods

from :: CreateUserPoolClient -> Rep CreateUserPoolClient x

to :: Rep CreateUserPoolClient x -> CreateUserPoolClient

Hashable CreateUserPoolClient

Methods

hashWithSalt :: Int -> CreateUserPoolClient -> Int

hash :: CreateUserPoolClient -> Int

ToJSON CreateUserPoolClient

Methods

toJSON :: CreateUserPoolClient -> Value

toEncoding :: CreateUserPoolClient -> Encoding

toJSONList :: [CreateUserPoolClient] -> Value

toEncodingList :: [CreateUserPoolClient] -> Encoding

NFData CreateUserPoolClient

Methods

rnf :: CreateUserPoolClient -> ()

AWSRequest CreateUserPoolClient

Associated Types

type Rs CreateUserPoolClient :: *

Methods

request :: CreateUserPoolClient -> Request CreateUserPoolClient

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateUserPoolClient -> ClientResponse -> m (Response CreateUserPoolClient)

ToHeaders CreateUserPoolClient

Methods

toHeaders :: CreateUserPoolClient -> [Header]

ToPath CreateUserPoolClient

Methods

toPath :: CreateUserPoolClient -> ByteString

ToQuery CreateUserPoolClient

Methods

toQuery :: CreateUserPoolClient -> QueryString

type Rep CreateUserPoolClient

type Rep CreateUserPoolClient = D1 * (MetaData "CreateUserPoolClient" "Network.AWS.CognitoIdentityProvider.CreateUserPoolClient" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "CreateUserPoolClient'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cupcRefreshTokenValidity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupcExplicitAuthFlows") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ExplicitAuthFlowsType]))) (S1 * (MetaSel (Just Symbol "_cupcSupportedIdentityProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cupcLogoutURLs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_cupcAllowedOAuthFlowsUserPoolClient") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupcGenerateSecret") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_cupcDefaultRedirectURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cupcWriteAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_cupcReadAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupcAllowedOAuthScopes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_cupcAllowedOAuthFlows") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [OAuthFlowType]))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cupcAnalyticsConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AnalyticsConfigurationType))) (S1 * (MetaSel (Just Symbol "_cupcCallbackURLs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupcUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cupcClientName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))))

type Rs CreateUserPoolClient

type Rs CreateUserPoolClient = CreateUserPoolClientResponse

Request Lenses

cupcRefreshTokenValidity :: Lens' CreateUserPoolClient (Maybe Natural)

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

cupcExplicitAuthFlows :: Lens' CreateUserPoolClient [ExplicitAuthFlowsType]

The explicit authentication flows.

cupcSupportedIdentityProviders :: Lens' CreateUserPoolClient [Text]

A list of provider names for the identity providers that are supported on this client.

cupcLogoutURLs :: Lens' CreateUserPoolClient [Text]

A list of allowed logout URLs for the identity providers.

cupcAllowedOAuthFlowsUserPoolClient :: Lens' CreateUserPoolClient (Maybe Bool)

Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

cupcGenerateSecret :: Lens' CreateUserPoolClient (Maybe Bool)

Boolean to specify whether you want to generate a secret for the user pool client being created.

cupcDefaultRedirectURI :: Lens' CreateUserPoolClient (Maybe Text)

The default redirect URI. Must be in the CallbackURLs list.

cupcWriteAttributes :: Lens' CreateUserPoolClient [Text]

The write attributes.

cupcReadAttributes :: Lens' CreateUserPoolClient [Text]

The read attributes.

cupcAllowedOAuthScopes :: Lens' CreateUserPoolClient [Text]

A list of allowed OAuth scopes. Currently supported values are "phone" , "email" , "openid" , and Cognito .

cupcAllowedOAuthFlows :: Lens' CreateUserPoolClient [OAuthFlowType]

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

cupcAnalyticsConfiguration :: Lens' CreateUserPoolClient (Maybe AnalyticsConfigurationType)

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

cupcCallbackURLs :: Lens' CreateUserPoolClient [Text]

A list of allowed callback URLs for the identity providers.

cupcUserPoolId :: Lens' CreateUserPoolClient Text

The user pool ID for the user pool where you want to create a user pool client.

cupcClientName :: Lens' CreateUserPoolClient Text

The client name for the user pool client you would like to create.

Destructuring the Response

createUserPoolClientResponse

Arguments

:: Int

cupcrsResponseStatus

-> CreateUserPoolClientResponse

Creates a value of CreateUserPoolClientResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cupcrsUserPoolClient - The user pool client that was just created.
• cupcrsResponseStatus - -- | The response status code.

data CreateUserPoolClientResponse

Represents the response from the server to create a user pool client.

See: createUserPoolClientResponse smart constructor.

Instances

Eq CreateUserPoolClientResponse

Methods

(==) :: CreateUserPoolClientResponse -> CreateUserPoolClientResponse -> Bool

(/=) :: CreateUserPoolClientResponse -> CreateUserPoolClientResponse -> Bool

Data CreateUserPoolClientResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateUserPoolClientResponse -> c CreateUserPoolClientResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateUserPoolClientResponse

toConstr :: CreateUserPoolClientResponse -> Constr

dataTypeOf :: CreateUserPoolClientResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateUserPoolClientResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateUserPoolClientResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateUserPoolClientResponse -> CreateUserPoolClientResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateUserPoolClientResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateUserPoolClientResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateUserPoolClientResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateUserPoolClientResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateUserPoolClientResponse -> m CreateUserPoolClientResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUserPoolClientResponse -> m CreateUserPoolClientResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUserPoolClientResponse -> m CreateUserPoolClientResponse

Show CreateUserPoolClientResponse

Methods

showsPrec :: Int -> CreateUserPoolClientResponse -> ShowS

show :: CreateUserPoolClientResponse -> String

showList :: [CreateUserPoolClientResponse] -> ShowS

Generic CreateUserPoolClientResponse

Associated Types

type Rep CreateUserPoolClientResponse :: * -> *

Methods

from :: CreateUserPoolClientResponse -> Rep CreateUserPoolClientResponse x

to :: Rep CreateUserPoolClientResponse x -> CreateUserPoolClientResponse

NFData CreateUserPoolClientResponse

Methods

rnf :: CreateUserPoolClientResponse -> ()

type Rep CreateUserPoolClientResponse

type Rep CreateUserPoolClientResponse = D1 * (MetaData "CreateUserPoolClientResponse" "Network.AWS.CognitoIdentityProvider.CreateUserPoolClient" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "CreateUserPoolClientResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cupcrsUserPoolClient") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserPoolClientType))) (S1 * (MetaSel (Just Symbol "_cupcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cupcrsUserPoolClient :: Lens' CreateUserPoolClientResponse (Maybe UserPoolClientType)

The user pool client that was just created.

cupcrsResponseStatus :: Lens' CreateUserPoolClientResponse Int

• - | The response status code.