ListAccessGrantsLocations
Returns a list of the locations registered in your S3 Access Grants instance.
- Permissions
-
You must have the
s3:ListAccessGrantsLocationspermission to use this operation.
Request Syntax
GET /v20180820/accessgrantsinstance/locations?locationscope=LocationScope&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.
- locationscope
-
The S3 path to the location that you are registering. The location scope can be the default S3 location
s3://, the S3 path to a buckets3://<bucket>, or the S3 path to a bucket and prefixs3://<bucket>/<prefix>. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with theengineering/prefix or object key names that start with themarketing/campaigns/prefix.Length Constraints: Minimum length of 1. Maximum length of 2000.
Pattern:
^.+$ - 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 Locationsrequest 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"?>
<ListAccessGrantsLocationsResult>
<NextToken>string</NextToken>
<AccessGrantsLocationsList>
<AccessGrantsLocation>
<AccessGrantsLocationArn>string</AccessGrantsLocationArn>
<AccessGrantsLocationId>string</AccessGrantsLocationId>
<CreatedAt>timestamp</CreatedAt>
<IAMRoleArn>string</IAMRoleArn>
<LocationScope>string</LocationScope>
</AccessGrantsLocation>
</AccessGrantsLocationsList>
</ListAccessGrantsLocationsResult>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.
- ListAccessGrantsLocationsResult
-
Root level tag for the ListAccessGrantsLocationsResult parameters.
Required: Yes
- AccessGrantsLocationsList
-
A container for a list of registered locations in an S3 Access Grants instance.
Type: Array of ListAccessGrantsLocationsEntry data types
- NextToken
-
A pagination token to request the next page of results. Pass this value into a subsequent
List Access Grants Locationsrequest 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:
