objectPutAcl method
Uploads an access control list for an object.
Note
ACLs can be uploaded as XML documents or using special X-Amz-Grant*
headers. Do not use an XML document and X-Amz-Grant*
headers in the same request.
For more information on getting started with the API and the general request format, see How to use the S3 API.
Request
PUT /{bucket}/{key}?acl HTTP/2
Path parameters
Parameter | Description |
---|---|
bucket |
Bucket name. |
key |
Object key. ID for saving the object in Object Storage. |
Query parameters
Parameter | Description |
---|---|
acl |
Required parameter that indicates the type of operation. |
Headers
Use the appropriate common headers in your request.
You can also use the headers listed below.
Header | Description |
---|---|
X-Amz-Acl |
Sets a predefined ACL for an object. |
X-Amz-Grant-Read |
Grants the access grantee object read permission. |
X-Amz-Grant-Read-Acp |
Grants the access grantee object ACL read permission. |
X-Amz-Grant-Write-Acp |
Grants the access grantee object ACL write permission. |
X-Amz-Grant-Full-Control |
Grants the access grantee the READ , WRITE , READ_ACP , and WRITE_ACP permissions for the object. |
The value for the X-Amz-Grant-*
headers is a comma-separated list of access grantees. Each access grantee is identified in a structure <access_grantee_type>:<access_grantee_ID>
. Object Storage supports the following types of access grantees:
id
: Access grantee is a cloud user.uri
: Access grantee is a public group.
Example:
X-Amz-Grant-Read: uri="http://acs.amazonaws.com/groups/s3/AuthenticatedUsers"
Data schema
ACLs are passed as XML documents. For the schema description, see ACL XML schema.
Response
Headers
Responses can only contain common response headers.
Response codes
For a list of possible responses, see Responses.