import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { PutBucketLoggingRequest } from "../models/models_1"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link PutBucketLoggingCommand}. */ export interface PutBucketLoggingCommandInput extends PutBucketLoggingRequest { } /** * @public * * The output of {@link PutBucketLoggingCommand}. */ export interface PutBucketLoggingCommandOutput extends __MetadataBearer { } declare const PutBucketLoggingCommand_base: { new (input: PutBucketLoggingCommandInput): import("@smithy/smithy-client").CommandImpl; new (__0_0: PutBucketLoggingCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * *

This operation is not supported for directory buckets.

* *

Set the logging parameters for a bucket and to specify permissions for who can view and * modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as * the source bucket. To set the logging status of a bucket, you must be the bucket * owner.

*

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the * Grantee request element to grant access to other people. The * Permissions request element specifies the kind of access the grantee has to * the logs.

* *

If the target bucket for log delivery uses the bucket owner enforced setting for S3 * Object Ownership, you can't use the Grantee request element to grant access * to others. Permissions can only be granted using policies. For more information, see * Permissions for server access log delivery in the * Amazon S3 User Guide.

* *
*
Grantee Values
*
*

You can specify the person (grantee) to whom you're assigning access rights (by * using request elements) in the following ways:

*
    *
  • *

    By the person's ID:

    *

    * <>ID<><>GranteesEmail<> * *

    *

    * DisplayName is optional and ignored in the request.

    *
    • *
  • *

    By Email address:

    *

    * <>Grantees@email.com<> *

    *

    The grantee is resolved to the CanonicalUser and, in a * response to a GETObjectAcl request, appears as the * CanonicalUser.

    *
    • *
  • *

    By URI:

    *

    * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> *

    *
    • *
*
*
*

To enable logging, you use LoggingEnabled and its children request * elements. To disable logging, you use an empty BucketLoggingStatus request * element:

*

* *

*

For more information about server access logging, see Server Access Logging in the * Amazon S3 User Guide.

*

For more information about creating a bucket, see CreateBucket. For more * information about returning the logging status of a bucket, see GetBucketLogging.

*

The following operations are related to PutBucketLogging:

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, PutBucketLoggingCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, PutBucketLoggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const input = { // PutBucketLoggingRequest * Bucket: "STRING_VALUE", // required * BucketLoggingStatus: { // BucketLoggingStatus * 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", * }, * }, * }, * }, * ContentMD5: "STRING_VALUE", * ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME", * ExpectedBucketOwner: "STRING_VALUE", * }; * const command = new PutBucketLoggingCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param PutBucketLoggingCommandInput - {@link PutBucketLoggingCommandInput} * @returns {@link PutBucketLoggingCommandOutput} * @see {@link PutBucketLoggingCommandInput} for command's `input` shape. * @see {@link PutBucketLoggingCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * * @throws {@link S3ServiceException} *

Base exception class for all service exceptions from S3 service.

* * * @example Set logging configuration for a bucket * ```javascript * // The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants. * const input = { * Bucket: "sourcebucket", * BucketLoggingStatus: { * LoggingEnabled: { * TargetBucket: "targetbucket", * TargetGrants: [ * { * Grantee: { * Type: "Group", * URI: "http://acs.amazonaws.com/groups/global/AllUsers" * }, * Permission: "READ" * } * ], * TargetPrefix: "MyBucketLogs/" * } * } * }; * const command = new PutBucketLoggingCommand(input); * const response = await client.send(command); * /* response is * { /* metadata only *\/ } * *\/ * ``` * * @public */ export declare class PutBucketLoggingCommand extends PutBucketLoggingCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: PutBucketLoggingRequest; output: {}; }; sdk: { input: PutBucketLoggingCommandInput; output: PutBucketLoggingCommandOutput; }; }; }