Class GetBucketAclCommand

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.

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:

ListObjects

Example

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

import { S3Client, GetBucketAclCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetBucketAclCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
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",
//     },
//   ],
// };

Param: GetBucketAclCommandInput

GetBucketAclCommandInput

Returns

GetBucketAclCommandOutput

See

GetBucketAclCommandInput for command's input shape.
GetBucketAclCommandOutput for command's response shape.
config for S3Client's config shape.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.

Hierarchy

CommandImpl<
    GetBucketAclCommandInput,
    GetBucketAclCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- GetBucketAclCommand

Index

Constructors

constructor

Constructors

constructor

new GetBucketAclCommand(input: GetBucketAclCommandInput): GetBucketAclCommand
Parameters
- input: GetBucketAclCommandInput
Returns GetBucketAclCommand
Inherited from $Command .classBuilder< GetBucketAclCommandInput, GetBucketAclCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [ getEndpointPlugin(config, Command.getEndpointParameterInstructions()), getThrow200ExceptionsPlugin(config), ]; }) .s("AmazonS3", "GetBucketAcl", {}) .n("S3Client", "GetBucketAclCommand") .sc(GetBucketAcl$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:103
new GetBucketAclCommand(
...__namedParameters: [GetBucketAclCommandInput],
): GetBucketAclCommand
Parameters
- ...__namedParameters: [GetBucketAclCommandInput]
Returns GetBucketAclCommand
Inherited from $Command .classBuilder< GetBucketAclCommandInput, GetBucketAclCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [ getEndpointPlugin(config, Command.getEndpointParameterInstructions()), getThrow200ExceptionsPlugin(config), ]; }) .s("AmazonS3", "GetBucketAcl", {}) .n("S3Client", "GetBucketAclCommand") .sc(GetBucketAcl$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:104

Class GetBucketAclCommand

Example

Param: GetBucketAclCommandInput

Returns

See

Throws

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns GetBucketAclCommand

Parameters

Returns GetBucketAclCommand

Settings

On This Page