import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
import { PutBucketAnalyticsConfigurationRequest } from "../models/models_0";
import {
deserializeAws_restXmlPutBucketAnalyticsConfigurationCommand,
serializeAws_restXmlPutBucketAnalyticsConfigurationCommand,
} from "../protocols/Aws_restXml";
import { getBucketEndpointPlugin } from "@aws-sdk/middleware-bucket-endpoint";
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
import { Command as $Command } from "@aws-sdk/smithy-client";
import {
FinalizeHandlerArguments,
Handler,
HandlerExecutionContext,
MiddlewareStack,
HttpHandlerOptions as __HttpHandlerOptions,
MetadataBearer as __MetadataBearer,
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";
export type PutBucketAnalyticsConfigurationCommandInput = PutBucketAnalyticsConfigurationRequest;
export type PutBucketAnalyticsConfigurationCommandOutput = __MetadataBearer;
/**
* Sets an analytics configuration for the bucket (specified by the analytics configuration
* ID). You can have up to 1,000 analytics configurations per bucket.
*
* You can choose to have storage class analysis export analysis reports sent to a
* comma-separated values (CSV) flat file. See the DataExport request element.
* Reports are updated daily and are based on the object filters that you configure. When
* selecting data export, you specify a destination bucket and an optional destination prefix
* where the file is written. You can export the data to a destination bucket in a different
* account. However, the destination bucket must be in the same Region as the bucket that you
* are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class
* Analysis.
*
*
* You must create a bucket policy on the destination bucket where the exported file is
* written to grant permissions to Amazon S3 to write objects to the bucket. For an example
* policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
*
*
* To use this operation, you must have permissions to perform the
* s3:PutAnalyticsConfiguration action. The bucket owner has this permission
* by default. The bucket owner can grant this permission to others. For more information
* about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3
* Resources.
*
*
*
* Special Errors
*
*
* -
*
* -
*
* HTTP Error: HTTP 400 Bad Request
*
*
* -
*
* Code: InvalidArgument
*
*
* -
*
* Cause: Invalid argument.
*
*
*
*
* -
*
* -
*
* HTTP Error: HTTP 400 Bad Request
*
*
* -
*
* Code: TooManyConfigurations
*
*
* -
*
* Cause: You are attempting to create a new configuration but have
* already reached the 1,000-configuration limit.
*
*
*
*
* -
*
* -
*
* HTTP Error: HTTP 403 Forbidden
*
*
* -
*
* Code: AccessDenied
*
*
* -
*
* Cause: You are not the owner of the specified bucket, or you do
* not have the s3:PutAnalyticsConfiguration bucket permission to set the
* configuration on the bucket.
*
*
*
*
*
*
*
*
*
*
*
*
* Related Resources
*
*
*/
export class PutBucketAnalyticsConfigurationCommand extends $Command<
PutBucketAnalyticsConfigurationCommandInput,
PutBucketAnalyticsConfigurationCommandOutput,
S3ClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
constructor(readonly input: PutBucketAnalyticsConfigurationCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: S3ClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(getBucketEndpointPlugin(configuration));
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "S3Client";
const commandName = "PutBucketAnalyticsConfigurationCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: PutBucketAnalyticsConfigurationRequest.filterSensitiveLog,
outputFilterSensitiveLog: (output: any) => output,
};
const { requestHandler } = configuration;
return stack.resolve(
(request: FinalizeHandlerArguments) =>
requestHandler.handle(request.request as __HttpRequest, options || {}),
handlerExecutionContext
);
}
private serialize(
input: PutBucketAnalyticsConfigurationCommandInput,
context: __SerdeContext
): Promise<__HttpRequest> {
return serializeAws_restXmlPutBucketAnalyticsConfigurationCommand(input, context);
}
private deserialize(
output: __HttpResponse,
context: __SerdeContext
): Promise {
return deserializeAws_restXmlPutBucketAnalyticsConfigurationCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}