Returns a list of the locations registered in your S3 Access Grants instance.
You must have the s3:ListAccessGrantsLocations
permission to use this operation.
You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt
, containing two spaces after my
, you must URL encode this value to my%20%20file.txt
.
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.
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 bucket s3://<bucket>
, or the S3 path to a bucket and prefix s3://<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 the engineering/
prefix or object key names that start with the marketing/campaigns/
prefix.
Length Constraints: Minimum length of 1. Maximum length of 2000.
Pattern: ^.+$
The maximum number of access grants that you would like returned in the List Access Grants
response. If the results include the pagination token NextToken
, make another call using the NextToken
to determine if there are more results.
Valid Range: Minimum value of 0. Maximum value of 1000.
A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations
request in order to retrieve the next page of results.
The AWS account ID of the S3 Access Grants instance.
Length Constraints: Maximum length of 64.
Pattern: ^\d{12}$
Required: Yes
The request does not have a request body.
Response SyntaxHTTP/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.
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
ListAccessGrantsInstances
ListAccessPoints
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4