GetBucketAclCommand

Suggest an Edit

End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.

This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.

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 .

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.

The following operations are related to GetBucketAcl:

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { S3Client, GetBucketAclCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetBucketAclCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // GetBucketAclRequest
  Bucket: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetBucketAclCommand(input);
const response = await client.send(command);
// { // GetBucketAclOutput
//   Owner: { // Owner
//     DisplayName: "STRING_VALUE",
//     ID: "STRING_VALUE",
//   },
//   Grants: [ // Grants
//     { // Grant
//       Grantee: { // Grantee
//         DisplayName: "STRING_VALUE",
//         EmailAddress: "STRING_VALUE",
//         ID: "STRING_VALUE",
//         URI: "STRING_VALUE",
//         Type: "CanonicalUser" || "AmazonCustomerByEmail" || "Group", // required
//       },
//       Permission: "FULL_CONTROL" || "WRITE" || "WRITE_ACP" || "READ" || "READ_ACP",
//     },
//   ],
// };

GetBucketAclCommand Input

See GetBucketAclCommandInput for more details

Parameter
Type
Description
Bucket
Required
string | undefined

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 .

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

ExpectedBucketOwner
string | undefined

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).

GetBucketAclCommand Output

See GetBucketAclCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Grants
Grant[] | undefined

A list of grants.

Owner
Owner | undefined

Container for the bucket owner's display name and ID.

Throws

Name
Fault
Details
S3ServiceException
Base exception class for all service exceptions from S3 service.