PutAccessPointScope
Creates or replaces the access point scope for a directory bucket. You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.
Note
You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.
To use this operation, you must have the permission to perform the
s3express:PutAccessPointScope action.
For information about REST API errors, see REST error responses.
Request Syntax
PUT /v20180820/accesspoint/name/scope HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
<?xml version="1.0" encoding="UTF-8"?>
<PutAccessPointScopeRequest xmlns="http://awss3control.amazonaws.com/doc/2018-08-20/">
<Scope>
<Permissions>
<Permission>string</Permission>
</Permissions>
<Prefixes>
<Prefix>string</Prefix>
</Prefixes>
</Scope>
</PutAccessPointScopeRequest>URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of the access point with the scope that you want to create or replace.
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 scope that you want to create or replace.
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$Required: Yes
Request Body
The request accepts the following data in XML format.
- PutAccessPointScopeRequest
-
Root level tag for the PutAccessPointScopeRequest parameters.
Required: Yes
- Scope
-
Object prefixes, API operations, or a combination of both.
Type: Scope data type
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
