S3 / Client / put_bucket_analytics_configuration

put_bucket_analytics_configuration#

S3.Client.put_bucket_analytics_configuration(**kwargs)#

Note

This operation is not supported for directory buckets.

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.

Warning

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.

PutBucketAnalyticsConfiguration has the following 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.

The following operations are related to PutBucketAnalyticsConfiguration:

See also: AWS API Documentation

Request Syntax

response = client.put_bucket_analytics_configuration(
    Bucket='string',
    Id='string',
    AnalyticsConfiguration={
        'Id': 'string',
        'Filter': {
            'Prefix': 'string',
            'Tag': {
                'Key': 'string',
                'Value': 'string'
            },
            'And': {
                'Prefix': 'string',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            }
        },
        'StorageClassAnalysis': {
            'DataExport': {
                'OutputSchemaVersion': 'V_1',
                'Destination': {
                    'S3BucketDestination': {
                        'Format': 'CSV',
                        'BucketAccountId': 'string',
                        'Bucket': 'string',
                        'Prefix': 'string'
                    }
                }
            }
        }
    },
    ExpectedBucketOwner='string'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

    The name of the bucket to which an analytics configuration is stored.

  • Id (string) –

    [REQUIRED]

    The ID that identifies the analytics configuration.

  • AnalyticsConfiguration (dict) –

    [REQUIRED]

    The configuration and any analyses for the analytics filter.

    • Id (string) – [REQUIRED]

      The ID that identifies the analytics configuration.

    • Filter (dict) –

      The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

      • Prefix (string) –

        The prefix to use when evaluating an analytics filter.

      • Tag (dict) –

        The tag to use when evaluating an analytics filter.

        • Key (string) – [REQUIRED]

          Name of the object key.

        • Value (string) – [REQUIRED]

          Value of the tag.

      • And (dict) –

        A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

        • Prefix (string) –

          The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.

        • Tags (list) –

          The list of tags to use when evaluating an AND predicate.

          • (dict) –

            A container of a key value name pair.

            • Key (string) – [REQUIRED]

              Name of the object key.

            • Value (string) – [REQUIRED]

              Value of the tag.

    • StorageClassAnalysis (dict) – [REQUIRED]

      Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

      • DataExport (dict) –

        Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.

        • OutputSchemaVersion (string) – [REQUIRED]

          The version of the output schema to use when exporting data. Must be V_1.

        • Destination (dict) – [REQUIRED]

          The place to store the data for an analysis.

          • S3BucketDestination (dict) – [REQUIRED]

            A destination signifying output to an S3 bucket.

            • Format (string) – [REQUIRED]

              Specifies the file format used when exporting data to Amazon S3.

            • BucketAccountId (string) –

              The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

              Note

              Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

            • Bucket (string) – [REQUIRED]

              The Amazon Resource Name (ARN) of the bucket to which data is exported.

            • Prefix (string) –

              The prefix to use when exporting data. The prefix is prepended to all results.

  • ExpectedBucketOwner (string) – 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).

Returns:

None