S3 / Client / list_bucket_analytics_configurations

list_bucket_analytics_configurations#

S3.Client.list_bucket_analytics_configurations(**kwargs)#

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration 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.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to ListBucketAnalyticsConfigurations:

Request Syntax

response = client.list_bucket_analytics_configurations(
    Bucket='string',
    ContinuationToken='string',
    ExpectedBucketOwner='string'
)

Parameters:

Bucket (string) –
[REQUIRED]

The name of the bucket from which analytics configurations are retrieved.
ContinuationToken (string) – The ContinuationToken that represents a placeholder from where this request should begin.
ExpectedBucketOwner (string) – The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Return type:

dict

Returns:

Response Syntax

{
    'IsTruncated': True|False,
    'ContinuationToken': 'string',
    'NextContinuationToken': 'string',
    'AnalyticsConfigurationList': [
        {
            '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'
                        }
                    }
                }
            }
        },
    ]
}

Response Structure

(dict) –
- IsTruncated (boolean) –
  
  Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
- ContinuationToken (string) –
  
  The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.
- NextContinuationToken (string) –
  
  NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.
- AnalyticsConfigurationList (list) –
  
  The list of analytics configurations for a bucket.
  - (dict) –
    
    Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
    - Id (string) –
      
      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) –
        
        Name of the object key.
        
        Value (string) –
        
        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) –
        
        Name of the object key.
        
        Value (string) –
        
        Value of the tag.
    - StorageClassAnalysis (dict) –
      
      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) –
        
        The version of the output schema to use when exporting data. Must be V_1.
        
        Destination (dict) –
        
        The place to store the data for an analysis.
        
        S3BucketDestination (dict) –
        
        A destination signifying output to an S3 bucket.
        
        Format (string) –
        
        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) –
        
        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.