View a markdown version of this page

GetPolicyAssignment - AWS Quick

GetPolicyAssignment

Describes the policy of the specified type that an Amazon Quick Sight principal has. If the principal has no policy of that type, the response contains no policy details.

Request Syntax

GET /governance-policy-mgmt/accounts/AccountId/policy-assignments?PolicyType=PolicyType&PrincipalArn=PrincipalArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AccountId

The ID of the AWS account that contains the principal.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

PolicyType

The type of policy to describe. Choose one of the following values:

  • LIMITS_PROFILE – A limits profile that sets resource usage limits.

  • CUSTOM_PERMISSIONS – A custom permissions profile that restricts the capabilities available to a principal.

Valid Values: LIMITS_PROFILE | CUSTOM_PERMISSIONS

Required: Yes

PrincipalArn

The ARN of the user, group, or account.

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

Pattern: arn:.+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "PolicyArn": "string", "PolicyName": "string", "Revision": number, "UpdatedAt": number }

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.

PolicyArn

The ARN of the policy that the principal has. The response doesn't include this value if the principal has no policy of the requested type.

Type: String

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

Pattern: arn:[\x21-\x39\x3b-\x7e]+:[\x21-\x39\x3b-\x7e]+:[\x21-\x39\x3b-\x7e]*:[0-9]{12}:[\x21-\x7e]+

PolicyName

The display name of the assigned policy. This value is absent if the policy has no name or the name can't be retrieved.

Type: String

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

Revision

The current revision of the assignment. Pass this value in a later PutPolicyAssignment or DeletePolicyAssignment request to make sure that the assignment hasn't changed.

Type: Long

Valid Range: Minimum value of 1.

UpdatedAt

The date and time that the assignment was last updated.

Type: Timestamp

Errors

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

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId

The AWS request ID for this request.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

RequestId

The AWS request ID for this request.

HTTP Status Code: 500

ResourceNotFoundException

One or more resources can't be found.

RequestId

The AWS request ID for this request.

ResourceType

The resource type for this request.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

RequestId

The AWS request ID for this request.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

FieldList

A list of the request fields that failed validation.

RequestId

The AWS request ID for this request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: