Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Allows the developer to update the specified user pool client and password policy.

Creating a Request

updateUserPoolClient

Arguments

:: Text

uupcUserPoolId

-> Text

uupcClientId

-> UpdateUserPoolClient

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

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

• uupcRefreshTokenValidity - The time limit, in days, after which the refresh token is no longer valid and cannot be used.
• uupcExplicitAuthFlows - Explicit authentication flows.
• uupcSupportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.
• uupcLogoutURLs - A list of allowed logout URLs for the identity providers.
• uupcAllowedOAuthFlowsUserPoolClient - Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
• uupcDefaultRedirectURI - The default redirect URI. Must be in the CallbackURLs list.
• uupcWriteAttributes - The writeable attributes of the user pool.
• uupcReadAttributes - The read-only attributes of the user pool.
• uupcAllowedOAuthScopes - A list of allowed OAuth scopes. Currently supported values are "phone" , "email" , "openid" , and Cognito .
• uupcAllowedOAuthFlows - 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.
• uupcAnalyticsConfiguration - The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
• uupcClientName - The client name from the update user pool client request.
• uupcCallbackURLs - A list of allowed callback URLs for the identity providers.
• uupcUserPoolId - The user pool ID for the user pool where you want to update the user pool client.
• uupcClientId - The ID of the client associated with the user pool.

data UpdateUserPoolClient

Represents the request to update the user pool client.

See: updateUserPoolClient smart constructor.

Instances

Eq UpdateUserPoolClient

Methods

(==) :: UpdateUserPoolClient -> UpdateUserPoolClient -> Bool

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

Data UpdateUserPoolClient

Methods

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

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

toConstr :: UpdateUserPoolClient -> Constr

dataTypeOf :: UpdateUserPoolClient -> DataType

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

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

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

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

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

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

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

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

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

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

Show UpdateUserPoolClient

Methods

showsPrec :: Int -> UpdateUserPoolClient -> ShowS

show :: UpdateUserPoolClient -> String

showList :: [UpdateUserPoolClient] -> ShowS

Generic UpdateUserPoolClient

Associated Types

type Rep UpdateUserPoolClient :: * -> *

Methods

from :: UpdateUserPoolClient -> Rep UpdateUserPoolClient x

to :: Rep UpdateUserPoolClient x -> UpdateUserPoolClient

Hashable UpdateUserPoolClient

Methods

hashWithSalt :: Int -> UpdateUserPoolClient -> Int

hash :: UpdateUserPoolClient -> Int

ToJSON UpdateUserPoolClient

Methods

toJSON :: UpdateUserPoolClient -> Value

toEncoding :: UpdateUserPoolClient -> Encoding

toJSONList :: [UpdateUserPoolClient] -> Value

toEncodingList :: [UpdateUserPoolClient] -> Encoding

NFData UpdateUserPoolClient

Methods

rnf :: UpdateUserPoolClient -> ()

AWSRequest UpdateUserPoolClient

Associated Types

type Rs UpdateUserPoolClient :: *

Methods

request :: UpdateUserPoolClient -> Request UpdateUserPoolClient

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

ToHeaders UpdateUserPoolClient

Methods

toHeaders :: UpdateUserPoolClient -> [Header]

ToPath UpdateUserPoolClient

Methods

toPath :: UpdateUserPoolClient -> ByteString

ToQuery UpdateUserPoolClient

Methods

toQuery :: UpdateUserPoolClient -> QueryString

type Rep UpdateUserPoolClient

