You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::Types::AnalyticsConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass AnalyticsConfiguration data as a hash:

{
  id: "AnalyticsId", # required
  filter: {
    prefix: "Prefix",
    tag: {
      key: "ObjectKey", # required
      value: "Value", # required
    },
    and: {
      prefix: "Prefix",
      tags: [
        {
          key: "ObjectKey", # required
          value: "Value", # required
        },
      ],
    },
  },
  storage_class_analysis: { # required
    data_export: {
      output_schema_version: "V_1", # required, accepts V_1
      destination: { # required
        s3_bucket_destination: { # required
          format: "CSV", # required, accepts CSV
          bucket_account_id: "AccountId",
          bucket: "BucketName", # required
          prefix: "Prefix",
        },
      },
    },
  },
}

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

For more information, see GET Bucket analytics in the Amazon Simple Storage Service API Reference.

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::AnalyticsFilter

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.



285
286
287
288
289
290
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 285

class AnalyticsConfiguration < Struct.new(
  :id,
  :filter,
  :storage_class_analysis)
  include Aws::Structure
end

#idString

The ID that identifies the analytics configuration.

Returns:

  • (String)


285
286
287
288
289
290
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 285

class AnalyticsConfiguration < Struct.new(
  :id,
  :filter,
  :storage_class_analysis)
  include Aws::Structure
end

#storage_class_analysisTypes::StorageClassAnalysis

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



285
286
287
288
289
290
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 285

class AnalyticsConfiguration < Struct.new(
  :id,
  :filter,
  :storage_class_analysis)
  include Aws::Structure
end