Class: Aws::SecurityHub::Types::ClassificationResult

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

Overview

Note:

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

{
  mime_type: "NonEmptyString",
  size_classified: 1,
  additional_occurrences: false,
  status: {
    code: "NonEmptyString",
    reason: "NonEmptyString",
  },
  sensitive_data: [
    {
      category: "NonEmptyString",
      detections: [
        {
          count: 1,
          type: "NonEmptyString",
          occurrences: {
            line_ranges: [
              {
                start: 1,
                end: 1,
                start_column: 1,
              },
            ],
            offset_ranges: [
              {
                start: 1,
                end: 1,
                start_column: 1,
              },
            ],
            pages: [
              {
                page_number: 1,
                line_range: {
                  start: 1,
                  end: 1,
                  start_column: 1,
                },
                offset_range: {
                  start: 1,
                  end: 1,
                  start_column: 1,
                },
              },
            ],
            records: [
              {
                json_path: "NonEmptyString",
                record_index: 1,
              },
            ],
            cells: [
              {
                column: 1,
                row: 1,
                column_name: "NonEmptyString",
                cell_reference: "NonEmptyString",
              },
            ],
          },
        },
      ],
      total_count: 1,
    },
  ],
  custom_data_identifiers: {
    detections: [
      {
        count: 1,
        arn: "NonEmptyString",
        name: "NonEmptyString",
        occurrences: {
          line_ranges: [
            {
              start: 1,
              end: 1,
              start_column: 1,
            },
          ],
          offset_ranges: [
            {
              start: 1,
              end: 1,
              start_column: 1,
            },
          ],
          pages: [
            {
              page_number: 1,
              line_range: {
                start: 1,
                end: 1,
                start_column: 1,
              },
              offset_range: {
                start: 1,
                end: 1,
                start_column: 1,
              },
            },
          ],
          records: [
            {
              json_path: "NonEmptyString",
              record_index: 1,
            },
          ],
          cells: [
            {
              column: 1,
              row: 1,
              column_name: "NonEmptyString",
              cell_reference: "NonEmptyString",
            },
          ],
        },
      },
    ],
    total_count: 1,
  },
}

Details about the sensitive data that was detected on the resource.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_occurrences ⇒ Boolean

Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.

Returns:

  • (Boolean) 


29363
29364
29365
29366
29367
29368
29369
29370
29371
29372
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29363

class ClassificationResult < Struct.new(
  :mime_type,
  :size_classified,
  :additional_occurrences,
  :status,
  :sensitive_data,
  :custom_data_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#custom_data_identifiers ⇒ Types::CustomDataIdentifiersResult

Provides details about sensitive data that was identified based on customer-defined configuration.

Returns:



29363
29364
29365
29366
29367
29368
29369
29370
29371
29372
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29363

class ClassificationResult < Struct.new(
  :mime_type,
  :size_classified,
  :additional_occurrences,
  :status,
  :sensitive_data,
  :custom_data_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#mime_type ⇒ String

The type of content that the finding applies to.

Returns:

  • (String) 


29363
29364
29365
29366
29367
29368
29369
29370
29371
29372
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29363

class ClassificationResult < Struct.new(
  :mime_type,
  :size_classified,
  :additional_occurrences,
  :status,
  :sensitive_data,
  :custom_data_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#sensitive_data ⇒ Array<Types::SensitiveDataResult>

Provides details about sensitive data that was identified based on built-in configuration.

Returns:



29363
29364
29365
29366
29367
29368
29369
29370
29371
29372
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29363

class ClassificationResult < Struct.new(
  :mime_type,
  :size_classified,
  :additional_occurrences,
  :status,
  :sensitive_data,
  :custom_data_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#size_classified ⇒ Integer

The total size in bytes of the affected data.

Returns:

  • (Integer) 


29363
29364
29365
29366
29367
29368
29369
29370
29371
29372
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29363

class ClassificationResult < Struct.new(
  :mime_type,
  :size_classified,
  :additional_occurrences,
  :status,
  :sensitive_data,
  :custom_data_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ Types::ClassificationStatus

The current status of the sensitive data detection.

Returns:



29363
29364
29365
29366
29367
29368
29369
29370
29371
29372
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29363

class ClassificationResult < Struct.new(
  :mime_type,
  :size_classified,
  :additional_occurrences,
  :status,
  :sensitive_data,
  :custom_data_identifiers)
  SENSITIVE = []
  include Aws::Structure
end