get_bucket_acl¶
Operation¶
get_bucket_acl
async
¶
get_bucket_acl(request: GetBucketAclInput | GetBucketAclInputDict, /, *, plugins: list[Plugin] | None = None) -> GetBucketAclOutput
get_bucket_acl(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketAclInputDict]) -> GetBucketAclOutput
Note
This operation is not supported for directory buckets.
This implementation of the GET action uses the acl subresource to
return the access control list (ACL) of a bucket. To use GET to return
the ACL of the bucket, you must have the READ_ACP access to the
bucket. If READ_ACP permission is granted to the anonymous user, you
can return the ACL of the bucket without using an authorization header.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point,
provide the alias of the Object Lambda access point in place of the
bucket name. If the Object Lambda access point alias in a request is not
valid, the error code InvalidAccessPointAliasError is returned. For
more information about InvalidAccessPointAliasError, see List of
Error
Codes.
Note
If your bucket uses the bucket owner enforced setting for S3 Object
Ownership, requests to read ACLs are still supported and return the
bucket-owner-full-control ACL with the owner being the account that
created the bucket. For more information, see Controlling object
ownership and disabling
ACLs
in the Amazon S3 User Guide.
Warning:
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.
The following operations are related to GetBucketAcl:
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetBucketAclOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
GetBucketAclInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBucketAclInput structure.
Attributes¶
bucket
class-attribute
instance-attribute
¶
bucket: str | None = ...
Specifies the S3 bucket whose ACL is being requested.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point,
provide the alias of the Object Lambda access point in place of the
bucket name. If the Object Lambda access point alias in a request is not
valid, the error code InvalidAccessPointAliasError is returned. For
more information about InvalidAccessPointAliasError, see List of
Error
Codes.
expected_bucket_owner
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
The account ID of the expected bucket owner. If the account ID that you
provide does not match the actual owner of the bucket, the request fails
with the HTTP status code 403 Forbidden (access denied).
Dictionaries¶
GetBucketAclInputDict
¶
Bases: TypedDict
Dictionary form of GetBucketAclInput.
Attributes¶
bucket
instance-attribute
¶
Specifies the S3 bucket whose ACL is being requested.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point,
provide the alias of the Object Lambda access point in place of the
bucket name. If the Object Lambda access point alias in a request is not
valid, the error code InvalidAccessPointAliasError is returned. For
more information about InvalidAccessPointAliasError, see List of
Error
Codes.
Output¶
GetBucketAclOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBucketAclOutput structure.
Attributes¶
owner
class-attribute
instance-attribute
¶
owner: Owner | None = ...
Container for the bucket owner's ID.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.