Class: Aws::Macie2::Types::S3JobDefinition

Inherits:

Struct

• Object
• Struct
• Aws::Macie2::Types::S3JobDefinition

Defined in:

gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb

Overview

Note:

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

{
  bucket_definitions: [
    {
      account_id: "__string", # required
      buckets: ["__string"], # required
    },
  ],
  scoping: {
    excludes: {
      and: [
        {
          simple_scope_term: {
            comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
            key: "OBJECT_EXTENSION", # accepts OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, OBJECT_KEY
            values: ["__string"],
          },
          tag_scope_term: {
            comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
            key: "__string",
            tag_values: [
              {
                key: "__string",
                value: "__string",
              },
            ],
            target: "S3_OBJECT", # accepts S3_OBJECT
          },
        },
      ],
    },
    includes: {
      and: [
        {
          simple_scope_term: {
            comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
            key: "OBJECT_EXTENSION", # accepts OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, OBJECT_KEY
            values: ["__string"],
          },
          tag_scope_term: {
            comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
            key: "__string",
            tag_values: [
              {
                key: "__string",
                value: "__string",
              },
            ],
            target: "S3_OBJECT", # accepts S3_OBJECT
          },
        },
      ],
    },
  },
  bucket_criteria: {
    excludes: {
      and: [
        {
          simple_criterion: {
            comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
            key: "ACCOUNT_ID", # accepts ACCOUNT_ID, S3_BUCKET_NAME, S3_BUCKET_EFFECTIVE_PERMISSION, S3_BUCKET_SHARED_ACCESS
            values: ["__string"],
          },
          tag_criterion: {
            comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
            tag_values: [
              {
                key: "__string",
                value: "__string",
              },
            ],
          },
        },
      ],
    },
    includes: {
      and: [
        {
          simple_criterion: {
            comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
            key: "ACCOUNT_ID", # accepts ACCOUNT_ID, S3_BUCKET_NAME, S3_BUCKET_EFFECTIVE_PERMISSION, S3_BUCKET_SHARED_ACCESS
            values: ["__string"],
          },
          tag_criterion: {
            comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
            tag_values: [
              {
                key: "__string",
                value: "__string",
              },
            ],
          },
        },
      ],
    },
  },
}

Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis. The bucket specification can be static (bucketDefinitions) or dynamic (bucketCriteria). If it's static, the job analyzes objects in the same predefined set of buckets each time the job runs. If it's dynamic, the job analyzes objects in any buckets that match the specified criteria each time the job starts to run.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket_criteria ⇒ Types::S3BucketCriteriaForJob

  Specifies property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job.

• #bucket_definitions ⇒ Array<Types::S3BucketDefinitionForJob>
• #scoping ⇒ Types::Scoping

  Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job.

Instance Attribute Details

#bucket_criteria ⇒ Types::S3BucketCriteriaForJob

Specifies property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job. Exclude conditions take precedence over include conditions.

Returns:

• (Types::S3BucketCriteriaForJob)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 5115

class S3JobDefinition < Struct.new(
  :bucket_definitions,
  :scoping,
  :bucket_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#bucket_definitions ⇒ Array<Types::S3BucketDefinitionForJob>

Returns:

• (Array<Types::S3BucketDefinitionForJob>)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 5115

class S3JobDefinition < Struct.new(
  :bucket_definitions,
  :scoping,
  :bucket_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#scoping ⇒ Types::Scoping

Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job. Exclude conditions take precedence over include conditions.

Returns:

• (Types::Scoping)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 5115

class S3JobDefinition < Struct.new(
  :bucket_definitions,
  :scoping,
  :bucket_criteria)
  SENSITIVE = []
  include Aws::Structure
end