GetAccessPointScope
Returns the access point scope for a directory bucket.
To use this operation, you must have the permission to perform the
s3express:GetAccessPointScope
action.
For information about REST API errors, see REST error responses.
Important
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
.
Request Syntax
GET /v20180820/accesspoint/name
/scope HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of the access point with the scope you want to retrieve.
Length Constraints: Minimum length of 3. Maximum length of 255.
Required: Yes
- x-amz-account-id
-
The AWS account ID that owns the access point with the scope that you want to retrieve.
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"?>
<GetAccessPointScopeResult>
<Scope>
<Permissions>
<Permission>string</Permission>
</Permissions>
<Prefixes>
<Prefix>string</Prefix>
</Prefixes>
</Scope>
</GetAccessPointScopeResult>
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.
- GetAccessPointScopeResult
-
Root level tag for the GetAccessPointScopeResult parameters.
Required: Yes
- Scope
-
The contents of the access point scope.
Type: Scope data type
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: