Class GetBucketLoggingCommand

This operation is not supported for directory buckets.

Returns the logging status of a bucket and the permissions users have to view and modify that status.

The following operations are related to GetBucketLogging:

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.

Example

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

import { S3Client, GetBucketLoggingCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetBucketLoggingCommand } = 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 = { // GetBucketLoggingRequest
  Bucket: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetBucketLoggingCommand(input);
const response = await client.send(command);
// { // GetBucketLoggingOutput
//   LoggingEnabled: { // LoggingEnabled
//     TargetBucket: "STRING_VALUE", // required
//     TargetGrants: [ // TargetGrants
//       { // TargetGrant
//         Grantee: { // Grantee
//           DisplayName: "STRING_VALUE",
//           EmailAddress: "STRING_VALUE",
//           ID: "STRING_VALUE",
//           URI: "STRING_VALUE",
//           Type: "CanonicalUser" || "AmazonCustomerByEmail" || "Group", // required
//         },
//         Permission: "FULL_CONTROL" || "READ" || "WRITE",
//       },
//     ],
//     TargetPrefix: "STRING_VALUE", // required
//     TargetObjectKeyFormat: { // TargetObjectKeyFormat
//       SimplePrefix: {},
//       PartitionedPrefix: { // PartitionedPrefix
//         PartitionDateSource: "EventTime" || "DeliveryTime",
//       },
//     },
//   },
// };

Param: GetBucketLoggingCommandInput

GetBucketLoggingCommandInput

Returns

GetBucketLoggingCommandOutput

See

GetBucketLoggingCommandInput for command's input shape.
GetBucketLoggingCommandOutput 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<
    GetBucketLoggingCommandInput,
    GetBucketLoggingCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- GetBucketLoggingCommand

Index

Constructors

constructor

Constructors

constructor

new GetBucketLoggingCommand(
input: GetBucketLoggingCommandInput,
): GetBucketLoggingCommand
Parameters
- input: GetBucketLoggingCommandInput
Returns GetBucketLoggingCommand
Inherited from $Command .classBuilder< GetBucketLoggingCommandInput, GetBucketLoggingCommandOutput, 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", "GetBucketLogging", {}) .n("S3Client", "GetBucketLoggingCommand") .sc(GetBucketLogging$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:103
new GetBucketLoggingCommand(
...__namedParameters: [GetBucketLoggingCommandInput],
): GetBucketLoggingCommand
Parameters
- ...__namedParameters: [GetBucketLoggingCommandInput]
Returns GetBucketLoggingCommand
Inherited from $Command .classBuilder< GetBucketLoggingCommandInput, GetBucketLoggingCommandOutput, 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", "GetBucketLogging", {}) .n("S3Client", "GetBucketLoggingCommand") .sc(GetBucketLogging$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:104

Class GetBucketLoggingCommand

Example

Param: GetBucketLoggingCommandInput

Returns

See

Throws

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns GetBucketLoggingCommand

Parameters

Returns GetBucketLoggingCommand

Settings

On This Page