type Rep UpdateUserPoolClient = D1 * (MetaData "UpdateUserPoolClient" "Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "UpdateUserPoolClient'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_uupcRefreshTokenValidity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_uupcExplicitAuthFlows") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ExplicitAuthFlowsType]))) (S1 * (MetaSel (Just Symbol "_uupcSupportedIdentityProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_uupcLogoutURLs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_uupcAllowedOAuthFlowsUserPoolClient") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_uupcDefaultRedirectURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_uupcWriteAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_uupcReadAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_uupcAllowedOAuthScopes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_uupcAllowedOAuthFlows") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [OAuthFlowType]))) (S1 * (MetaSel (Just Symbol "_uupcAnalyticsConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AnalyticsConfigurationType))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_uupcClientName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_uupcCallbackURLs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_uupcUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_uupcClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text))))))))

type Rs UpdateUserPoolClient

type Rs UpdateUserPoolClient = UpdateUserPoolClientResponse

Request Lenses

uupcRefreshTokenValidity :: Lens' UpdateUserPoolClient (Maybe Natural)

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

uupcExplicitAuthFlows :: Lens' UpdateUserPoolClient [ExplicitAuthFlowsType]

Explicit authentication flows.

uupcSupportedIdentityProviders :: Lens' UpdateUserPoolClient [Text]

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

uupcLogoutURLs :: Lens' UpdateUserPoolClient [Text]

A list of allowed logout URLs for the identity providers.

uupcAllowedOAuthFlowsUserPoolClient :: Lens' UpdateUserPoolClient (Maybe Bool)

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

uupcDefaultRedirectURI :: Lens' UpdateUserPoolClient (Maybe Text)

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

uupcWriteAttributes :: Lens' UpdateUserPoolClient [Text]

The writeable attributes of the user pool.

uupcReadAttributes :: Lens' UpdateUserPoolClient [Text]

The read-only attributes of the user pool.

uupcAllowedOAuthScopes :: Lens' UpdateUserPoolClient [Text]

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

uupcAllowedOAuthFlows :: Lens' UpdateUserPoolClient [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.

uupcAnalyticsConfiguration :: Lens' UpdateUserPoolClient (Maybe AnalyticsConfigurationType)

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

uupcClientName :: Lens' UpdateUserPoolClient (Maybe Text)

The client name from the update user pool client request.

uupcCallbackURLs :: Lens' UpdateUserPoolClient [Text]

A list of allowed callback URLs for the identity providers.

uupcUserPoolId :: Lens' UpdateUserPoolClient Text

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

uupcClientId :: Lens' UpdateUserPoolClient Text

The ID of the client associated with the user pool.

Destructuring the Response

updateUserPoolClientResponse

Arguments

:: Int

uupcrsResponseStatus

-> UpdateUserPoolClientResponse

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

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

• uupcrsUserPoolClient - The user pool client value from the response from the server when an update user pool client request is made.
• uupcrsResponseStatus - -- | The response status code.

data UpdateUserPoolClientResponse

Represents the response from the server to the request to update the user pool client.

See: updateUserPoolClientResponse smart constructor.

Instances

Eq UpdateUserPoolClientResponse

Methods

(==) :: UpdateUserPoolClientResponse -> UpdateUserPoolClientResponse -> Bool

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

Data UpdateUserPoolClientResponse

Methods

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

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

toConstr :: UpdateUserPoolClientResponse -> Constr

dataTypeOf :: UpdateUserPoolClientResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Show UpdateUserPoolClientResponse

Methods

showsPrec :: Int -> UpdateUserPoolClientResponse -> ShowS

show :: UpdateUserPoolClientResponse -> String

showList :: [UpdateUserPoolClientResponse] -> ShowS

Generic UpdateUserPoolClientResponse

Associated Types

type Rep UpdateUserPoolClientResponse :: * -> *

Methods

from :: UpdateUserPoolClientResponse -> Rep UpdateUserPoolClientResponse x

to :: Rep UpdateUserPoolClientResponse x -> UpdateUserPoolClientResponse

NFData UpdateUserPoolClientResponse

Methods

rnf :: UpdateUserPoolClientResponse -> ()

type Rep UpdateUserPoolClientResponse

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

Response Lenses

uupcrsUserPoolClient :: Lens' UpdateUserPoolClientResponse (Maybe UserPoolClientType)

The user pool client value from the response from the server when an update user pool client request is made.

uupcrsResponseStatus :: Lens' UpdateUserPoolClientResponse Int

• - | The response status code.