ICognitoIdentityProviderUpdateUserAttributesRequest

Interface in AWS.CognitoIdentityProvider

Interface for UpdateUserAttributes requests.

Ancestors

property AccessToken: string

Specify a valid access token that Amazon Cognito issued to the user whose attributes you want to update.

property ClientMetadata: TDictionary<string, string>

Specifies a map of key-value pairs that you can provide as input for any custom workflows that this action triggers.

Use AddClientMetadata to populate values.

property UserAttributes: TList<ICognitoIdentityProviderAttributeType>

Specifies a list of name-value pairs containing user attributes and attribute values to be set for the user to be updated.

For custom attributes, you must prefix the attribute name with custom:.

procedure AddClientMetadata(const AKey, AValue: string);

Add a key-value pair to ClientMetadata.

Parameters

Name	Description
`AKey`	Specify a key for the value.
`AValue`	Specify a value.

function AddUserAttribute(const AName: string; const AValue: string = ''): Integer;

Add a name-value pair to UserAttributes.

Parameters

Name	Description
`AName`	Specify the name of the user attribute to add.
`AValue`	Specify the value of the user attribute to add.

Returns

The index of the added user attribute.