Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetPrincipalTagAttributeMap

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

Request Syntax


{
   "IdentityPoolId": "string",
   "IdentityProviderName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

IdentityPoolId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+:[0-9a-f-]+

Required: Yes

IdentityProviderName

You can use this operation to get the provider name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Syntax


{
   "IdentityPoolId": "string",
   "IdentityProviderName": "string",
   "PrincipalTags": { 
      "string" : "string" 
   },
   "UseDefaults": boolean
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

IdentityPoolId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+:[0-9a-f-]+

IdentityProviderName

You can use this operation to get the provider name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

PrincipalTags

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

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 1. Maximum length of 256.

UseDefaults

You can use this operation to list

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalErrorException

Thrown when the service encounters an error during processing the request.

message: The message returned by an InternalErrorException.

HTTP Status Code: 500

InvalidParameterException

Thrown for missing or bad input parameter(s).

message: The message returned by an InvalidParameterException.

HTTP Status Code: 400

NotAuthorizedException

Thrown when a user is not authorized to access the requested resource.

message: The message returned by a NotAuthorizedException

HTTP Status Code: 400

ResourceNotFoundException

Thrown when the requested resource (for example, a dataset or record) does not exist.

message: The message returned by a ResourceNotFoundException.

HTTP Status Code: 400

TooManyRequestsException

Thrown when a request is throttled.

message: Message returned by a TooManyRequestsException

HTTP Status Code: 400