CognitoIdentity / Client / get_principal_tag_attribute_map

get_principal_tag_attribute_map#

CognitoIdentity.Client.get_principal_tag_attribute_map(**kwargs)#

Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.

See also: AWS API Documentation

Request Syntax

response = client.get_principal_tag_attribute_map(
    IdentityPoolId='string',
    IdentityProviderName='string'
)
Parameters:

  • IdentityPoolId (string) –

    [REQUIRED]

    You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.

  • IdentityProviderName (string) –

    [REQUIRED]

    You can use this operation to get the provider name.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityPoolId': 'string',
    'IdentityProviderName': 'string',
    'UseDefaults': True|False,
    'PrincipalTags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • IdentityPoolId (string) –

      You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.

    • IdentityProviderName (string) –

      You can use this operation to get the provider name.

    • UseDefaults (boolean) –

      You can use this operation to list

    • PrincipalTags (dict) –

      You can use this operation to add principal tags. The ``PrincipalTags``operation enables you to reference user attributes in your IAM permissions policy.

      • (string) –

        • (string) –

Exceptions