ListAccessPolicies - AWS IoT SiteWise

ListAccessPolicies

Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).

Request Syntax

GET /access-policies?iamArn=iamArn&identityId=identityId&identityType=identityType&maxResults=maxResults&nextToken=nextToken&resourceId=resourceId&resourceType=resourceType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

iamArn

The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.

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

Pattern: .*

identityId

The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.

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

Pattern: \S+

identityType

The type of identity (AWS SSO user, AWS SSO group, or IAM user). This parameter is required if you specify identityId.

Valid Values: USER | GROUP | IAM

maxResults

The maximum number of results to return for each paginated request.

Default: 50

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

The token to be used for the next set of paginated results.

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

Pattern: [A-Za-z0-9+/=]+

resourceId

The ID of the resource. This parameter is required if you specify resourceType.

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}$

resourceType

The type of resource (portal or project). This parameter is required if you specify resourceId.

Valid Values: PORTAL | PROJECT

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "accessPolicySummaries": [ { "creationDate": number, "id": "string", "identity": { "group": { "id": "string" }, "iamRole": { "arn": "string" }, "iamUser": { "arn": "string" }, "user": { "id": "string" } }, "lastUpdateDate": number, "permission": "string", "resource": { "portal": { "id": "string" }, "project": { "id": "string" } } } ], "nextToken": "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.

accessPolicySummaries

A list that summarizes each access policy.

Type: Array of AccessPolicySummary objects

nextToken

The token for the next set of results, or null if there are no additional results.

Type: String

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

Pattern: [A-Za-z0-9+/=]+

Errors

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

InternalFailureException

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

HTTP Status Code: 500

InvalidRequestException

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

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.

HTTP Status Code: 429

See Also

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