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.AddCustomAttributes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds additional user attributes to the user pool schema.

Creating a Request

data AddCustomAttributes Source #

Represents the request to add custom attributes.

See: newAddCustomAttributes smart constructor.

Constructors

AddCustomAttributes'
Fields userPoolId :: Text The user pool ID for the user pool where you want to add custom attributes. customAttributes :: NonEmpty SchemaAttributeType An array of custom attributes, such as Mutable and Name.

Instances

Instances details

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

newAddCustomAttributes Source #

Arguments

:: Text	`AddCustomAttributes`
-> NonEmpty SchemaAttributeType	`$sel:customAttributes:AddCustomAttributes'`
-> AddCustomAttributes

Create a value of AddCustomAttributes 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:

AddCustomAttributes, addCustomAttributes_userPoolId - The user pool ID for the user pool where you want to add custom attributes.

$sel:customAttributes:AddCustomAttributes', addCustomAttributes_customAttributes - An array of custom attributes, such as Mutable and Name.

Request Lenses

addCustomAttributes_userPoolId :: Lens' AddCustomAttributes Text Source #

The user pool ID for the user pool where you want to add custom attributes.

addCustomAttributes_customAttributes :: Lens' AddCustomAttributes (NonEmpty SchemaAttributeType) Source #

An array of custom attributes, such as Mutable and Name.

Destructuring the Response

data AddCustomAttributesResponse Source #

Represents the response from the server for the request to add custom attributes.

See: newAddCustomAttributesResponse smart constructor.

Constructors

AddCustomAttributesResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newAddCustomAttributesResponse Source #

Arguments

:: Int	`$sel:httpStatus:AddCustomAttributesResponse'`
-> AddCustomAttributesResponse

Create a value of AddCustomAttributesResponse 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:AddCustomAttributesResponse', addCustomAttributesResponse_httpStatus - The response's http status code.

Response Lenses

addCustomAttributesResponse_httpStatus :: Lens' AddCustomAttributesResponse Int Source #

The response's http status code.