ListAccessGrantsInstances
Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have one S3 Access Grants instance per Region per account.
- Permissions
-
You must have the
s3:ListAccessGrantsInstancespermission to use this operation.
Request Syntax
GET /v20180820/accessgrantsinstances?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of access grants that you would like returned in the
List Access Grantsresponse. If the results include the pagination tokenNextToken, make another call using theNextTokento determine if there are more results.Valid Range: Minimum value of 0. Maximum value of 1000.
- nextToken
-
A pagination token to request the next page of results. Pass this value into a subsequent
List Access Grants Instancesrequest in order to retrieve the next page of results. - x-amz-account-id
-
The AWS account ID of the S3 Access Grants instance.
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListAccessGrantsInstancesResult>
<NextToken>string</NextToken>
<AccessGrantsInstancesList>
<AccessGrantsInstance>
<AccessGrantsInstanceArn>string</AccessGrantsInstanceArn>
<AccessGrantsInstanceId>string</AccessGrantsInstanceId>
<CreatedAt>timestamp</CreatedAt>
<IdentityCenterApplicationArn>string</IdentityCenterApplicationArn>
<IdentityCenterArn>string</IdentityCenterArn>
<IdentityCenterInstanceArn>string</IdentityCenterInstanceArn>
</AccessGrantsInstance>
</AccessGrantsInstancesList>
</ListAccessGrantsInstancesResult>Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- ListAccessGrantsInstancesResult
-
Root level tag for the ListAccessGrantsInstancesResult parameters.
Required: Yes
- AccessGrantsInstancesList
-
A container for a list of S3 Access Grants instances.
Type: Array of ListAccessGrantsInstanceEntry data types
- NextToken
-
A pagination token to request the next page of results. Pass this value into a subsequent
List Access Grants Instancesrequest in order to retrieve the next page of results.Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
