Class: Aws::S3::Types::MetricsFilter

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 MetricsFilter data as a hash:

{
  prefix: "Prefix",
  tag: {
    key: "ObjectKey", # required
    value: "Value", # required
  },
  access_point_arn: "AccessPointArn",
  and: {
    prefix: "Prefix",
    tags: [
      {
        key: "ObjectKey", # required
        value: "Value", # required
      },
    ],
    access_point_arn: "AccessPointArn",
  },
}

Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_point_arnString

The access point ARN used when evaluating a metrics filter.

Returns:

  • (String)


9186
9187
9188
9189
9190
9191
9192
9193
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9186

class MetricsFilter < Struct.new(
  :prefix,
  :tag,
  :access_point_arn,
  :and)
  SENSITIVE = []
  include Aws::Structure
end

#andTypes::MetricsAndOperator

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.



9186
9187
9188
9189
9190
9191
9192
9193
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9186

class MetricsFilter < Struct.new(
  :prefix,
  :tag,
  :access_point_arn,
  :and)
  SENSITIVE = []
  include Aws::Structure
end

#prefixString

The prefix used when evaluating a metrics filter.

Returns:

  • (String)


9186
9187
9188
9189
9190
9191
9192
9193
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9186

class MetricsFilter < Struct.new(
  :prefix,
  :tag,
  :access_point_arn,
  :and)
  SENSITIVE = []
  include Aws::Structure
end

#tagTypes::Tag

The tag used when evaluating a metrics filter.

Returns:



9186
9187
9188
9189
9190
9191
9192
9193
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9186

class MetricsFilter < Struct.new(
  :prefix,
  :tag,
  :access_point_arn,
  :and)
  SENSITIVE = []
  include Aws::Structure
end