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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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].

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_point_arn ⇒ String

The access point ARN used when evaluating a metrics filter.

Returns:

  • (String) 


10117
10118
10119
10120
10121
10122
10123
10124
 
# File 'lib/aws-sdk-s3/types.rb', line 10117

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

#and ⇒ Types::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.

Returns:



10117
10118
10119
10120
10121
10122
10123
10124
 
# File 'lib/aws-sdk-s3/types.rb', line 10117

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

#prefix ⇒ String

The prefix used when evaluating a metrics filter.

Returns:

  • (String) 


10117
10118
10119
10120
10121
10122
10123
10124
 
# File 'lib/aws-sdk-s3/types.rb', line 10117

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

#tag ⇒ Types::Tag

The tag used when evaluating a metrics filter.

Returns:



10117
10118
10119
10120
10121
10122
10123
10124
 
# File 'lib/aws-sdk-s3/types.rb', line 10117

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