DescribeAccessPolicy - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Describes an access policy, which specifies an identity's access to an Amazon IoT SiteWise Monitor portal or project.

Request Syntax

GET /access-policies/accessPolicyId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The ID of the access policy.

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "accessPolicyArn": "string", "accessPolicyCreationDate": number, "accessPolicyId": "string", "accessPolicyIdentity": { "group": { "id": "string" }, "iamRole": { "arn": "string" }, "iamUser": { "arn": "string" }, "user": { "id": "string" } }, "accessPolicyLastUpdateDate": number, "accessPolicyPermission": "string", "accessPolicyResource": { "portal": { "id": "string" }, "project": { "id": "string" } } }

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.


The ARN of the access policy, which has the following format.


Type: String

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

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$


The date the access policy was created, in Unix epoch time.

Type: Timestamp


The ID of the access policy.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$


The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.

Type: Identity object


The date the access policy was last updated, in Unix epoch time.

Type: Timestamp


The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.

Type: String



The Amazon IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.

Type: Resource object


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


Amazon IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500


The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400


The requested resource can't be found.

HTTP Status Code: 404


Your request exceeded a rate limit. For example, you might have exceeded the number of Amazon IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the Amazon IoT SiteWise User Guide.

HTTP Status Code: 429

See Also

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