Class: Aws::SecurityHub::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb

Overview

An API client for SecurityHub. To construct a client, you need to configure a :region and :credentials.

client = Aws::SecurityHub::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



344
345
346
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 344

def initialize(*args)
  super
end

Instance Method Details

#accept_administrator_invitation(params = {}) ⇒ Struct

Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.

This operation is only used by member accounts that are not added through Organizations.

When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.

Examples:

Request syntax with placeholder values


resp = client.accept_administrator_invitation({
  administrator_id: "NonEmptyString", # required
  invitation_id: "NonEmptyString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :administrator_id (required, String) —

    The account ID of the Security Hub administrator account that sent the invitation.

  • :invitation_id (required, String) —

    The identifier of the invitation sent from the Security Hub administrator account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



381
382
383
384
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 381

def accept_administrator_invitation(params = {}, options = {})
  req = build_request(:accept_administrator_invitation, params)
  req.send_request(options)
end

#accept_invitation(params = {}) ⇒ Struct

This method is deprecated. Instead, use AcceptAdministratorInvitation.

The Security Hub console continues to use AcceptInvitation. It will eventually change to use AcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to use AcceptInvitation. You should also add AcceptAdministratorInvitation to your policies to ensure that the correct permissions are in place after the console begins to use AcceptAdministratorInvitation.

Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.

This operation is only used by member accounts that are not added through Organizations.

When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.

Examples:

Request syntax with placeholder values


resp = client.accept_invitation({
  master_id: "NonEmptyString", # required
  invitation_id: "NonEmptyString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :master_id (required, String) —

    The account ID of the Security Hub administrator account that sent the invitation.

  • :invitation_id (required, String) —

    The identifier of the invitation sent from the Security Hub administrator account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



428
429
430
431
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 428

def accept_invitation(params = {}, options = {})
  req = build_request(:accept_invitation, params)
  req.send_request(options)
end

#batch_disable_standards(params = {}) ⇒ Types::BatchDisableStandardsResponse

Disables the standards specified by the provided StandardsSubscriptionArns.

For more information, see Security Standards section of the Security Hub User Guide.

Examples:

Request syntax with placeholder values


resp = client.batch_disable_standards({
  standards_subscription_arns: ["NonEmptyString"], # required
})

Response structure


resp.standards_subscriptions #=> Array
resp.standards_subscriptions[0].standards_subscription_arn #=> String
resp.standards_subscriptions[0].standards_arn #=> String
resp.standards_subscriptions[0].standards_input #=> Hash
resp.standards_subscriptions[0].standards_input["NonEmptyString"] #=> String
resp.standards_subscriptions[0].standards_status #=> String, one of "PENDING", "READY", "FAILED", "DELETING", "INCOMPLETE"
resp.standards_subscriptions[0].standards_status_reason.status_reason_code #=> String, one of "NO_AVAILABLE_CONFIGURATION_RECORDER", "INTERNAL_ERROR"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :standards_subscription_arns (required, Array<String>) —

    The ARNs of the standards subscriptions to disable.

Returns:

See Also:



470
471
472
473
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 470

def batch_disable_standards(params = {}, options = {})
  req = build_request(:batch_disable_standards, params)
  req.send_request(options)
end

#batch_enable_standards(params = {}) ⇒ Types::BatchEnableStandardsResponse

Enables the standards specified by the provided StandardsArn. To obtain the ARN for a standard, use the DescribeStandards operation.

For more information, see the Security Standards section of the Security Hub User Guide.

Examples:

Request syntax with placeholder values


resp = client.batch_enable_standards({
  standards_subscription_requests: [ # required
    {
      standards_arn: "NonEmptyString", # required
      standards_input: {
        "NonEmptyString" => "NonEmptyString",
      },
    },
  ],
})

Response structure


resp.standards_subscriptions #=> Array
resp.standards_subscriptions[0].standards_subscription_arn #=> String
resp.standards_subscriptions[0].standards_arn #=> String
resp.standards_subscriptions[0].standards_input #=> Hash
resp.standards_subscriptions[0].standards_input["NonEmptyString"] #=> String
resp.standards_subscriptions[0].standards_status #=> String, one of "PENDING", "READY", "FAILED", "DELETING", "INCOMPLETE"
resp.standards_subscriptions[0].standards_status_reason.status_reason_code #=> String, one of "NO_AVAILABLE_CONFIGURATION_RECORDER", "INTERNAL_ERROR"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



519
520
521
522
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 519

def batch_enable_standards(params = {}, options = {})
  req = build_request(:batch_enable_standards, params)
  req.send_request(options)
end

#batch_import_findings(params = {}) ⇒ Types::BatchImportFindingsResponse

Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub.

BatchImportFindings must be called by one of the following:

  • The account that is associated with the findings. The identifier of the associated account is the value of the AwsAccountId attribute for the finding.

  • An account that is allow-listed for an official Security Hub partner integration.

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.

After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.

  • Note

  • UserDefinedFields

  • VerificationState

  • Workflow

Finding providers also should not use BatchImportFindings to update the following attributes.

  • Confidence

  • Criticality

  • RelatedFindings

  • Severity

  • Types

Instead, finding providers use FindingProviderFields to provide values for these attributes.

Examples:

Request syntax with placeholder values


resp = client.batch_import_findings({
  findings: [ # required
    {
      schema_version: "NonEmptyString", # required
      id: "NonEmptyString", # required
      product_arn: "NonEmptyString", # required
      product_name: "NonEmptyString",
      company_name: "NonEmptyString",
      region: "NonEmptyString",
      generator_id: "NonEmptyString", # required
      aws_account_id: "NonEmptyString", # required
      types: ["NonEmptyString"],
      first_observed_at: "NonEmptyString",
      last_observed_at: "NonEmptyString",
      created_at: "NonEmptyString", # required
      updated_at: "NonEmptyString", # required
      severity: {
        product: 1.0,
        label: "INFORMATIONAL", # accepts INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL
        normalized: 1,
        original: "NonEmptyString",
      },
      confidence: 1,
      criticality: 1,
      title: "NonEmptyString", # required
      description: "NonEmptyString", # required
      remediation: {
        recommendation: {
          text: "NonEmptyString",
          url: "NonEmptyString",
        },
      },
      source_url: "NonEmptyString",
      product_fields: {
        "NonEmptyString" => "NonEmptyString",
      },
      user_defined_fields: {
        "NonEmptyString" => "NonEmptyString",
      },
      malware: [
        {
          name: "NonEmptyString", # required
          type: "ADWARE", # accepts ADWARE, BLENDED_THREAT, BOTNET_AGENT, COIN_MINER, EXPLOIT_KIT, KEYLOGGER, MACRO, POTENTIALLY_UNWANTED, SPYWARE, RANSOMWARE, REMOTE_ACCESS, ROOTKIT, TROJAN, VIRUS, WORM
          path: "NonEmptyString",
          state: "OBSERVED", # accepts OBSERVED, REMOVAL_FAILED, REMOVED
        },
      ],
      network: {
        direction: "IN", # accepts IN, OUT
        protocol: "NonEmptyString",
        open_port_range: {
          begin: 1,
          end: 1,
        },
        source_ip_v4: "NonEmptyString",
        source_ip_v6: "NonEmptyString",
        source_port: 1,
        source_domain: "NonEmptyString",
        source_mac: "NonEmptyString",
        destination_ip_v4: "NonEmptyString",
        destination_ip_v6: "NonEmptyString",
        destination_port: 1,
        destination_domain: "NonEmptyString",
      },
      network_path: [
        {
          component_id: "NonEmptyString",
          component_type: "NonEmptyString",
          egress: {
            protocol: "NonEmptyString",
            destination: {
              address: ["NonEmptyString"],
              port_ranges: [
                {
                  begin: 1,
                  end: 1,
                },
              ],
            },
            source: {
              address: ["NonEmptyString"],
              port_ranges: [
                {
                  begin: 1,
                  end: 1,
                },
              ],
            },
          },
          ingress: {
            protocol: "NonEmptyString",
            destination: {
              address: ["NonEmptyString"],
              port_ranges: [
                {
                  begin: 1,
                  end: 1,
                },
              ],
            },
            source: {
              address: ["NonEmptyString"],
              port_ranges: [
                {
                  begin: 1,
                  end: 1,
                },
              ],
            },
          },
        },
      ],
      process: {
        name: "NonEmptyString",
        path: "NonEmptyString",
        pid: 1,
        parent_pid: 1,
        launched_at: "NonEmptyString",
        terminated_at: "NonEmptyString",
      },
      threat_intel_indicators: [
        {
          type: "DOMAIN", # accepts DOMAIN, EMAIL_ADDRESS, HASH_MD5, HASH_SHA1, HASH_SHA256, HASH_SHA512, IPV4_ADDRESS, IPV6_ADDRESS, MUTEX, PROCESS, URL
          value: "NonEmptyString",
          category: "BACKDOOR", # accepts BACKDOOR, CARD_STEALER, COMMAND_AND_CONTROL, DROP_SITE, EXPLOIT_SITE, KEYLOGGER
          last_observed_at: "NonEmptyString",
          source: "NonEmptyString",
          source_url: "NonEmptyString",
        },
      ],
      resources: [ # required
        {
          type: "NonEmptyString", # required
          id: "NonEmptyString", # required
          partition: "aws", # accepts aws, aws-cn, aws-us-gov
          region: "NonEmptyString",
          resource_role: "NonEmptyString",
          tags: {
            "NonEmptyString" => "NonEmptyString",
          },
          data_classification: {
            detailed_results_location: "NonEmptyString",
            result: {
              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: {
            aws_auto_scaling_auto_scaling_group: {
              launch_configuration_name: "NonEmptyString",
              load_balancer_names: ["NonEmptyString"],
              health_check_type: "NonEmptyString",
              health_check_grace_period: 1,
              created_time: "NonEmptyString",
              mixed_instances_policy: {
                instances_distribution: {
                  on_demand_allocation_strategy: "NonEmptyString",
                  on_demand_base_capacity: 1,
                  on_demand_percentage_above_base_capacity: 1,
                  spot_allocation_strategy: "NonEmptyString",
                  spot_instance_pools: 1,
                  spot_max_price: "NonEmptyString",
                },
                launch_template: {
                  launch_template_specification: {
                    launch_template_id: "NonEmptyString",
                    launch_template_name: "NonEmptyString",
                    version: "NonEmptyString",
                  },
                  overrides: [
                    {
                      instance_type: "NonEmptyString",
                      weighted_capacity: "NonEmptyString",
                    },
                  ],
                },
              },
              availability_zones: [
                {
                  value: "NonEmptyString",
                },
              ],
            },
            aws_code_build_project: {
              encryption_key: "NonEmptyString",
              artifacts: [
                {
                  artifact_identifier: "NonEmptyString",
                  encryption_disabled: false,
                  location: "NonEmptyString",
                  name: "NonEmptyString",
                  namespace_type: "NonEmptyString",
                  override_artifact_name: false,
                  packaging: "NonEmptyString",
                  path: "NonEmptyString",
                  type: "NonEmptyString",
                },
              ],
              environment: {
                certificate: "NonEmptyString",
                environment_variables: [
                  {
                    name: "NonEmptyString",
                    type: "NonEmptyString",
                    value: "NonEmptyString",
                  },
                ],
                privileged_mode: false,
                image_pull_credentials_type: "NonEmptyString",
                registry_credential: {
                  credential: "NonEmptyString",
                  credential_provider: "NonEmptyString",
                },
                type: "NonEmptyString",
              },
              name: "NonEmptyString",
              source: {
                type: "NonEmptyString",
                location: "NonEmptyString",
                git_clone_depth: 1,
                insecure_ssl: false,
              },
              service_role: "NonEmptyString",
              logs_config: {
                cloud_watch_logs: {
                  group_name: "NonEmptyString",
                  status: "NonEmptyString",
                  stream_name: "NonEmptyString",
                },
                s3_logs: {
                  encryption_disabled: false,
                  location: "NonEmptyString",
                  status: "NonEmptyString",
                },
              },
              vpc_config: {
                vpc_id: "NonEmptyString",
                subnets: ["NonEmptyString"],
                security_group_ids: ["NonEmptyString"],
              },
            },
            aws_cloud_front_distribution: {
              cache_behaviors: {
                items: [
                  {
                    viewer_protocol_policy: "NonEmptyString",
                  },
                ],
              },
              default_cache_behavior: {
                viewer_protocol_policy: "NonEmptyString",
              },
              default_root_object: "NonEmptyString",
              domain_name: "NonEmptyString",
              etag: "NonEmptyString",
              last_modified_time: "NonEmptyString",
              logging: {
                bucket: "NonEmptyString",
                enabled: false,
                include_cookies: false,
                prefix: "NonEmptyString",
              },
              origins: {
                items: [
                  {
                    domain_name: "NonEmptyString",
                    id: "NonEmptyString",
                    origin_path: "NonEmptyString",
                    s3_origin_config: {
                      origin_access_identity: "NonEmptyString",
                    },
                  },
                ],
              },
              origin_groups: {
                items: [
                  {
                    failover_criteria: {
                      status_codes: {
                        items: [1],
                        quantity: 1,
                      },
                    },
                  },
                ],
              },
              viewer_certificate: {
                acm_certificate_arn: "NonEmptyString",
                certificate: "NonEmptyString",
                certificate_source: "NonEmptyString",
                cloud_front_default_certificate: false,
                iam_certificate_id: "NonEmptyString",
                minimum_protocol_version: "NonEmptyString",
                ssl_support_method: "NonEmptyString",
              },
              status: "NonEmptyString",
              web_acl_id: "NonEmptyString",
            },
            aws_ec2_instance: {
              type: "NonEmptyString",
              image_id: "NonEmptyString",
              ip_v4_addresses: ["NonEmptyString"],
              ip_v6_addresses: ["NonEmptyString"],
              key_name: "NonEmptyString",
              iam_instance_profile_arn: "NonEmptyString",
              vpc_id: "NonEmptyString",
              subnet_id: "NonEmptyString",
              launched_at: "NonEmptyString",
              network_interfaces: [
                {
                  network_interface_id: "NonEmptyString",
                },
              ],
            },
            aws_ec2_network_interface: {
              attachment: {
                attach_time: "NonEmptyString",
                attachment_id: "NonEmptyString",
                delete_on_termination: false,
                device_index: 1,
                instance_id: "NonEmptyString",
                instance_owner_id: "NonEmptyString",
                status: "NonEmptyString",
              },
              network_interface_id: "NonEmptyString",
              security_groups: [
                {
                  group_name: "NonEmptyString",
                  group_id: "NonEmptyString",
                },
              ],
              source_dest_check: false,
              ip_v6_addresses: [
                {
                  ip_v6_address: "NonEmptyString",
                },
              ],
              private_ip_addresses: [
                {
                  private_ip_address: "NonEmptyString",
                  private_dns_name: "NonEmptyString",
                },
              ],
              public_dns_name: "NonEmptyString",
              public_ip: "NonEmptyString",
            },
            aws_ec2_security_group: {
              group_name: "NonEmptyString",
              group_id: "NonEmptyString",
              owner_id: "NonEmptyString",
              vpc_id: "NonEmptyString",
              ip_permissions: [
                {
                  ip_protocol: "NonEmptyString",
                  from_port: 1,
                  to_port: 1,
                  user_id_group_pairs: [
                    {
                      group_id: "NonEmptyString",
                      group_name: "NonEmptyString",
                      peering_status: "NonEmptyString",
                      user_id: "NonEmptyString",
                      vpc_id: "NonEmptyString",
                      vpc_peering_connection_id: "NonEmptyString",
                    },
                  ],
                  ip_ranges: [
                    {
                      cidr_ip: "NonEmptyString",
                    },
                  ],
                  ipv_6_ranges: [
                    {
                      cidr_ipv_6: "NonEmptyString",
                    },
                  ],
                  prefix_list_ids: [
                    {
                      prefix_list_id: "NonEmptyString",
                    },
                  ],
                },
              ],
              ip_permissions_egress: [
                {
                  ip_protocol: "NonEmptyString",
                  from_port: 1,
                  to_port: 1,
                  user_id_group_pairs: [
                    {
                      group_id: "NonEmptyString",
                      group_name: "NonEmptyString",
                      peering_status: "NonEmptyString",
                      user_id: "NonEmptyString",
                      vpc_id: "NonEmptyString",
                      vpc_peering_connection_id: "NonEmptyString",
                    },
                  ],
                  ip_ranges: [
                    {
                      cidr_ip: "NonEmptyString",
                    },
                  ],
                  ipv_6_ranges: [
                    {
                      cidr_ipv_6: "NonEmptyString",
                    },
                  ],
                  prefix_list_ids: [
                    {
                      prefix_list_id: "NonEmptyString",
                    },
                  ],
                },
              ],
            },
            aws_ec2_volume: {
              create_time: "NonEmptyString",
              encrypted: false,
              size: 1,
              snapshot_id: "NonEmptyString",
              status: "NonEmptyString",
              kms_key_id: "NonEmptyString",
              attachments: [
                {
                  attach_time: "NonEmptyString",
                  delete_on_termination: false,
                  instance_id: "NonEmptyString",
                  status: "NonEmptyString",
                },
              ],
            },
            aws_ec2_vpc: {
              cidr_block_association_set: [
                {
                  association_id: "NonEmptyString",
                  cidr_block: "NonEmptyString",
                  cidr_block_state: "NonEmptyString",
                },
              ],
              ipv_6_cidr_block_association_set: [
                {
                  association_id: "NonEmptyString",
                  ipv_6_cidr_block: "NonEmptyString",
                  cidr_block_state: "NonEmptyString",
                },
              ],
              dhcp_options_id: "NonEmptyString",
              state: "NonEmptyString",
            },
            aws_ec2_eip: {
              instance_id: "NonEmptyString",
              public_ip: "NonEmptyString",
              allocation_id: "NonEmptyString",
              association_id: "NonEmptyString",
              domain: "NonEmptyString",
              public_ipv_4_pool: "NonEmptyString",
              network_border_group: "NonEmptyString",
              network_interface_id: "NonEmptyString",
              network_interface_owner_id: "NonEmptyString",
              private_ip_address: "NonEmptyString",
            },
            aws_ec2_subnet: {
              assign_ipv_6_address_on_creation: false,
              availability_zone: "NonEmptyString",
              availability_zone_id: "NonEmptyString",
              available_ip_address_count: 1,
              cidr_block: "NonEmptyString",
              default_for_az: false,
              map_public_ip_on_launch: false,
              owner_id: "NonEmptyString",
              state: "NonEmptyString",
              subnet_arn: "NonEmptyString",
              subnet_id: "NonEmptyString",
              vpc_id: "NonEmptyString",
              ipv_6_cidr_block_association_set: [
                {
                  association_id: "NonEmptyString",
                  ipv_6_cidr_block: "NonEmptyString",
                  cidr_block_state: "NonEmptyString",
                },
              ],
            },
            aws_ec2_network_acl: {
              is_default: false,
              network_acl_id: "NonEmptyString",
              owner_id: "NonEmptyString",
              vpc_id: "NonEmptyString",
              associations: [
                {
                  network_acl_association_id: "NonEmptyString",
                  network_acl_id: "NonEmptyString",
                  subnet_id: "NonEmptyString",
                },
              ],
              entries: [
                {
                  cidr_block: "NonEmptyString",
                  egress: false,
                  icmp_type_code: {
                    code: 1,
                    type: 1,
                  },
                  ipv_6_cidr_block: "NonEmptyString",
                  port_range: {
                    from: 1,
                    to: 1,
                  },
                  protocol: "NonEmptyString",
                  rule_action: "NonEmptyString",
                  rule_number: 1,
                },
              ],
            },
            aws_elbv_2_load_balancer: {
              availability_zones: [
                {
                  zone_name: "NonEmptyString",
                  subnet_id: "NonEmptyString",
                },
              ],
              canonical_hosted_zone_id: "NonEmptyString",
              created_time: "NonEmptyString",
              dns_name: "NonEmptyString",
              ip_address_type: "NonEmptyString",
              scheme: "NonEmptyString",
              security_groups: ["NonEmptyString"],
              state: {
                code: "NonEmptyString",
                reason: "NonEmptyString",
              },
              type: "NonEmptyString",
              vpc_id: "NonEmptyString",
              load_balancer_attributes: [
                {
                  key: "NonEmptyString",
                  value: "NonEmptyString",
                },
              ],
            },
            aws_elastic_beanstalk_environment: {
              application_name: "NonEmptyString",
              cname: "NonEmptyString",
              date_created: "NonEmptyString",
              date_updated: "NonEmptyString",
              description: "NonEmptyString",
              endpoint_url: "NonEmptyString",
              environment_arn: "NonEmptyString",
              environment_id: "NonEmptyString",
              environment_links: [
                {
                  environment_name: "NonEmptyString",
                  link_name: "NonEmptyString",
                },
              ],
              environment_name: "NonEmptyString",
              option_settings: [
                {
                  namespace: "NonEmptyString",
                  option_name: "NonEmptyString",
                  resource_name: "NonEmptyString",
                  value: "NonEmptyString",
                },
              ],
              platform_arn: "NonEmptyString",
              solution_stack_name: "NonEmptyString",
              status: "NonEmptyString",
              tier: {
                name: "NonEmptyString",
                type: "NonEmptyString",
                version: "NonEmptyString",
              },
              version_label: "NonEmptyString",
            },
            aws_elasticsearch_domain: {
              access_policies: "NonEmptyString",
              domain_endpoint_options: {
                enforce_https: false,
                tls_security_policy: "NonEmptyString",
              },
              domain_id: "NonEmptyString",
              domain_name: "NonEmptyString",
              endpoint: "NonEmptyString",
              endpoints: {
                "NonEmptyString" => "NonEmptyString",
              },
              elasticsearch_version: "NonEmptyString",
              elasticsearch_cluster_config: {
                dedicated_master_count: 1,
                dedicated_master_enabled: false,
                dedicated_master_type: "NonEmptyString",
                instance_count: 1,
                instance_type: "NonEmptyString",
                zone_awareness_config: {
                  availability_zone_count: 1,
                },
                zone_awareness_enabled: false,
              },
              encryption_at_rest_options: {
                enabled: false,
                kms_key_id: "NonEmptyString",
              },
              log_publishing_options: {
                index_slow_logs: {
                  cloud_watch_logs_log_group_arn: "NonEmptyString",
                  enabled: false,
                },
                search_slow_logs: {
                  cloud_watch_logs_log_group_arn: "NonEmptyString",
                  enabled: false,
                },
                audit_logs: {
                  cloud_watch_logs_log_group_arn: "NonEmptyString",
                  enabled: false,
                },
              },
              node_to_node_encryption_options: {
                enabled: false,
              },
              service_software_options: {
                automated_update_date: "NonEmptyString",
                cancellable: false,
                current_version: "NonEmptyString",
                description: "NonEmptyString",
                new_version: "NonEmptyString",
                update_available: false,
                update_status: "NonEmptyString",
              },
              vpc_options: {
                availability_zones: ["NonEmptyString"],
                security_group_ids: ["NonEmptyString"],
                subnet_ids: ["NonEmptyString"],
                vpc_id: "NonEmptyString",
              },
            },
            aws_s3_bucket: {
              owner_id: "NonEmptyString",
              owner_name: "NonEmptyString",
              owner_account_id: "NonEmptyString",
              created_at: "NonEmptyString",
              server_side_encryption_configuration: {
                rules: [
                  {
                    apply_server_side_encryption_by_default: {
                      sse_algorithm: "NonEmptyString",
                      kms_master_key_id: "NonEmptyString",
                    },
                  },
                ],
              },
              bucket_lifecycle_configuration: {
                rules: [
                  {
                    abort_incomplete_multipart_upload: {
                      days_after_initiation: 1,
                    },
                    expiration_date: "NonEmptyString",
                    expiration_in_days: 1,
                    expired_object_delete_marker: false,
                    filter: {
                      predicate: {
                        operands: [
                          {
                            prefix: "NonEmptyString",
                            tag: {
                              key: "NonEmptyString",
                              value: "NonEmptyString",
                            },
                            type: "NonEmptyString",
                          },
                        ],
                        prefix: "NonEmptyString",
                        tag: {
                          key: "NonEmptyString",
                          value: "NonEmptyString",
                        },
                        type: "NonEmptyString",
                      },
                    },
                    id: "NonEmptyString",
                    noncurrent_version_expiration_in_days: 1,
                    noncurrent_version_transitions: [
                      {
                        days: 1,
                        storage_class: "NonEmptyString",
                      },
                    ],
                    prefix: "NonEmptyString",
                    status: "NonEmptyString",
                    transitions: [
                      {
                        date: "NonEmptyString",
                        days: 1,
                        storage_class: "NonEmptyString",
                      },
                    ],
                  },
                ],
              },
              public_access_block_configuration: {
                block_public_acls: false,
                block_public_policy: false,
                ignore_public_acls: false,
                restrict_public_buckets: false,
              },
              access_control_list: "NonEmptyString",
              bucket_logging_configuration: {
                destination_bucket_name: "NonEmptyString",
                log_file_prefix: "NonEmptyString",
              },
              bucket_website_configuration: {
                error_document: "NonEmptyString",
                index_document_suffix: "NonEmptyString",
                redirect_all_requests_to: {
                  hostname: "NonEmptyString",
                  protocol: "NonEmptyString",
                },
                routing_rules: [
                  {
                    condition: {
                      http_error_code_returned_equals: "NonEmptyString",
                      key_prefix_equals: "NonEmptyString",
                    },
                    redirect: {
                      hostname: "NonEmptyString",
                      http_redirect_code: "NonEmptyString",
                      protocol: "NonEmptyString",
                      replace_key_prefix_with: "NonEmptyString",
                      replace_key_with: "NonEmptyString",
                    },
                  },
                ],
              },
              bucket_notification_configuration: {
                configurations: [
                  {
                    events: ["NonEmptyString"],
                    filter: {
                      s3_key_filter: {
                        filter_rules: [
                          {
                            name: "Prefix", # accepts Prefix, Suffix
                            value: "NonEmptyString",
                          },
                        ],
                      },
                    },
                    destination: "NonEmptyString",
                    type: "NonEmptyString",
                  },
                ],
              },
              bucket_versioning_configuration: {
                is_mfa_delete_enabled: false,
                status: "NonEmptyString",
              },
            },
            aws_s3_account_public_access_block: {
              block_public_acls: false,
              block_public_policy: false,
              ignore_public_acls: false,
              restrict_public_buckets: false,
            },
            aws_s3_object: {
              last_modified: "NonEmptyString",
              etag: "NonEmptyString",
              version_id: "NonEmptyString",
              content_type: "NonEmptyString",
              server_side_encryption: "NonEmptyString",
              ssekms_key_id: "NonEmptyString",
            },
            aws_secrets_manager_secret: {
              rotation_rules: {
                automatically_after_days: 1,
              },
              rotation_occurred_within_frequency: false,
              kms_key_id: "NonEmptyString",
              rotation_enabled: false,
              rotation_lambda_arn: "NonEmptyString",
              deleted: false,
              name: "NonEmptyString",
              description: "NonEmptyString",
            },
            aws_iam_access_key: {
              user_name: "NonEmptyString",
              status: "Active", # accepts Active, Inactive
              created_at: "NonEmptyString",
              principal_id: "NonEmptyString",
              principal_type: "NonEmptyString",
              principal_name: "NonEmptyString",
              account_id: "NonEmptyString",
              access_key_id: "NonEmptyString",
              session_context: {
                attributes: {
                  mfa_authenticated: false,
                  creation_date: "NonEmptyString",
                },
                session_issuer: {
                  type: "NonEmptyString",
                  principal_id: "NonEmptyString",
                  arn: "NonEmptyString",
                  account_id: "NonEmptyString",
                  user_name: "NonEmptyString",
                },
              },
            },
            aws_iam_user: {
              attached_managed_policies: [
                {
                  policy_name: "NonEmptyString",
                  policy_arn: "NonEmptyString",
                },
              ],
              create_date: "NonEmptyString",
              group_list: ["NonEmptyString"],
              path: "NonEmptyString",
              permissions_boundary: {
                permissions_boundary_arn: "NonEmptyString",
                permissions_boundary_type: "NonEmptyString",
              },
              user_id: "NonEmptyString",
              user_name: "NonEmptyString",
              user_policy_list: [
                {
                  policy_name: "NonEmptyString",
                },
              ],
            },
            aws_iam_policy: {
              attachment_count: 1,
              create_date: "NonEmptyString",
              default_version_id: "NonEmptyString",
              description: "NonEmptyString",
              is_attachable: false,
              path: "NonEmptyString",
              permissions_boundary_usage_count: 1,
              policy_id: "NonEmptyString",
              policy_name: "NonEmptyString",
              policy_version_list: [
                {
                  version_id: "NonEmptyString",
                  is_default_version: false,
                  create_date: "NonEmptyString",
                },
              ],
              update_date: "NonEmptyString",
            },
            aws_api_gateway_v2_stage: {
              client_certificate_id: "NonEmptyString",
              created_date: "NonEmptyString",
              description: "NonEmptyString",
              default_route_settings: {
                detailed_metrics_enabled: false,
                logging_level: "NonEmptyString",
                data_trace_enabled: false,
                throttling_burst_limit: 1,
                throttling_rate_limit: 1.0,
              },
              deployment_id: "NonEmptyString",
              last_updated_date: "NonEmptyString",
              route_settings: {
                detailed_metrics_enabled: false,
                logging_level: "NonEmptyString",
                data_trace_enabled: false,
                throttling_burst_limit: 1,
                throttling_rate_limit: 1.0,
              },
              stage_name: "NonEmptyString",
              stage_variables: {
                "NonEmptyString" => "NonEmptyString",
              },
              access_log_settings: {
                format: "NonEmptyString",
                destination_arn: "NonEmptyString",
              },
              auto_deploy: false,
              last_deployment_status_message: "NonEmptyString",
              api_gateway_managed: false,
            },
            aws_api_gateway_v2_api: {
              api_endpoint: "NonEmptyString",
              api_id: "NonEmptyString",
              api_key_selection_expression: "NonEmptyString",
              created_date: "NonEmptyString",
              description: "NonEmptyString",
              version: "NonEmptyString",
              name: "NonEmptyString",
              protocol_type: "NonEmptyString",
              route_selection_expression: "NonEmptyString",
              cors_configuration: {
                allow_origins: ["NonEmptyString"],
                allow_credentials: false,
                expose_headers: ["NonEmptyString"],
                max_age: 1,
                allow_methods: ["NonEmptyString"],
                allow_headers: ["NonEmptyString"],
              },
            },
            aws_dynamo_db_table: {
              attribute_definitions: [
                {
                  attribute_name: "NonEmptyString",
                  attribute_type: "NonEmptyString",
                },
              ],
              billing_mode_summary: {
                billing_mode: "NonEmptyString",
                last_update_to_pay_per_request_date_time: "NonEmptyString",
              },
              creation_date_time: "NonEmptyString",
              global_secondary_indexes: [
                {
                  backfilling: false,
                  index_arn: "NonEmptyString",
                  index_name: "NonEmptyString",
                  index_size_bytes: 1,
                  index_status: "NonEmptyString",
                  item_count: 1,
                  key_schema: [
                    {
                      attribute_name: "NonEmptyString",
                      key_type: "NonEmptyString",
                    },
                  ],
                  projection: {
                    non_key_attributes: ["NonEmptyString"],
                    projection_type: "NonEmptyString",
                  },
                  provisioned_throughput: {
                    last_decrease_date_time: "NonEmptyString",
                    last_increase_date_time: "NonEmptyString",
                    number_of_decreases_today: 1,
                    read_capacity_units: 1,
                    write_capacity_units: 1,
                  },
                },
              ],
              global_table_version: "NonEmptyString",
              item_count: 1,
              key_schema: [
                {
                  attribute_name: "NonEmptyString",
                  key_type: "NonEmptyString",
                },
              ],
              latest_stream_arn: "NonEmptyString",
              latest_stream_label: "NonEmptyString",
              local_secondary_indexes: [
                {
                  index_arn: "NonEmptyString",
                  index_name: "NonEmptyString",
                  key_schema: [
                    {
                      attribute_name: "NonEmptyString",
                      key_type: "NonEmptyString",
                    },
                  ],
                  projection: {
                    non_key_attributes: ["NonEmptyString"],
                    projection_type: "NonEmptyString",
                  },
                },
              ],
              provisioned_throughput: {
                last_decrease_date_time: "NonEmptyString",
                last_increase_date_time: "NonEmptyString",
                number_of_decreases_today: 1,
                read_capacity_units: 1,
                write_capacity_units: 1,
              },
              replicas: [
                {
                  global_secondary_indexes: [
                    {
                      index_name: "NonEmptyString",
                      provisioned_throughput_override: {
                        read_capacity_units: 1,
                      },
                    },
                  ],
                  kms_master_key_id: "NonEmptyString",
                  provisioned_throughput_override: {
                    read_capacity_units: 1,
                  },
                  region_name: "NonEmptyString",
                  replica_status: "NonEmptyString",
                  replica_status_description: "NonEmptyString",
                },
              ],
              restore_summary: {
                source_backup_arn: "NonEmptyString",
                source_table_arn: "NonEmptyString",
                restore_date_time: "NonEmptyString",
                restore_in_progress: false,
              },
              sse_description: {
                inaccessible_encryption_date_time: "NonEmptyString",
                status: "NonEmptyString",
                sse_type: "NonEmptyString",
                kms_master_key_arn: "NonEmptyString",
              },
              stream_specification: {
                stream_enabled: false,
                stream_view_type: "NonEmptyString",
              },
              table_id: "NonEmptyString",
              table_name: "NonEmptyString",
              table_size_bytes: 1,
              table_status: "NonEmptyString",
            },
            aws_api_gateway_stage: {
              deployment_id: "NonEmptyString",
              client_certificate_id: "NonEmptyString",
              stage_name: "NonEmptyString",
              description: "NonEmptyString",
              cache_cluster_enabled: false,
              cache_cluster_size: "NonEmptyString",
              cache_cluster_status: "NonEmptyString",
              method_settings: [
                {
                  metrics_enabled: false,
                  logging_level: "NonEmptyString",
                  data_trace_enabled: false,
                  throttling_burst_limit: 1,
                  throttling_rate_limit: 1.0,
                  caching_enabled: false,
                  cache_ttl_in_seconds: 1,
                  cache_data_encrypted: false,
                  require_authorization_for_cache_control: false,
                  unauthorized_cache_control_header_strategy: "NonEmptyString",
                  http_method: "NonEmptyString",
                  resource_path: "NonEmptyString",
                },
              ],
              variables: {
                "NonEmptyString" => "NonEmptyString",
              },
              documentation_version: "NonEmptyString",
              access_log_settings: {
                format: "NonEmptyString",
                destination_arn: "NonEmptyString",
              },
              canary_settings: {
                percent_traffic: 1.0,
                deployment_id: "NonEmptyString",
                stage_variable_overrides: {
                  "NonEmptyString" => "NonEmptyString",
                },
                use_stage_cache: false,
              },
              tracing_enabled: false,
              created_date: "NonEmptyString",
              last_updated_date: "NonEmptyString",
              web_acl_arn: "NonEmptyString",
            },
            aws_api_gateway_rest_api: {
              id: "NonEmptyString",
              name: "NonEmptyString",
              description: "NonEmptyString",
              created_date: "NonEmptyString",
              version: "NonEmptyString",
              binary_media_types: ["NonEmptyString"],
              minimum_compression_size: 1,
              api_key_source: "NonEmptyString",
              endpoint_configuration: {
                types: ["NonEmptyString"],
              },
            },
            aws_cloud_trail_trail: {
              cloud_watch_logs_log_group_arn: "NonEmptyString",
              cloud_watch_logs_role_arn: "NonEmptyString",
              has_custom_event_selectors: false,
              home_region: "NonEmptyString",
              include_global_service_events: false,
              is_multi_region_trail: false,
              is_organization_trail: false,
              kms_key_id: "NonEmptyString",
              log_file_validation_enabled: false,
              name: "NonEmptyString",
              s3_bucket_name: "NonEmptyString",
              s3_key_prefix: "NonEmptyString",
              sns_topic_arn: "NonEmptyString",
              sns_topic_name: "NonEmptyString",
              trail_arn: "NonEmptyString",
            },
            aws_ssm_patch_compliance: {
              patch: {
                compliance_summary: {
                  status: "NonEmptyString",
                  compliant_critical_count: 1,
                  compliant_high_count: 1,
                  compliant_medium_count: 1,
                  execution_type: "NonEmptyString",
                  non_compliant_critical_count: 1,
                  compliant_informational_count: 1,
                  non_compliant_informational_count: 1,
                  compliant_unspecified_count: 1,
                  non_compliant_low_count: 1,
                  non_compliant_high_count: 1,
                  compliant_low_count: 1,
                  compliance_type: "NonEmptyString",
                  patch_baseline_id: "NonEmptyString",
                  overall_severity: "NonEmptyString",
                  non_compliant_medium_count: 1,
                  non_compliant_unspecified_count: 1,
                  patch_group: "NonEmptyString",
                },
              },
            },
            aws_certificate_manager_certificate: {
              certificate_authority_arn: "NonEmptyString",
              created_at: "NonEmptyString",
              domain_name: "NonEmptyString",
              domain_validation_options: [
                {
                  domain_name: "NonEmptyString",
                  resource_record: {
                    name: "NonEmptyString",
                    type: "NonEmptyString",
                    value: "NonEmptyString",
                  },
                  validation_domain: "NonEmptyString",
                  validation_emails: ["NonEmptyString"],
                  validation_method: "NonEmptyString",
                  validation_status: "NonEmptyString",
                },
              ],
              extended_key_usages: [
                {
                  name: "NonEmptyString",
                  o_id: "NonEmptyString",
                },
              ],
              failure_reason: "NonEmptyString",
              imported_at: "NonEmptyString",
              in_use_by: ["NonEmptyString"],
              issued_at: "NonEmptyString",
              issuer: "NonEmptyString",
              key_algorithm: "NonEmptyString",
              key_usages: [
                {
                  name: "NonEmptyString",
                },
              ],
              not_after: "NonEmptyString",
              not_before: "NonEmptyString",
              options: {
                certificate_transparency_logging_preference: "NonEmptyString",
              },
              renewal_eligibility: "NonEmptyString",
              renewal_summary: {
                domain_validation_options: [
                  {
                    domain_name: "NonEmptyString",
                    resource_record: {
                      name: "NonEmptyString",
                      type: "NonEmptyString",
                      value: "NonEmptyString",
                    },
                    validation_domain: "NonEmptyString",
                    validation_emails: ["NonEmptyString"],
                    validation_method: "NonEmptyString",
                    validation_status: "NonEmptyString",
                  },
                ],
                renewal_status: "NonEmptyString",
                renewal_status_reason: "NonEmptyString",
                updated_at: "NonEmptyString",
              },
              serial: "NonEmptyString",
              signature_algorithm: "NonEmptyString",
              status: "NonEmptyString",
              subject: "NonEmptyString",
              subject_alternative_names: ["NonEmptyString"],
              type: "NonEmptyString",
            },
            aws_redshift_cluster: {
              allow_version_upgrade: false,
              automated_snapshot_retention_period: 1,
              availability_zone: "NonEmptyString",
              cluster_availability_status: "NonEmptyString",
              cluster_create_time: "NonEmptyString",
              cluster_identifier: "NonEmptyString",
              cluster_nodes: [
                {
                  node_role: "NonEmptyString",
                  private_ip_address: "NonEmptyString",
                  public_ip_address: "NonEmptyString",
                },
              ],
              cluster_parameter_groups: [
                {
                  cluster_parameter_status_list: [
                    {
                      parameter_name: "NonEmptyString",
                      parameter_apply_status: "NonEmptyString",
                      parameter_apply_error_description: "NonEmptyString",
                    },
                  ],
                  parameter_apply_status: "NonEmptyString",
                  parameter_group_name: "NonEmptyString",
                },
              ],
              cluster_public_key: "NonEmptyString",
              cluster_revision_number: "NonEmptyString",
              cluster_security_groups: [
                {
                  cluster_security_group_name: "NonEmptyString",
                  status: "NonEmptyString",
                },
              ],
              cluster_snapshot_copy_status: {
                destination_region: "NonEmptyString",
                manual_snapshot_retention_period: 1,
                retention_period: 1,
                snapshot_copy_grant_name: "NonEmptyString",
              },
              cluster_status: "NonEmptyString",
              cluster_subnet_group_name: "NonEmptyString",
              cluster_version: "NonEmptyString",
              db_name: "NonEmptyString",
              deferred_maintenance_windows: [
                {
                  defer_maintenance_end_time: "NonEmptyString",
                  defer_maintenance_identifier: "NonEmptyString",
                  defer_maintenance_start_time: "NonEmptyString",
                },
              ],
              elastic_ip_status: {
                elastic_ip: "NonEmptyString",
                status: "NonEmptyString",
              },
              elastic_resize_number_of_node_options: "NonEmptyString",
              encrypted: false,
              endpoint: {
                address: "NonEmptyString",
                port: 1,
              },
              enhanced_vpc_routing: false,
              expected_next_snapshot_schedule_time: "NonEmptyString",
              expected_next_snapshot_schedule_time_status: "NonEmptyString",
              hsm_status: {
                hsm_client_certificate_identifier: "NonEmptyString",
                hsm_configuration_identifier: "NonEmptyString",
                status: "NonEmptyString",
              },
              iam_roles: [
                {
                  apply_status: "NonEmptyString",
                  iam_role_arn: "NonEmptyString",
                },
              ],
              kms_key_id: "NonEmptyString",
              maintenance_track_name: "NonEmptyString",
              manual_snapshot_retention_period: 1,
              master_username: "NonEmptyString",
              next_maintenance_window_start_time: "NonEmptyString",
              node_type: "NonEmptyString",
              number_of_nodes: 1,
              pending_actions: ["NonEmptyString"],
              pending_modified_values: {
                automated_snapshot_retention_period: 1,
                cluster_identifier: "NonEmptyString",
                cluster_type: "NonEmptyString",
                cluster_version: "NonEmptyString",
                encryption_type: "NonEmptyString",
                enhanced_vpc_routing: false,
                maintenance_track_name: "NonEmptyString",
                master_user_password: "NonEmptyString",
                node_type: "NonEmptyString",
                number_of_nodes: 1,
                publicly_accessible: false,
              },
              preferred_maintenance_window: "NonEmptyString",
              publicly_accessible: false,
              resize_info: {
                allow_cancel_resize: false,
                resize_type: "NonEmptyString",
              },
              restore_status: {
                current_restore_rate_in_mega_bytes_per_second: 1.0,
                elapsed_time_in_seconds: 1,
                estimated_time_to_completion_in_seconds: 1,
                progress_in_mega_bytes: 1,
                snapshot_size_in_mega_bytes: 1,
                status: "NonEmptyString",
              },
              snapshot_schedule_identifier: "NonEmptyString",
              snapshot_schedule_state: "NonEmptyString",
              vpc_id: "NonEmptyString",
              vpc_security_groups: [
                {
                  status: "NonEmptyString",
                  vpc_security_group_id: "NonEmptyString",
                },
              ],
            },
            aws_elb_load_balancer: {
              availability_zones: ["NonEmptyString"],
              backend_server_descriptions: [
                {
                  instance_port: 1,
                  policy_names: ["NonEmptyString"],
                },
              ],
              canonical_hosted_zone_name: "NonEmptyString",
              canonical_hosted_zone_name_id: "NonEmptyString",
              created_time: "NonEmptyString",
              dns_name: "NonEmptyString",
              health_check: {
                healthy_threshold: 1,
                interval: 1,
                target: "NonEmptyString",
                timeout: 1,
                unhealthy_threshold: 1,
              },
              instances: [
                {
                  instance_id: "NonEmptyString",
                },
              ],
              listener_descriptions: [
                {
                  listener: {
                    instance_port: 1,
                    instance_protocol: "NonEmptyString",
                    load_balancer_port: 1,
                    protocol: "NonEmptyString",
                    ssl_certificate_id: "NonEmptyString",
                  },
                  policy_names: ["NonEmptyString"],
                },
              ],
              load_balancer_attributes: {
                access_log: {
                  emit_interval: 1,
                  enabled: false,
                  s3_bucket_name: "NonEmptyString",
                  s3_bucket_prefix: "NonEmptyString",
                },
                connection_draining: {
                  enabled: false,
                  timeout: 1,
                },
                connection_settings: {
                  idle_timeout: 1,
                },
                cross_zone_load_balancing: {
                  enabled: false,
                },
              },
              load_balancer_name: "NonEmptyString",
              policies: {
                app_cookie_stickiness_policies: [
                  {
                    cookie_name: "NonEmptyString",
                    policy_name: "NonEmptyString",
                  },
                ],
                lb_cookie_stickiness_policies: [
                  {
                    cookie_expiration_period: 1,
                    policy_name: "NonEmptyString",
                  },
                ],
                other_policies: ["NonEmptyString"],
              },
              scheme: "NonEmptyString",
              security_groups: ["NonEmptyString"],
              source_security_group: {
                group_name: "NonEmptyString",
                owner_alias: "NonEmptyString",
              },
              subnets: ["NonEmptyString"],
              vpc_id: "NonEmptyString",
            },
            aws_iam_group: {
              attached_managed_policies: [
                {
                  policy_name: "NonEmptyString",
                  policy_arn: "NonEmptyString",
                },
              ],
              create_date: "NonEmptyString",
              group_id: "NonEmptyString",
              group_name: "NonEmptyString",
              group_policy_list: [
                {
                  policy_name: "NonEmptyString",
                },
              ],
              path: "NonEmptyString",
            },
            aws_iam_role: {
              assume_role_policy_document: "AwsIamRoleAssumeRolePolicyDocument",
              attached_managed_policies: [
                {
                  policy_name: "NonEmptyString",
                  policy_arn: "NonEmptyString",
                },
              ],
              create_date: "NonEmptyString",
              instance_profile_list: [
                {
                  arn: "NonEmptyString",
                  create_date: "NonEmptyString",
                  instance_profile_id: "NonEmptyString",
                  instance_profile_name: "NonEmptyString",
                  path: "NonEmptyString",
                  roles: [
                    {
                      arn: "NonEmptyString",
                      assume_role_policy_document: "AwsIamRoleAssumeRolePolicyDocument",
                      create_date: "NonEmptyString",
                      path: "NonEmptyString",
                      role_id: "NonEmptyString",
                      role_name: "NonEmptyString",
                    },
                  ],
                },
              ],
              permissions_boundary: {
                permissions_boundary_arn: "NonEmptyString",
                permissions_boundary_type: "NonEmptyString",
              },
              role_id: "NonEmptyString",
              role_name: "NonEmptyString",
              role_policy_list: [
                {
                  policy_name: "NonEmptyString",
                },
              ],
              max_session_duration: 1,
              path: "NonEmptyString",
            },
            aws_kms_key: {
              aws_account_id: "NonEmptyString",
              creation_date: 1.0,
              key_id: "NonEmptyString",
              key_manager: "NonEmptyString",
              key_state: "NonEmptyString",
              origin: "NonEmptyString",
              description: "NonEmptyString",
              key_rotation_status: false,
            },
            aws_lambda_function: {
              code: {
                s3_bucket: "NonEmptyString",
                s3_key: "NonEmptyString",
                s3_object_version: "NonEmptyString",
                zip_file: "NonEmptyString",
              },
              code_sha_256: "NonEmptyString",
              dead_letter_config: {
                target_arn: "NonEmptyString",
              },
              environment: {
                variables: {
                  "NonEmptyString" => "NonEmptyString",
                },
                error: {
                  error_code: "NonEmptyString",
                  message: "NonEmptyString",
                },
              },
              function_name: "NonEmptyString",
              handler: "NonEmptyString",
              kms_key_arn: "NonEmptyString",
              last_modified: "NonEmptyString",
              layers: [
                {
                  arn: "NonEmptyString",
                  code_size: 1,
                },
              ],
              master_arn: "NonEmptyString",
              memory_size: 1,
              revision_id: "NonEmptyString",
              role: "NonEmptyString",
              runtime: "NonEmptyString",
              timeout: 1,
              tracing_config: {
                mode: "NonEmptyString",
              },
              vpc_config: {
                security_group_ids: ["NonEmptyString"],
                subnet_ids: ["NonEmptyString"],
                vpc_id: "NonEmptyString",
              },
              version: "NonEmptyString",
            },
            aws_lambda_layer_version: {
              version: 1,
              compatible_runtimes: ["NonEmptyString"],
              created_date: "NonEmptyString",
            },
            aws_rds_db_instance: {
              associated_roles: [
                {
                  role_arn: "NonEmptyString",
                  feature_name: "NonEmptyString",
                  status: "NonEmptyString",
                },
              ],
              ca_certificate_identifier: "NonEmptyString",
              db_cluster_identifier: "NonEmptyString",
              db_instance_identifier: "NonEmptyString",
              db_instance_class: "NonEmptyString",
              db_instance_port: 1,
              dbi_resource_id: "NonEmptyString",
              db_name: "NonEmptyString",
              deletion_protection: false,
              endpoint: {
                address: "NonEmptyString",
                port: 1,
                hosted_zone_id: "NonEmptyString",
              },
              engine: "NonEmptyString",
              engine_version: "NonEmptyString",
              iam_database_authentication_enabled: false,
              instance_create_time: "NonEmptyString",
              kms_key_id: "NonEmptyString",
              publicly_accessible: false,
              storage_encrypted: false,
              tde_credential_arn: "NonEmptyString",
              vpc_security_groups: [
                {
                  vpc_security_group_id: "NonEmptyString",
                  status: "NonEmptyString",
                },
              ],
              multi_az: false,
              enhanced_monitoring_resource_arn: "NonEmptyString",
              db_instance_status: "NonEmptyString",
              master_username: "NonEmptyString",
              allocated_storage: 1,
              preferred_backup_window: "NonEmptyString",
              backup_retention_period: 1,
              db_security_groups: ["NonEmptyString"],
              db_parameter_groups: [
                {
                  db_parameter_group_name: "NonEmptyString",
                  parameter_apply_status: "NonEmptyString",
                },
              ],
              availability_zone: "NonEmptyString",
              db_subnet_group: {
                db_subnet_group_name: "NonEmptyString",
                db_subnet_group_description: "NonEmptyString",
                vpc_id: "NonEmptyString",
                subnet_group_status: "NonEmptyString",
                subnets: [
                  {
                    subnet_identifier: "NonEmptyString",
                    subnet_availability_zone: {
                      name: "NonEmptyString",
                    },
                    subnet_status: "NonEmptyString",
                  },
                ],
                db_subnet_group_arn: "NonEmptyString",
              },
              preferred_maintenance_window: "NonEmptyString",
              pending_modified_values: {
                db_instance_class: "NonEmptyString",
                allocated_storage: 1,
                master_user_password: "NonEmptyString",
                port: 1,
                backup_retention_period: 1,
                multi_az: false,
                engine_version: "NonEmptyString",
                license_model: "NonEmptyString",
                iops: 1,
                db_instance_identifier: "NonEmptyString",
                storage_type: "NonEmptyString",
                ca_certificate_identifier: "NonEmptyString",
                db_subnet_group_name: "NonEmptyString",
                pending_cloud_watch_logs_exports: {
                  log_types_to_enable: ["NonEmptyString"],
                  log_types_to_disable: ["NonEmptyString"],
                },
                processor_features: [
                  {
                    name: "NonEmptyString",
                    value: "NonEmptyString",
                  },
                ],
              },
              latest_restorable_time: "NonEmptyString",
              auto_minor_version_upgrade: false,
              read_replica_source_db_instance_identifier: "NonEmptyString",
              read_replica_db_instance_identifiers: ["NonEmptyString"],
              read_replica_db_cluster_identifiers: ["NonEmptyString"],
              license_model: "NonEmptyString",
              iops: 1,
              option_group_memberships: [
                {
                  option_group_name: "NonEmptyString",
                  status: "NonEmptyString",
                },
              ],
              character_set_name: "NonEmptyString",
              secondary_availability_zone: "NonEmptyString",
              status_infos: [
                {
                  status_type: "NonEmptyString",
                  normal: false,
                  status: "NonEmptyString",
                  message: "NonEmptyString",
                },
              ],
              storage_type: "NonEmptyString",
              domain_memberships: [
                {
                  domain: "NonEmptyString",
                  status: "NonEmptyString",
                  fqdn: "NonEmptyString",
                  iam_role_name: "NonEmptyString",
                },
              ],
              copy_tags_to_snapshot: false,
              monitoring_interval: 1,
              monitoring_role_arn: "NonEmptyString",
              promotion_tier: 1,
              timezone: "NonEmptyString",
              performance_insights_enabled: false,
              performance_insights_kms_key_id: "NonEmptyString",
              performance_insights_retention_period: 1,
              enabled_cloud_watch_logs_exports: ["NonEmptyString"],
              processor_features: [
                {
                  name: "NonEmptyString",
                  value: "NonEmptyString",
                },
              ],
              listener_endpoint: {
                address: "NonEmptyString",
                port: 1,
                hosted_zone_id: "NonEmptyString",
              },
              max_allocated_storage: 1,
            },
            aws_sns_topic: {
              kms_master_key_id: "NonEmptyString",
              subscription: [
                {
                  endpoint: "NonEmptyString",
                  protocol: "NonEmptyString",
                },
              ],
              topic_name: "NonEmptyString",
              owner: "NonEmptyString",
            },
            aws_sqs_queue: {
              kms_data_key_reuse_period_seconds: 1,
              kms_master_key_id: "NonEmptyString",
              queue_name: "NonEmptyString",
              dead_letter_target_arn: "NonEmptyString",
            },
            aws_waf_web_acl: {
              name: "NonEmptyString",
              default_action: "NonEmptyString",
              rules: [
                {
                  action: {
                    type: "NonEmptyString",
                  },
                  excluded_rules: [
                    {
                      rule_id: "NonEmptyString",
                    },
                  ],
                  override_action: {
                    type: "NonEmptyString",
                  },
                  priority: 1,
                  rule_id: "NonEmptyString",
                  type: "NonEmptyString",
                },
              ],
              web_acl_id: "NonEmptyString",
            },
            aws_rds_db_snapshot: {
              db_snapshot_identifier: "NonEmptyString",
              db_instance_identifier: "NonEmptyString",
              snapshot_create_time: "NonEmptyString",
              engine: "NonEmptyString",
              allocated_storage: 1,
              status: "NonEmptyString",
              port: 1,
              availability_zone: "NonEmptyString",
              vpc_id: "NonEmptyString",
              instance_create_time: "NonEmptyString",
              master_username: "NonEmptyString",
              engine_version: "NonEmptyString",
              license_model: "NonEmptyString",
              snapshot_type: "NonEmptyString",
              iops: 1,
              option_group_name: "NonEmptyString",
              percent_progress: 1,
              source_region: "NonEmptyString",
              source_db_snapshot_identifier: "NonEmptyString",
              storage_type: "NonEmptyString",
              tde_credential_arn: "NonEmptyString",
              encrypted: false,
              kms_key_id: "NonEmptyString",
              timezone: "NonEmptyString",
              iam_database_authentication_enabled: false,
              processor_features: [
                {
                  name: "NonEmptyString",
                  value: "NonEmptyString",
                },
              ],
              dbi_resource_id: "NonEmptyString",
            },
            aws_rds_db_cluster_snapshot: {
              availability_zones: ["NonEmptyString"],
              snapshot_create_time: "NonEmptyString",
              engine: "NonEmptyString",
              allocated_storage: 1,
              status: "NonEmptyString",
              port: 1,
              vpc_id: "NonEmptyString",
              cluster_create_time: "NonEmptyString",
              master_username: "NonEmptyString",
              engine_version: "NonEmptyString",
              license_model: "NonEmptyString",
              snapshot_type: "NonEmptyString",
              percent_progress: 1,
              storage_encrypted: false,
              kms_key_id: "NonEmptyString",
              db_cluster_identifier: "NonEmptyString",
              db_cluster_snapshot_identifier: "NonEmptyString",
              iam_database_authentication_enabled: false,
            },
            aws_rds_db_cluster: {
              allocated_storage: 1,
              availability_zones: ["NonEmptyString"],
              backup_retention_period: 1,
              database_name: "NonEmptyString",
              status: "NonEmptyString",
              endpoint: "NonEmptyString",
              reader_endpoint: "NonEmptyString",
              custom_endpoints: ["NonEmptyString"],
              multi_az: false,
              engine: "NonEmptyString",
              engine_version: "NonEmptyString",
              port: 1,
              master_username: "NonEmptyString",
              preferred_backup_window: "NonEmptyString",
              preferred_maintenance_window: "NonEmptyString",
              read_replica_identifiers: ["NonEmptyString"],
              vpc_security_groups: [
                {
                  vpc_security_group_id: "NonEmptyString",
                  status: "NonEmptyString",
                },
              ],
              hosted_zone_id: "NonEmptyString",
              storage_encrypted: false,
              kms_key_id: "NonEmptyString",
              db_cluster_resource_id: "NonEmptyString",
              associated_roles: [
                {
                  role_arn: "NonEmptyString",
                  status: "NonEmptyString",
                },
              ],
              cluster_create_time: "NonEmptyString",
              enabled_cloud_watch_logs_exports: ["NonEmptyString"],
              engine_mode: "NonEmptyString",
              deletion_protection: false,
              http_endpoint_enabled: false,
              activity_stream_status: "NonEmptyString",
              copy_tags_to_snapshot: false,
              cross_account_clone: false,
              domain_memberships: [
                {
                  domain: "NonEmptyString",
                  status: "NonEmptyString",
                  fqdn: "NonEmptyString",
                  iam_role_name: "NonEmptyString",
                },
              ],
              db_cluster_parameter_group: "NonEmptyString",
              db_subnet_group: "NonEmptyString",
              db_cluster_option_group_memberships: [
                {
                  db_cluster_option_group_name: "NonEmptyString",
                  status: "NonEmptyString",
                },
              ],
              db_cluster_identifier: "NonEmptyString",
              db_cluster_members: [
                {
                  is_cluster_writer: false,
                  promotion_tier: 1,
                  db_instance_identifier: "NonEmptyString",
                  db_cluster_parameter_group_status: "NonEmptyString",
                },
              ],
              iam_database_authentication_enabled: false,
            },
            aws_ecs_cluster: {
              capacity_providers: ["NonEmptyString"],
              cluster_settings: [
                {
                  name: "NonEmptyString",
                  value: "NonEmptyString",
                },
              ],
              configuration: {
                execute_command_configuration: {
                  kms_key_id: "NonEmptyString",
                  log_configuration: {
                    cloud_watch_encryption_enabled: false,
                    cloud_watch_log_group_name: "NonEmptyString",
                    s3_bucket_name: "NonEmptyString",
                    s3_encryption_enabled: false,
                    s3_key_prefix: "NonEmptyString",
                  },
                  logging: "NonEmptyString",
                },
              },
              default_capacity_provider_strategy: [
                {
                  base: 1,
                  capacity_provider: "NonEmptyString",
                  weight: 1,
                },
              ],
            },
            aws_ecs_task_definition: {
              container_definitions: [
                {
                  command: ["NonEmptyString"],
                  cpu: 1,
                  depends_on: [
                    {
                      condition: "NonEmptyString",
                      container_name: "NonEmptyString",
                    },
                  ],
                  disable_networking: false,
                  dns_search_domains: ["NonEmptyString"],
                  dns_servers: ["NonEmptyString"],
                  docker_labels: {
                    "NonEmptyString" => "NonEmptyString",
                  },
                  docker_security_options: ["NonEmptyString"],
                  entry_point: ["NonEmptyString"],
                  environment: [
                    {
                      name: "NonEmptyString",
                      value: "NonEmptyString",
                    },
                  ],
                  environment_files: [
                    {
                      type: "NonEmptyString",
                      value: "NonEmptyString",
                    },
                  ],
                  essential: false,
                  extra_hosts: [
                    {
                      hostname: "NonEmptyString",
                      ip_address: "NonEmptyString",
                    },
                  ],
                  firelens_configuration: {
                    options: {
                      "NonEmptyString" => "NonEmptyString",
                    },
                    type: "NonEmptyString",
                  },
                  health_check: {
                    command: ["NonEmptyString"],
                    interval: 1,
                    retries: 1,
                    start_period: 1,
                    timeout: 1,
                  },
                  hostname: "NonEmptyString",
                  image: "NonEmptyString",
                  interactive: false,
                  links: ["NonEmptyString"],
                  linux_parameters: {
                    capabilities: {
                      add: ["NonEmptyString"],
                      drop: ["NonEmptyString"],
                    },
                    devices: [
                      {
                        container_path: "NonEmptyString",
                        host_path: "NonEmptyString",
                        permissions: ["NonEmptyString"],
                      },
                    ],
                    init_process_enabled: false,
                    max_swap: 1,
                    shared_memory_size: 1,
                    swappiness: 1,
                    tmpfs: [
                      {
                        container_path: "NonEmptyString",
                        mount_options: ["NonEmptyString"],
                        size: 1,
                      },
                    ],
                  },
                  log_configuration: {
                    log_driver: "NonEmptyString",
                    options: {
                      "NonEmptyString" => "NonEmptyString",
                    },
                    secret_options: [
                      {
                        name: "NonEmptyString",
                        value_from: "NonEmptyString",
                      },
                    ],
                  },
                  memory: 1,
                  memory_reservation: 1,
                  mount_points: [
                    {
                      container_path: "NonEmptyString",
                      read_only: false,
                      source_volume: "NonEmptyString",
                    },
                  ],
                  name: "NonEmptyString",
                  port_mappings: [
                    {
                      container_port: 1,
                      host_port: 1,
                      protocol: "NonEmptyString",
                    },
                  ],
                  privileged: false,
                  pseudo_terminal: false,
                  readonly_root_filesystem: false,
                  repository_credentials: {
                    credentials_parameter: "NonEmptyString",
                  },
                  resource_requirements: [
                    {
                      type: "NonEmptyString",
                      value: "NonEmptyString",
                    },
                  ],
                  secrets: [
                    {
                      name: "NonEmptyString",
                      value_from: "NonEmptyString",
                    },
                  ],
                  start_timeout: 1,
                  stop_timeout: 1,
                  system_controls: [
                    {
                      namespace: "NonEmptyString",
                      value: "NonEmptyString",
                    },
                  ],
                  ulimits: [
                    {
                      hard_limit: 1,
                      name: "NonEmptyString",
                      soft_limit: 1,
                    },
                  ],
                  user: "NonEmptyString",
                  volumes_from: [
                    {
                      read_only: false,
                      source_container: "NonEmptyString",
                    },
                  ],
                  working_directory: "NonEmptyString",
                },
              ],
              cpu: "NonEmptyString",
              execution_role_arn: "NonEmptyString",
              family: "NonEmptyString",
              inference_accelerators: [
                {
                  device_name: "NonEmptyString",
                  device_type: "NonEmptyString",
                },
              ],
              ipc_mode: "NonEmptyString",
              memory: "NonEmptyString",
              network_mode: "NonEmptyString",
              pid_mode: "NonEmptyString",
              placement_constraints: [
                {
                  expression: "NonEmptyString",
                  type: "NonEmptyString",
                },
              ],
              proxy_configuration: {
                container_name: "NonEmptyString",
                proxy_configuration_properties: [
                  {
                    name: "NonEmptyString",
                    value: "NonEmptyString",
                  },
                ],
                type: "NonEmptyString",
              },
              requires_compatibilities: ["NonEmptyString"],
              task_role_arn: "NonEmptyString",
              volumes: [
                {
                  docker_volume_configuration: {
                    autoprovision: false,
                    driver: "NonEmptyString",
                    driver_opts: {
                      "NonEmptyString" => "NonEmptyString",
                    },
                    labels: {
                      "NonEmptyString" => "NonEmptyString",
                    },
                    scope: "NonEmptyString",
                  },
                  efs_volume_configuration: {
                    authorization_config: {
                      access_point_id: "NonEmptyString",
                      iam: "NonEmptyString",
                    },
                    filesystem_id: "NonEmptyString",
                    root_directory: "NonEmptyString",
                    transit_encryption: "NonEmptyString",
                    transit_encryption_port: 1,
                  },
                  host: {
                    source_path: "NonEmptyString",
                  },
                  name: "NonEmptyString",
                },
              ],
            },
            container: {
              name: "NonEmptyString",
              image_id: "NonEmptyString",
              image_name: "NonEmptyString",
              launched_at: "NonEmptyString",
            },
            other: {
              "NonEmptyString" => "NonEmptyString",
            },
            aws_rds_event_subscription: {
              cust_subscription_id: "NonEmptyString",
              customer_aws_id: "NonEmptyString",
              enabled: false,
              event_categories_list: ["NonEmptyString"],
              event_subscription_arn: "NonEmptyString",
              sns_topic_arn: "NonEmptyString",
              source_ids_list: ["NonEmptyString"],
              source_type: "NonEmptyString",
              status: "NonEmptyString",
              subscription_creation_time: "NonEmptyString",
            },
            aws_ecs_service: {
              capacity_provider_strategy: [
                {
                  base: 1,
                  capacity_provider: "NonEmptyString",
                  weight: 1,
                },
              ],
              cluster: "NonEmptyString",
              deployment_configuration: {
                deployment_circuit_breaker: {
                  enable: false,
                  rollback: false,
                },
                maximum_percent: 1,
                minimum_healthy_percent: 1,
              },
              deployment_controller: {
                type: "NonEmptyString",
              },
              desired_count: 1,
              enable_ecs_managed_tags: false,
              enable_execute_command: false,
              health_check_grace_period_seconds: 1,
              launch_type: "NonEmptyString",
              load_balancers: [
                {
                  container_name: "NonEmptyString",
                  container_port: 1,
                  load_balancer_name: "NonEmptyString",
                  target_group_arn: "NonEmptyString",
                },
              ],
              name: "NonEmptyString",
              network_configuration: {
                aws_vpc_configuration: {
                  assign_public_ip: "NonEmptyString",
                  security_groups: ["NonEmptyString"],
                  subnets: ["NonEmptyString"],
                },
              },
              placement_constraints: [
                {
                  expression: "NonEmptyString",
                  type: "NonEmptyString",
                },
              ],
              placement_strategies: [
                {
                  field: "NonEmptyString",
                  type: "NonEmptyString",
                },
              ],
              platform_version: "NonEmptyString",
              propagate_tags: "NonEmptyString",
              role: "NonEmptyString",
              scheduling_strategy: "NonEmptyString",
              service_arn: "NonEmptyString",
              service_name: "NonEmptyString",
              service_registries: [
                {
                  container_name: "NonEmptyString",
                  container_port: 1,
                  port: 1,
                  registry_arn: "NonEmptyString",
                },
              ],
              task_definition: "NonEmptyString",
            },
            aws_auto_scaling_launch_configuration: {
              associate_public_ip_address: false,
              block_device_mappings: [
                {
                  device_name: "NonEmptyString",
                  ebs: {
                    delete_on_termination: false,
                    encrypted: false,
                    iops: 1,
                    snapshot_id: "NonEmptyString",
                    volume_size: 1,
                    volume_type: "NonEmptyString",
                  },
                  no_device: false,
                  virtual_name: "NonEmptyString",
                },
              ],
              classic_link_vpc_id: "NonEmptyString",
              classic_link_vpc_security_groups: ["NonEmptyString"],
              created_time: "NonEmptyString",
              ebs_optimized: false,
              iam_instance_profile: "NonEmptyString",
              image_id: "NonEmptyString",
              instance_monitoring: {
                enabled: false,
              },
              instance_type: "NonEmptyString",
              kernel_id: "NonEmptyString",
              key_name: "NonEmptyString",
              launch_configuration_name: "NonEmptyString",
              placement_tenancy: "NonEmptyString",
              ramdisk_id: "NonEmptyString",
              security_groups: ["NonEmptyString"],
              spot_price: "NonEmptyString",
              user_data: "NonEmptyString",
              metadata_options: {
                http_endpoint: "NonEmptyString",
                http_put_response_hop_limit: 1,
                http_tokens: "NonEmptyString",
              },
            },
            aws_ec2_vpn_connection: {
              vpn_connection_id: "NonEmptyString",
              state: "NonEmptyString",
              customer_gateway_id: "NonEmptyString",
              customer_gateway_configuration: "NonEmptyString",
              type: "NonEmptyString",
              vpn_gateway_id: "NonEmptyString",
              category: "NonEmptyString",
              vgw_telemetry: [
                {
                  accepted_route_count: 1,
                  certificate_arn: "NonEmptyString",
                  last_status_change: "NonEmptyString",
                  outside_ip_address: "NonEmptyString",
                  status: "NonEmptyString",
                  status_message: "NonEmptyString",
                },
              ],
              options: {
                static_routes_only: false,
                tunnel_options: [
                  {
                    dpd_timeout_seconds: 1,
                    ike_versions: ["NonEmptyString"],
                    outside_ip_address: "NonEmptyString",
                    phase_1_dh_group_numbers: [1],
                    phase_1_encryption_algorithms: ["NonEmptyString"],
                    phase_1_integrity_algorithms: ["NonEmptyString"],
                    phase_1_lifetime_seconds: 1,
                    phase_2_dh_group_numbers: [1],
                    phase_2_encryption_algorithms: ["NonEmptyString"],
                    phase_2_integrity_algorithms: ["NonEmptyString"],
                    phase_2_lifetime_seconds: 1,
                    pre_shared_key: "NonEmptyString",
                    rekey_fuzz_percentage: 1,
                    rekey_margin_time_seconds: 1,
                    replay_window_size: 1,
                    tunnel_inside_cidr: "NonEmptyString",
                  },
                ],
              },
              routes: [
                {
                  destination_cidr_block: "NonEmptyString",
                  state: "NonEmptyString",
                },
              ],
              transit_gateway_id: "NonEmptyString",
            },
            aws_ecr_container_image: {
              registry_id: "NonEmptyString",
              repository_name: "NonEmptyString",
              architecture: "NonEmptyString",
              image_digest: "NonEmptyString",
              image_tags: ["NonEmptyString"],
              image_published_at: "NonEmptyString",
            },
            aws_open_search_service_domain: {
              arn: "NonEmptyString",
              access_policies: "NonEmptyString",
              domain_name: "NonEmptyString",
              id: "NonEmptyString",
              domain_endpoint: "NonEmptyString",
              engine_version: "NonEmptyString",
              encryption_at_rest_options: {
                enabled: false,
                kms_key_id: "NonEmptyString",
              },
              node_to_node_encryption_options: {
                enabled: false,
              },
              service_software_options: {
                automated_update_date: "NonEmptyString",
                cancellable: false,
                current_version: "NonEmptyString",
                description: "NonEmptyString",
                new_version: "NonEmptyString",
                update_available: false,
                update_status: "NonEmptyString",
                optional_deployment: false,
              },
              cluster_config: {
                instance_count: 1,
                warm_enabled: false,
                warm_count: 1,
                dedicated_master_enabled: false,
                zone_awareness_config: {
                  availability_zone_count: 1,
                },
                dedicated_master_count: 1,
                instance_type: "NonEmptyString",
                warm_type: "NonEmptyString",
                zone_awareness_enabled: false,
                dedicated_master_type: "NonEmptyString",
              },
              domain_endpoint_options: {
                custom_endpoint_certificate_arn: "NonEmptyString",
                custom_endpoint_enabled: false,
                enforce_https: false,
                custom_endpoint: "NonEmptyString",
                tls_security_policy: "NonEmptyString",
              },
              vpc_options: {
                security_group_ids: ["NonEmptyString"],
                subnet_ids: ["NonEmptyString"],
              },
              log_publishing_options: {
                index_slow_logs: {
                  cloud_watch_logs_log_group_arn: "NonEmptyString",
                  enabled: false,
                },
                search_slow_logs: {
                  cloud_watch_logs_log_group_arn: "NonEmptyString",
                  enabled: false,
                },
                audit_logs: {
                  cloud_watch_logs_log_group_arn: "NonEmptyString",
                  enabled: false,
                },
              },
              domain_endpoints: {
                "NonEmptyString" => "NonEmptyString",
              },
            },
            aws_ec2_vpc_endpoint_service: {
              acceptance_required: false,
              availability_zones: ["NonEmptyString"],
              base_endpoint_dns_names: ["NonEmptyString"],
              manages_vpc_endpoints: false,
              gateway_load_balancer_arns: ["NonEmptyString"],
              network_load_balancer_arns: ["NonEmptyString"],
              private_dns_name: "NonEmptyString",
              service_id: "NonEmptyString",
              service_name: "NonEmptyString",
              service_state: "NonEmptyString",
              service_type: [
                {
                  service_type: "NonEmptyString",
                },
              ],
            },
            aws_xray_encryption_config: {
              key_id: "NonEmptyString",
              status: "NonEmptyString",
              type: "NonEmptyString",
            },
            aws_waf_rate_based_rule: {
              metric_name: "NonEmptyString",
              name: "NonEmptyString",
              rate_key: "NonEmptyString",
              rate_limit: 1,
              rule_id: "NonEmptyString",
              match_predicates: [
                {
                  data_id: "NonEmptyString",
                  negated: false,
                  type: "NonEmptyString",
                },
              ],
            },
            aws_waf_regional_rate_based_rule: {
              metric_name: "NonEmptyString",
              name: "NonEmptyString",
              rate_key: "NonEmptyString",
              rate_limit: 1,
              rule_id: "NonEmptyString",
              match_predicates: [
                {
                  data_id: "NonEmptyString",
                  negated: false,
                  type: "NonEmptyString",
                },
              ],
            },
            aws_ecr_repository: {
              arn: "NonEmptyString",
              image_scanning_configuration: {
                scan_on_push: false,
              },
              image_tag_mutability: "NonEmptyString",
              lifecycle_policy: {
                lifecycle_policy_text: "NonEmptyString",
                registry_id: "NonEmptyString",
              },
              repository_name: "NonEmptyString",
              repository_policy_text: "NonEmptyString",
            },
            aws_eks_cluster: {
              arn: "NonEmptyString",
              certificate_authority_data: "NonEmptyString",
              cluster_status: "NonEmptyString",
              endpoint: "NonEmptyString",
              name: "NonEmptyString",
              resources_vpc_config: {
                security_group_ids: ["NonEmptyString"],
                subnet_ids: ["NonEmptyString"],
              },
              role_arn: "NonEmptyString",
              version: "NonEmptyString",
              logging: {
                cluster_logging: [
                  {
                    enabled: false,
                    types: ["NonEmptyString"],
                  },
                ],
              },
            },
            aws_network_firewall_firewall_policy: {
              firewall_policy: {
                stateful_rule_group_references: [
                  {
                    resource_arn: "NonEmptyString",
                  },
                ],
                stateless_custom_actions: [
                  {
                    action_definition: {
                      publish_metric_action: {
                        dimensions: [
                          {
                            value: "NonEmptyString",
                          },
                        ],
                      },
                    },
                    action_name: "NonEmptyString",
                  },
                ],
                stateless_default_actions: ["NonEmptyString"],
                stateless_fragment_default_actions: ["NonEmptyString"],
                stateless_rule_group_references: [
                  {
                    priority: 1,
                    resource_arn: "NonEmptyString",
                  },
                ],
              },
              firewall_policy_arn: "NonEmptyString",
              firewall_policy_id: "NonEmptyString",
              firewall_policy_name: "NonEmptyString",
              description: "NonEmptyString",
            },
            aws_network_firewall_firewall: {
              delete_protection: false,
              description: "NonEmptyString",
              firewall_arn: "NonEmptyString",
              firewall_id: "NonEmptyString",
              firewall_name: "NonEmptyString",
              firewall_policy_arn: "NonEmptyString",
              firewall_policy_change_protection: false,
              subnet_change_protection: false,
              subnet_mappings: [
                {
                  subnet_id: "NonEmptyString",
                },
              ],
              vpc_id: "NonEmptyString",
            },
            aws_network_firewall_rule_group: {
              capacity: 1,
              description: "NonEmptyString",
              rule_group: {
                rule_variables: {
                  ip_sets: {
                    definition: ["NonEmptyString"],
                  },
                  port_sets: {
                    definition: ["NonEmptyString"],
                  },
                },
                rules_source: {
                  rules_source_list: {
                    generated_rules_type: "NonEmptyString",
                    target_types: ["NonEmptyString"],
                    targets: ["NonEmptyString"],
                  },
                  rules_string: "NonEmptyString",
                  stateful_rules: [
                    {
                      action: "NonEmptyString",
                      header: {
                        destination: "NonEmptyString",
                        destination_port: "NonEmptyString",
                        direction: "NonEmptyString",
                        protocol: "NonEmptyString",
                        source: "NonEmptyString",
                        source_port: "NonEmptyString",
                      },
                      rule_options: [
                        {
                          keyword: "NonEmptyString",
                          settings: ["NonEmptyString"],
                        },
                      ],
                    },
                  ],
                  stateless_rules_and_custom_actions: {
                    custom_actions: [
                      {
                        action_definition: {
                          publish_metric_action: {
                            dimensions: [
                              {
                                value: "NonEmptyString",
                              },
                            ],
                          },
                        },
                        action_name: "NonEmptyString",
                      },
                    ],
                    stateless_rules: [
                      {
                        priority: 1,
                        rule_definition: {
                          actions: ["NonEmptyString"],
                          match_attributes: {
                            destination_ports: [
                              {
                                from_port: 1,
                                to_port: 1,
                              },
                            ],
                            destinations: [
                              {
                                address_definition: "NonEmptyString",
                              },
                            ],
                            protocols: [1],
                            source_ports: [
                              {
                                from_port: 1,
                                to_port: 1,
                              },
                            ],
                            sources: [
                              {
                                address_definition: "NonEmptyString",
                              },
                            ],
                            tcp_flags: [
                              {
                                flags: ["NonEmptyString"],
                                masks: ["NonEmptyString"],
                              },
                            ],
                          },
                        },
                      },
                    ],
                  },
                },
              },
              rule_group_arn: "NonEmptyString",
              rule_group_id: "NonEmptyString",
              rule_group_name: "NonEmptyString",
              type: "NonEmptyString",
            },
          },
        },
      ],
      compliance: {
        status: "PASSED", # accepts PASSED, WARNING, FAILED, NOT_AVAILABLE
        related_requirements: ["NonEmptyString"],
        status_reasons: [
          {
            reason_code: "NonEmptyString", # required
            description: "NonEmptyString",
          },
        ],
      },
      verification_state: "UNKNOWN", # accepts UNKNOWN, TRUE_POSITIVE, FALSE_POSITIVE, BENIGN_POSITIVE
      workflow_state: "NEW", # accepts NEW, ASSIGNED, IN_PROGRESS, DEFERRED, RESOLVED
      workflow: {
        status: "NEW", # accepts NEW, NOTIFIED, RESOLVED, SUPPRESSED
      },
      record_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
      related_findings: [
        {
          product_arn: "NonEmptyString", # required
          id: "NonEmptyString", # required
        },
      ],
      note: {
        text: "NonEmptyString", # required
        updated_by: "NonEmptyString", # required
        updated_at: "NonEmptyString", # required
      },
      vulnerabilities: [
        {
          id: "NonEmptyString", # required
          vulnerable_packages: [
            {
              name: "NonEmptyString",
              version: "NonEmptyString",
              epoch: "NonEmptyString",
              release: "NonEmptyString",
              architecture: "NonEmptyString",
              package_manager: "NonEmptyString",
              file_path: "NonEmptyString",
            },
          ],
          cvss: [
            {
              version: "NonEmptyString",
              base_score: 1.0,
              base_vector: "NonEmptyString",
              source: "NonEmptyString",
              adjustments: [
                {
                  metric: "NonEmptyString",
                  reason: "NonEmptyString",
                },
              ],
            },
          ],
          related_vulnerabilities: ["NonEmptyString"],
          vendor: {
            name: "NonEmptyString", # required
            url: "NonEmptyString",
            vendor_severity: "NonEmptyString",
            vendor_created_at: "NonEmptyString",
            vendor_updated_at: "NonEmptyString",
          },
          reference_urls: ["NonEmptyString"],
        },
      ],
      patch_summary: {
        id: "NonEmptyString", # required
        installed_count: 1,
        missing_count: 1,
        failed_count: 1,
        installed_other_count: 1,
        installed_rejected_count: 1,
        installed_pending_reboot: 1,
        operation_start_time: "NonEmptyString",
        operation_end_time: "NonEmptyString",
        reboot_option: "NonEmptyString",
        operation: "NonEmptyString",
      },
      action: {
        action_type: "NonEmptyString",
        network_connection_action: {
          connection_direction: "NonEmptyString",
          remote_ip_details: {
            ip_address_v4: "NonEmptyString",
            organization: {
              asn: 1,
              asn_org: "NonEmptyString",
              isp: "NonEmptyString",
              org: "NonEmptyString",
            },
            country: {
              country_code: "NonEmptyString",
              country_name: "NonEmptyString",
            },
            city: {
              city_name: "NonEmptyString",
            },
            geo_location: {
              lon: 1.0,
              lat: 1.0,
            },
          },
          remote_port_details: {
            port: 1,
            port_name: "NonEmptyString",
          },
          local_port_details: {
            port: 1,
            port_name: "NonEmptyString",
          },
          protocol: "NonEmptyString",
          blocked: false,
        },
        aws_api_call_action: {
          api: "NonEmptyString",
          service_name: "NonEmptyString",
          caller_type: "NonEmptyString",
          remote_ip_details: {
            ip_address_v4: "NonEmptyString",
            organization: {
              asn: 1,
              asn_org: "NonEmptyString",
              isp: "NonEmptyString",
              org: "NonEmptyString",
            },
            country: {
              country_code: "NonEmptyString",
              country_name: "NonEmptyString",
            },
            city: {
              city_name: "NonEmptyString",
            },
            geo_location: {
              lon: 1.0,
              lat: 1.0,
            },
          },
          domain_details: {
            domain: "NonEmptyString",
          },
          affected_resources: {
            "NonEmptyString" => "NonEmptyString",
          },
          first_seen: "NonEmptyString",
          last_seen: "NonEmptyString",
        },
        dns_request_action: {
          domain: "NonEmptyString",
          protocol: "NonEmptyString",
          blocked: false,
        },
        port_probe_action: {
          port_probe_details: [
            {
              local_port_details: {
                port: 1,
                port_name: "NonEmptyString",
              },
              local_ip_details: {
                ip_address_v4: "NonEmptyString",
              },
              remote_ip_details: {
                ip_address_v4: "NonEmptyString",
                organization: {
                  asn: 1,
                  asn_org: "NonEmptyString",
                  isp: "NonEmptyString",
                  org: "NonEmptyString",
                },
                country: {
                  country_code: "NonEmptyString",
                  country_name: "NonEmptyString",
                },
                city: {
                  city_name: "NonEmptyString",
                },
                geo_location: {
                  lon: 1.0,
                  lat: 1.0,
                },
              },
            },
          ],
          blocked: false,
        },
      },
      finding_provider_fields: {
        confidence: 1,
        criticality: 1,
        related_findings: [
          {
            product_arn: "NonEmptyString", # required
            id: "NonEmptyString", # required
          },
        ],
        severity: {
          label: "INFORMATIONAL", # accepts INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL
          original: "NonEmptyString",
        },
        types: ["NonEmptyString"],
      },
    },
  ],
})

Response structure


resp.failed_count #=> Integer
resp.success_count #=> Integer
resp.failed_findings #=> Array
resp.failed_findings[0].id #=> String
resp.failed_findings[0].error_code #=> String
resp.failed_findings[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



3459
3460
3461
3462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3459

def batch_import_findings(params = {}, options = {})
  req = build_request(:batch_import_findings, params)
  req.send_request(options)
end

#batch_update_findings(params = {}) ⇒ Types::BatchUpdateFindingsResponse

Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.

Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding.

Administrator and member accounts can use BatchUpdateFindings to update the following finding fields and objects.

  • Confidence

  • Criticality

  • Note

  • RelatedFindings

  • Severity

  • Types

  • UserDefinedFields

  • VerificationState

  • Workflow

You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.

Examples:

Request syntax with placeholder values


resp = client.batch_update_findings({
  finding_identifiers: [ # required
    {
      id: "NonEmptyString", # required
      product_arn: "NonEmptyString", # required
    },
  ],
  note: {
    text: "NonEmptyString", # required
    updated_by: "NonEmptyString", # required
  },
  severity: {
    normalized: 1,
    product: 1.0,
    label: "INFORMATIONAL", # accepts INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL
  },
  verification_state: "UNKNOWN", # accepts UNKNOWN, TRUE_POSITIVE, FALSE_POSITIVE, BENIGN_POSITIVE
  confidence: 1,
  criticality: 1,
  types: ["NonEmptyString"],
  user_defined_fields: {
    "NonEmptyString" => "NonEmptyString",
  },
  workflow: {
    status: "NEW", # accepts NEW, NOTIFIED, RESOLVED, SUPPRESSED
  },
  related_findings: [
    {
      product_arn: "NonEmptyString", # required
      id: "NonEmptyString", # required
    },
  ],
})

Response structure


resp.processed_findings #=> Array
resp.processed_findings[0].id #=> String
resp.processed_findings[0].product_arn #=> String
resp.unprocessed_findings #=> Array
resp.unprocessed_findings[0].finding_identifier.id #=> String
resp.unprocessed_findings[0].finding_identifier.product_arn #=> String
resp.unprocessed_findings[0].error_code #=> String
resp.unprocessed_findings[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :finding_identifiers (required, Array<Types::AwsSecurityFindingIdentifier>) —

    The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

    For each finding, the list provides the finding identifier and the ARN of the finding provider.

  • :note (Types::NoteUpdate) —

    The updated note.

  • :severity (Types::SeverityUpdate) —

    Used to update the finding severity.

  • :verification_state (String) —

    Indicates the veracity of a finding.

    The available values for VerificationState are as follows.

    • UNKNOWN – The default disposition of a security finding

    • TRUE_POSITIVE – The security finding is confirmed

    • FALSE_POSITIVE – The security finding was determined to be a false alarm

    • BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

  • :confidence (Integer) —

    The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

    Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

  • :criticality (Integer) —

    The updated value for the level of importance assigned to the resources associated with the findings.

    A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

  • :types (Array<String>) —

    One or more finding types in the format of namespace/category/classifier that classify a finding.

    Valid namespace values are as follows.

    • Software and Configuration Checks

    • TTPs

    • Effects

    • Unusual Behaviors

    • Sensitive Data Identifications

  • :user_defined_fields (Hash<String,String>) —

    A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

  • :workflow (Types::WorkflowUpdate) —

    Used to update the workflow status of a finding.

    The workflow status indicates the progress of the investigation into the finding.

  • :related_findings (Array<Types::RelatedFinding>) —

    A list of findings that are related to the updated findings.

Returns:

See Also:



3631
3632
3633
3634
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3631

def batch_update_findings(params = {}, options = {})
  req = build_request(:batch_update_findings, params)
  req.send_request(options)
end

#create_action_target(params = {}) ⇒ Types::CreateActionTargetResponse

Creates a custom action target in Security Hub.

You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.

Examples:

Request syntax with placeholder values


resp = client.create_action_target({
  name: "NonEmptyString", # required
  description: "NonEmptyString", # required
  id: "NonEmptyString", # required
})

Response structure


resp.action_target_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the custom action target. Can contain up to 20 characters.

  • :description (required, String) —

    The description for the custom action target.

  • :id (required, String) —

    The ID for the custom action target. Can contain up to 20 alphanumeric characters.

Returns:

See Also:



3671
3672
3673
3674
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3671

def create_action_target(params = {}, options = {})
  req = build_request(:create_action_target, params)
  req.send_request(options)
end

#create_finding_aggregator(params = {}) ⇒ Types::CreateFindingAggregatorResponse

Used to enable finding aggregation. Must be called from the aggregation Region.

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_finding_aggregator({
  region_linking_mode: "NonEmptyString", # required
  regions: ["NonEmptyString"],
})

Response structure


resp.finding_aggregator_arn #=> String
resp.finding_aggregation_region #=> String
resp.region_linking_mode #=> String
resp.regions #=> Array
resp.regions[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :region_linking_mode (required, String) —

    Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.

    The selected option also determines how to use the Regions provided in the Regions list.

    The options are as follows:

    • ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.

    • ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.

    • SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

  • :regions (Array<String>) —

    If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.

    If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.

Returns:

See Also:



3745
3746
3747
3748
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3745

def create_finding_aggregator(params = {}, options = {})
  req = build_request(:create_finding_aggregator, params)
  req.send_request(options)
end

#create_insight(params = {}) ⇒ Types::CreateInsightResponse

Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation.

To group the related findings in the insight, use the GroupByAttribute.

Examples:

Request syntax with placeholder values


resp = client.create_insight({
  name: "NonEmptyString", # required
  filters: { # required
    product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    aws_account_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    generator_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    region: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    first_observed_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    last_observed_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    created_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    updated_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    severity_product: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    severity_normalized: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    severity_label: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    confidence: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    criticality: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    title: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    description: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    recommendation_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    product_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, NOT_EQUALS
      },
    ],
    product_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    company_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    user_defined_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, NOT_EQUALS
      },
    ],
    malware_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    malware_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    malware_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    malware_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    network_direction: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    network_protocol: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    network_source_ip_v4: [
      {
        cidr: "NonEmptyString",
      },
    ],
    network_source_ip_v6: [
      {
        cidr: "NonEmptyString",
      },
    ],
    network_source_port: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    network_source_domain: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    network_source_mac: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    network_destination_ip_v4: [
      {
        cidr: "NonEmptyString",
      },
    ],
    network_destination_ip_v6: [
      {
        cidr: "NonEmptyString",
      },
    ],
    network_destination_port: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    network_destination_domain: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    process_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    process_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    process_pid: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    process_parent_pid: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    process_launched_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    process_terminated_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    threat_intel_indicator_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    threat_intel_indicator_value: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    threat_intel_indicator_category: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    threat_intel_indicator_last_observed_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    threat_intel_indicator_source: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    threat_intel_indicator_source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_partition: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_region: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_tags: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_ip_v4_addresses: [
      {
        cidr: "NonEmptyString",
      },
    ],
    resource_aws_ec2_instance_ip_v6_addresses: [
      {
        cidr: "NonEmptyString",
      },
    ],
    resource_aws_ec2_instance_key_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_iam_instance_profile_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_vpc_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_subnet_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_launched_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    resource_aws_s3_bucket_owner_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_s3_bucket_owner_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_iam_access_key_user_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_iam_access_key_principal_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_iam_access_key_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_iam_access_key_created_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    resource_aws_iam_user_user_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_container_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_container_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_container_image_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_container_launched_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    resource_details_other: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, NOT_EQUALS
      },
    ],
    compliance_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    verification_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    workflow_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    workflow_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    record_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    related_findings_product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    related_findings_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    note_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    note_updated_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    note_updated_by: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    keyword: [
      {
        value: "NonEmptyString",
      },
    ],
    finding_provider_fields_confidence: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    finding_provider_fields_criticality: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    finding_provider_fields_related_findings_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    finding_provider_fields_related_findings_product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    finding_provider_fields_severity_label: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    finding_provider_fields_severity_original: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    finding_provider_fields_types: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
  },
  group_by_attribute: "NonEmptyString", # required
})

Response structure


resp.insight_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the custom insight to create.

  • :filters (required, Types::AwsSecurityFindingFilters) —

    One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.

  • :group_by_attribute (required, String) —

    The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.

Returns:

See Also:



4407
4408
4409
4410
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4407

def create_insight(params = {}, options = {})
  req = build_request(:create_insight, params)
  req.send_request(options)
end

#create_members(params = {}) ⇒ Types::CreateMembersResponse

Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.

CreateMembers is always used to add accounts that are not organization members.

For accounts that are managed using Organizations, CreateMembers is only used in the following cases:

  • Security Hub is not configured to automatically add new organization accounts.

  • The account was disassociated or deleted in Security Hub.

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.

For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.

Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.

  • If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.

  • For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.

A permissions policy is added that permits the administrator account to view the findings generated in the member account.

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

Examples:

Request syntax with placeholder values


resp = client.create_members({
  account_details: [ # required
    {
      account_id: "AccountId", # required
      email: "NonEmptyString",
    },
  ],
})

Response structure


resp.unprocessed_accounts #=> Array
resp.unprocessed_accounts[0]. #=> String
resp.unprocessed_accounts[0].processing_result #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_details (required, Array<Types::AccountDetails>) —

    The list of accounts to associate with the Security Hub administrator account. For each account, the list includes the account ID and optionally the email address.

Returns:

See Also:



4491
4492
4493
4494
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4491

def create_members(params = {}, options = {})
  req = build_request(:create_members, params)
  req.send_request(options)
end

#decline_invitations(params = {}) ⇒ Types::DeclineInvitationsResponse

Declines invitations to become a member account.

This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.

Examples:

Request syntax with placeholder values


resp = client.decline_invitations({
  account_ids: ["NonEmptyString"], # required
})

Response structure


resp.unprocessed_accounts #=> Array
resp.unprocessed_accounts[0]. #=> String
resp.unprocessed_accounts[0].processing_result #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_ids (required, Array<String>) —

    The list of account IDs for the accounts from which to decline the invitations to Security Hub.

Returns:

See Also:



4525
4526
4527
4528
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4525

def decline_invitations(params = {}, options = {})
  req = build_request(:decline_invitations, params)
  req.send_request(options)
end

#delete_action_target(params = {}) ⇒ Types::DeleteActionTargetResponse

Deletes a custom action target from Security Hub.

Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.

Examples:

Request syntax with placeholder values


resp = client.delete_action_target({
  action_target_arn: "NonEmptyString", # required
})

Response structure


resp.action_target_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action_target_arn (required, String) —

    The ARN of the custom action target to delete.

Returns:

See Also:



4557
4558
4559
4560
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4557

def delete_action_target(params = {}, options = {})
  req = build_request(:delete_action_target, params)
  req.send_request(options)
end

#delete_finding_aggregator(params = {}) ⇒ Struct

Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.

When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.

Examples:

Request syntax with placeholder values


resp = client.delete_finding_aggregator({
  finding_aggregator_arn: "NonEmptyString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :finding_aggregator_arn (required, String) —

    The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4586
4587
4588
4589
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4586

def delete_finding_aggregator(params = {}, options = {})
  req = build_request(:delete_finding_aggregator, params)
  req.send_request(options)
end

#delete_insight(params = {}) ⇒ Types::DeleteInsightResponse

Deletes the insight specified by the InsightArn.

Examples:

Request syntax with placeholder values


resp = client.delete_insight({
  insight_arn: "NonEmptyString", # required
})

Response structure


resp.insight_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :insight_arn (required, String) —

    The ARN of the insight to delete.

Returns:

See Also:



4614
4615
4616
4617
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4614

def delete_insight(params = {}, options = {})
  req = build_request(:delete_insight, params)
  req.send_request(options)
end

#delete_invitations(params = {}) ⇒ Types::DeleteInvitationsResponse

Deletes invitations received by the Amazon Web Services account to become a member account.

This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.

Examples:

Request syntax with placeholder values


resp = client.delete_invitations({
  account_ids: ["NonEmptyString"], # required
})

Response structure


resp.unprocessed_accounts #=> Array
resp.unprocessed_accounts[0]. #=> String
resp.unprocessed_accounts[0].processing_result #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_ids (required, Array<String>) —

    The list of the account IDs that sent the invitations to delete.

Returns:

See Also:



4648
4649
4650
4651
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4648

def delete_invitations(params = {}, options = {})
  req = build_request(:delete_invitations, params)
  req.send_request(options)
end

#delete_members(params = {}) ⇒ Types::DeleteMembersResponse

Deletes the specified member accounts from Security Hub.

Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually.

Examples:

Request syntax with placeholder values


resp = client.delete_members({
  account_ids: ["NonEmptyString"], # required
})

Response structure


resp.unprocessed_accounts #=> Array
resp.unprocessed_accounts[0]. #=> String
resp.unprocessed_accounts[0].processing_result #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_ids (required, Array<String>) —

    The list of account IDs for the member accounts to delete.

Returns:

See Also:



4681
4682
4683
4684
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4681

def delete_members(params = {}, options = {})
  req = build_request(:delete_members, params)
  req.send_request(options)
end

#describe_action_targets(params = {}) ⇒ Types::DescribeActionTargetsResponse

Returns a list of the custom action targets in Security Hub in your account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_action_targets({
  action_target_arns: ["NonEmptyString"],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.action_targets #=> Array
resp.action_targets[0].action_target_arn #=> String
resp.action_targets[0].name #=> String
resp.action_targets[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action_target_arns (Array<String>) —

    A list of custom action target ARNs for the custom action targets to retrieve.

  • :next_token (String) —

    The token that is required for pagination. On your first call to the DescribeActionTargets operation, set the value of this parameter to NULL.

    For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

  • :max_results (Integer) —

    The maximum number of results to return.

Returns:

See Also:



4732
4733
4734
4735
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4732

def describe_action_targets(params = {}, options = {})
  req = build_request(:describe_action_targets, params)
  req.send_request(options)
end

#describe_hub(params = {}) ⇒ Types::DescribeHubResponse

Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.

Examples:

Request syntax with placeholder values


resp = client.describe_hub({
  hub_arn: "NonEmptyString",
})

Response structure


resp.hub_arn #=> String
resp.subscribed_at #=> String
resp.auto_enable_controls #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :hub_arn (String) —

    The ARN of the Hub resource to retrieve.

Returns:

See Also:



4765
4766
4767
4768
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4765

def describe_hub(params = {}, options = {})
  req = build_request(:describe_hub, params)
  req.send_request(options)
end

#describe_organization_configuration(params = {}) ⇒ Types::DescribeOrganizationConfigurationResponse

Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.

Examples:

Response structure


resp.auto_enable #=> Boolean
resp. #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



4787
4788
4789
4790
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4787

def describe_organization_configuration(params = {}, options = {})
  req = build_request(:describe_organization_configuration, params)
  req.send_request(options)
end

#describe_products(params = {}) ⇒ Types::DescribeProductsResponse

Returns information about product integrations in Security Hub.

You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.

If you do not provide an integration ARN, then the results include all of the available product integrations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_products({
  next_token: "NextToken",
  max_results: 1,
  product_arn: "NonEmptyString",
})

Response structure


resp.products #=> Array
resp.products[0].product_arn #=> String
resp.products[0].product_name #=> String
resp.products[0].company_name #=> String
resp.products[0].description #=> String
resp.products[0].categories #=> Array
resp.products[0].categories[0] #=> String
resp.products[0].integration_types #=> Array
resp.products[0].integration_types[0] #=> String, one of "SEND_FINDINGS_TO_SECURITY_HUB", "RECEIVE_FINDINGS_FROM_SECURITY_HUB", "UPDATE_FINDINGS_IN_SECURITY_HUB"
resp.products[0].marketplace_url #=> String
resp.products[0].activation_url #=> String
resp.products[0].product_subscription_resource_policy #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token that is required for pagination. On your first call to the DescribeProducts operation, set the value of this parameter to NULL.

    For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :product_arn (String) —

    The ARN of the integration to return.

Returns:

See Also:



4850
4851
4852
4853
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4850

def describe_products(params = {}, options = {})
  req = build_request(:describe_products, params)
  req.send_request(options)
end

#describe_standards(params = {}) ⇒ Types::DescribeStandardsResponse

Returns a list of the available standards in Security Hub.

For each standard, the results include the standard ARN, the name, and a description.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_standards({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.standards #=> Array
resp.standards[0].standards_arn #=> String
resp.standards[0].name #=> String
resp.standards[0].description #=> String
resp.standards[0].enabled_by_default #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token that is required for pagination. On your first call to the DescribeStandards operation, set the value of this parameter to NULL.

    For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

  • :max_results (Integer) —

    The maximum number of standards to return.

Returns:

See Also:



4899
4900
4901
4902
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4899

def describe_standards(params = {}, options = {})
  req = build_request(:describe_standards, params)
  req.send_request(options)
end

#describe_standards_controls(params = {}) ⇒ Types::DescribeStandardsControlsResponse

Returns a list of security standards controls.

For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_standards_controls({
  standards_subscription_arn: "NonEmptyString", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.controls #=> Array
resp.controls[0].standards_control_arn #=> String
resp.controls[0].control_status #=> String, one of "ENABLED", "DISABLED"
resp.controls[0].disabled_reason #=> String
resp.controls[0].control_status_updated_at #=> Time
resp.controls[0].control_id #=> String
resp.controls[0].title #=> String
resp.controls[0].description #=> String
resp.controls[0].remediation_url #=> String
resp.controls[0].severity_rating #=> String, one of "LOW", "MEDIUM", "HIGH", "CRITICAL"
resp.controls[0].related_requirements #=> Array
resp.controls[0].related_requirements[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :standards_subscription_arn (required, String) —

    The ARN of a resource that represents your subscription to a supported standard. To get the subscription ARNs of the standards you have enabled, use the GetEnabledStandards operation.

  • :next_token (String) —

    The token that is required for pagination. On your first call to the DescribeStandardsControls operation, set the value of this parameter to NULL.

    For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

  • :max_results (Integer) —

    The maximum number of security standard controls to return.

Returns:

See Also:



4962
4963
4964
4965
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4962

def describe_standards_controls(params = {}, options = {})
  req = build_request(:describe_standards_controls, params)
  req.send_request(options)
end

#disable_import_findings_for_product(params = {}) ⇒ Struct

Disables the integration of the specified product with Security Hub. After the integration is disabled, findings from that product are no longer sent to Security Hub.

Examples:

Request syntax with placeholder values


resp = client.disable_import_findings_for_product({
  product_subscription_arn: "NonEmptyString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :product_subscription_arn (required, String) —

    The ARN of the integrated product to disable the integration for.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4986
4987
4988
4989
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4986

def disable_import_findings_for_product(params = {}, options = {})
  req = build_request(:disable_import_findings_for_product, params)
  req.send_request(options)
end

#disable_organization_admin_account(params = {}) ⇒ Struct

Disables a Security Hub administrator account. Can only be called by the organization management account.

Examples:

Request syntax with placeholder values


resp = client.({
  admin_account_id: "NonEmptyString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :admin_account_id (required, String) —

    The Amazon Web Services account identifier of the Security Hub administrator account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5010
5011
5012
5013
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5010

def (params = {}, options = {})
  req = build_request(:disable_organization_admin_account, params)
  req.send_request(options)
end

#disable_security_hub(params = {}) ⇒ Struct

Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.

When you disable Security Hub for an administrator account, it doesn't disable Security Hub for any associated member accounts.

When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your administrator and member account associations are removed.

If you want to save your existing findings, you must export them before you disable Security Hub.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5036
5037
5038
5039
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5036

def disable_security_hub(params = {}, options = {})
  req = build_request(:disable_security_hub, params)
  req.send_request(options)
end

#disassociate_from_administrator_account(params = {}) ⇒ Struct

Disassociates the current Security Hub member account from the associated administrator account.

This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5054
5055
5056
5057
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5054

def (params = {}, options = {})
  req = build_request(:disassociate_from_administrator_account, params)
  req.send_request(options)
end

#disassociate_from_master_account(params = {}) ⇒ Struct

This method is deprecated. Instead, use DisassociateFromAdministratorAccount.

The Security Hub console continues to use DisassociateFromMasterAccount. It will eventually change to use DisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use DisassociateFromMasterAccount. You should also add DisassociateFromAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use DisassociateFromAdministratorAccount.

Disassociates the current Security Hub member account from the associated administrator account.

This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5084
5085
5086
5087
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5084

def (params = {}, options = {})
  req = build_request(:disassociate_from_master_account, params)
  req.send_request(options)
end

#disassociate_members(params = {}) ⇒ Struct

Disassociates the specified member accounts from the associated administrator account.

Can be used to disassociate both accounts that are managed using Organizations and accounts that were invited manually.

Examples:

Request syntax with placeholder values


resp = client.disassociate_members({
  account_ids: ["NonEmptyString"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_ids (required, Array<String>) —

    The account IDs of the member accounts to disassociate from the administrator account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5111
5112
5113
5114
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5111

def disassociate_members(params = {}, options = {})
  req = build_request(:disassociate_members, params)
  req.send_request(options)
end

#enable_import_findings_for_product(params = {}) ⇒ Types::EnableImportFindingsForProductResponse

Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub.

When you enable a product integration, a permissions policy that grants permission for the product to send findings to Security Hub is applied.

Examples:

Request syntax with placeholder values


resp = client.enable_import_findings_for_product({
  product_arn: "NonEmptyString", # required
})

Response structure


resp.product_subscription_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :product_arn (required, String) —

    The ARN of the product to enable the integration for.

Returns:

See Also:



5144
5145
5146
5147
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5144

def enable_import_findings_for_product(params = {}, options = {})
  req = build_request(:enable_import_findings_for_product, params)
  req.send_request(options)
end

#enable_organization_admin_account(params = {}) ⇒ Struct

Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.

Examples:

Request syntax with placeholder values


resp = client.({
  admin_account_id: "NonEmptyString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :admin_account_id (required, String) —

    The Amazon Web Services account identifier of the account to designate as the Security Hub administrator account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5168
5169
5170
5171
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5168

def (params = {}, options = {})
  req = build_request(:enable_organization_admin_account, params)
  req.send_request(options)
end

#enable_security_hub(params = {}) ⇒ Struct

Enables Security Hub for your account in the current Region or the Region you specify in the request.

When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.

When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the following standards.

  • CIS Amazon Web Services Foundations

  • Amazon Web Services Foundational Security Best Practices

You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard.

To not enable the automatically enabled standards, set EnableDefaultStandards to false.

After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation.

To learn more, see the setup information in the Security Hub User Guide.

Examples:

Request syntax with placeholder values


resp = client.enable_security_hub({
  tags: {
    "TagKey" => "TagValue",
  },
  enable_default_standards: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tags (Hash<String,String>) —

    The tags to add to the hub resource when you enable Security Hub.

  • :enable_default_standards (Boolean) —

    Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for EnableDefaultStandards, it is set to true. To not enable the automatically enabled standards, set EnableDefaultStandards to false.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5229
5230
5231
5232
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5229

def enable_security_hub(params = {}, options = {})
  req = build_request(:enable_security_hub, params)
  req.send_request(options)
end

#get_administrator_account(params = {}) ⇒ Types::GetAdministratorAccountResponse

Provides the details for the Security Hub administrator account for the current member account.

Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.

Examples:

Response structure


resp.administrator. #=> String
resp.administrator.invitation_id #=> String
resp.administrator.invited_at #=> Time
resp.administrator.member_status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



5255
5256
5257
5258
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5255

def (params = {}, options = {})
  req = build_request(:get_administrator_account, params)
  req.send_request(options)
end

#get_enabled_standards(params = {}) ⇒ Types::GetEnabledStandardsResponse

Returns a list of the standards that are currently enabled.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_enabled_standards({
  standards_subscription_arns: ["NonEmptyString"],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.standards_subscriptions #=> Array
resp.standards_subscriptions[0].standards_subscription_arn #=> String
resp.standards_subscriptions[0].standards_arn #=> String
resp.standards_subscriptions[0].standards_input #=> Hash
resp.standards_subscriptions[0].standards_input["NonEmptyString"] #=> String
resp.standards_subscriptions[0].standards_status #=> String, one of "PENDING", "READY", "FAILED", "DELETING", "INCOMPLETE"
resp.standards_subscriptions[0].standards_status_reason.status_reason_code #=> String, one of "NO_AVAILABLE_CONFIGURATION_RECORDER", "INTERNAL_ERROR"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :standards_subscription_arns (Array<String>) —

    The list of the standards subscription ARNs for the standards to retrieve.

  • :next_token (String) —

    The token that is required for pagination. On your first call to the GetEnabledStandards operation, set the value of this parameter to NULL.

    For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

  • :max_results (Integer) —

    The maximum number of results to return in the response.

Returns:

See Also:



5308
5309
5310
5311
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5308

def get_enabled_standards(params = {}, options = {})
  req = build_request(:get_enabled_standards, params)
  req.send_request(options)
end

#get_finding_aggregator(params = {}) ⇒ Types::GetFindingAggregatorResponse

Returns the current finding aggregation configuration.

Examples:

Request syntax with placeholder values


resp = client.get_finding_aggregator({
  finding_aggregator_arn: "NonEmptyString", # required
})

Response structure


resp.finding_aggregator_arn #=> String
resp.finding_aggregation_region #=> String
resp.region_linking_mode #=> String
resp.regions #=> Array
resp.regions[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :finding_aggregator_arn (required, String) —

    The ARN of the finding aggregator to return details for. To obtain the ARN, use ListFindingAggregators.

Returns:

See Also:



5344
5345
5346
5347
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5344

def get_finding_aggregator(params = {}, options = {})
  req = build_request(:get_finding_aggregator, params)
  req.send_request(options)
end

#get_findings(params = {}) ⇒ Types::GetFindingsResponse

Returns a list of findings that match the specified criteria.

If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_findings({
  filters: {
    product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    aws_account_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    generator_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    region: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    first_observed_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    last_observed_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    created_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    updated_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    severity_product: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    severity_normalized: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    severity_label: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    confidence: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    criticality: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    title: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    description: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    recommendation_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    product_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, NOT_EQUALS
      },
    ],
    product_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    company_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    user_defined_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, NOT_EQUALS
      },
    ],
    malware_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    malware_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    malware_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    malware_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    network_direction: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    network_protocol: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    network_source_ip_v4: [
      {
        cidr: "NonEmptyString",
      },
    ],
    network_source_ip_v6: [
      {
        cidr: "NonEmptyString",
      },
    ],
    network_source_port: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    network_source_domain: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    network_source_mac: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    network_destination_ip_v4: [
      {
        cidr: "NonEmptyString",
      },
    ],
    network_destination_ip_v6: [
      {
        cidr: "NonEmptyString",
      },
    ],
    network_destination_port: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    network_destination_domain: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    process_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    process_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    process_pid: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    process_parent_pid: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    process_launched_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    process_terminated_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    threat_intel_indicator_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    threat_intel_indicator_value: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    threat_intel_indicator_category: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    threat_intel_indicator_last_observed_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    threat_intel_indicator_source: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    threat_intel_indicator_source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_partition: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_region: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_tags: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_ip_v4_addresses: [
      {
        cidr: "NonEmptyString",
      },
    ],
    resource_aws_ec2_instance_ip_v6_addresses: [
      {
        cidr: "NonEmptyString",
      },
    ],
    resource_aws_ec2_instance_key_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_iam_instance_profile_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_vpc_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_subnet_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_ec2_instance_launched_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    resource_aws_s3_bucket_owner_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_s3_bucket_owner_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_iam_access_key_user_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_iam_access_key_principal_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_iam_access_key_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_aws_iam_access_key_created_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    resource_aws_iam_user_user_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_container_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_container_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_container_image_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    resource_container_launched_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    resource_details_other: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, NOT_EQUALS
      },
    ],
    compliance_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    verification_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    workflow_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    workflow_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    record_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    related_findings_product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    related_findings_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    note_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    note_updated_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    note_updated_by: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    keyword: [
      {
        value: "NonEmptyString",
      },
    ],
    finding_provider_fields_confidence: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    finding_provider_fields_criticality: [
      {
        gte: 1.0,
        lte: 1.0,
        eq: 1.0,
      },
    ],
    finding_provider_fields_related_findings_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    finding_provider_fields_related_findings_product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    finding_provider_fields_severity_label: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    finding_provider_fields_severity_original: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
    finding_provider_fields_types: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
      },
    ],
  },
  sort_criteria: [
    {
      field: "NonEmptyString",
      sort_order: "asc", # accepts asc, desc
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.findings #=> Array
resp.findings[0].schema_version #=> String
resp.findings[0].id #=> String
resp.findings[0].product_arn #=> String
resp.findings[0].product_name #=> String
resp.findings[0].company_name #=> String
resp.findings[0].region #=> String
resp.findings[0].generator_id #=> String
resp.findings[0]. #=> String
resp.findings[0].types #=> Array
resp.findings[0].types[0] #=> String
resp.findings[0].first_observed_at #=> String
resp.findings[0].last_observed_at #=> String
resp.findings[0].created_at #=> String
resp.findings[0].updated_at #=> String
resp.findings[0].severity.product #=> Float
resp.findings[0].severity.label #=> String, one of "INFORMATIONAL", "LOW", "MEDIUM", "HIGH", "CRITICAL"
resp.findings[0].severity.normalized #=> Integer
resp.findings[0].severity.original #=> String
resp.findings[0].confidence #=> Integer
resp.findings[0].criticality #=> Integer
resp.findings[0].title #=> String
resp.findings[0].description #=> String
resp.findings[0].remediation.recommendation.text #=> String
resp.findings[0].remediation.recommendation.url #=> String
resp.findings[0].source_url #=> String
resp.findings[0].product_fields #=> Hash
resp.findings[0].product_fields["NonEmptyString"] #=> String
resp.findings[0].user_defined_fields #=> Hash
resp.findings[0].user_defined_fields["NonEmptyString"] #=> String
resp.findings[0].malware #=> Array
resp.findings[0].malware[0].name #=> String
resp.findings[0].malware[0].type #=> String, one of "ADWARE", "BLENDED_THREAT", "BOTNET_AGENT", "COIN_MINER", "EXPLOIT_KIT", "KEYLOGGER", "MACRO", "POTENTIALLY_UNWANTED", "SPYWARE", "RANSOMWARE", "REMOTE_ACCESS", "ROOTKIT", "TROJAN", "VIRUS", "WORM"
resp.findings[0].malware[0].path #=> String
resp.findings[0].malware[0].state #=> String, one of "OBSERVED", "REMOVAL_FAILED", "REMOVED"
resp.findings[0].network.direction #=> String, one of "IN", "OUT"
resp.findings[0].network.protocol #=> String
resp.findings[0].network.open_port_range.begin #=> Integer
resp.findings[0].network.open_port_range.end #=> Integer
resp.findings[0].network.source_ip_v4 #=> String
resp.findings[0].network.source_ip_v6 #=> String
resp.findings[0].network.source_port #=> Integer
resp.findings[0].network.source_domain #=> String
resp.findings[0].network.source_mac #=> String
resp.findings[0].network.destination_ip_v4 #=> String
resp.findings[0].network.destination_ip_v6 #=> String
resp.findings[0].network.destination_port #=> Integer
resp.findings[0].network.destination_domain #=> String
resp.findings[0].network_path #=> Array
resp.findings[0].network_path[0].component_id #=> String
resp.findings[0].network_path[0].component_type #=> String
resp.findings[0].network_path[0].egress.protocol #=> String
resp.findings[0].network_path[0].egress.destination.address #=> Array
resp.findings[0].network_path[0].egress.destination.address[0] #=> String
resp.findings[0].network_path[0].egress.destination.port_ranges #=> Array
resp.findings[0].network_path[0].egress.destination.port_ranges[0].begin #=> Integer
resp.findings[0].network_path[0].egress.destination.port_ranges[0].end #=> Integer
resp.findings[0].network_path[0].egress.source.address #=> Array
resp.findings[0].network_path[0].egress.source.address[0] #=> String
resp.findings[0].network_path[0].egress.source.port_ranges #=> Array
resp.findings[0].network_path[0].egress.source.port_ranges[0].begin #=> Integer
resp.findings[0].network_path[0].egress.source.port_ranges[0].end #=> Integer
resp.findings[0].network_path[0].ingress.protocol #=> String
resp.findings[0].network_path[0].ingress.destination.address #=> Array
resp.findings[0].network_path[0].ingress.destination.address[0] #=> String
resp.findings[0].network_path[0].ingress.destination.port_ranges #=> Array
resp.findings[0].network_path[0].ingress.destination.port_ranges[0].begin #=> Integer
resp.findings[0].network_path[0].ingress.destination.port_ranges[0].end #=> Integer
resp.findings[0].network_path[0].ingress.source.address #=> Array
resp.findings[0].network_path[0].ingress.source.address[0] #=> String
resp.findings[0].network_path[0].ingress.source.port_ranges #=> Array
resp.findings[0].network_path[0].ingress.source.port_ranges[0].begin #=> Integer
resp.findings[0].network_path[0].ingress.source.port_ranges[0].end #=> Integer
resp.findings[0].process.name #=> String
resp.findings[0].process.path #=> String
resp.findings[0].process.pid #=> Integer
resp.findings[0].process.parent_pid #=> Integer
resp.findings[0].process.launched_at #=> String
resp.findings[0].process.terminated_at #=> String
resp.findings[0].threat_intel_indicators #=> Array
resp.findings[0].threat_intel_indicators[0].type #=> String, one of "DOMAIN", "EMAIL_ADDRESS", "HASH_MD5", "HASH_SHA1", "HASH_SHA256", "HASH_SHA512", "IPV4_ADDRESS", "IPV6_ADDRESS", "MUTEX", "PROCESS", "URL"
resp.findings[0].threat_intel_indicators[0].value #=> String
resp.findings[0].threat_intel_indicators[0].category #=> String, one of "BACKDOOR", "CARD_STEALER", "COMMAND_AND_CONTROL", "DROP_SITE", "EXPLOIT_SITE", "KEYLOGGER"
resp.findings[0].threat_intel_indicators[0].last_observed_at #=> String
resp.findings[0].threat_intel_indicators[0].source #=> String
resp.findings[0].threat_intel_indicators[0].source_url #=> String
resp.findings[0].resources #=> Array
resp.findings[0].resources[0].type #=> String
resp.findings[0].resources[0].id #=> String
resp.findings[0].resources[0].partition #=> String, one of "aws", "aws-cn", "aws-us-gov"
resp.findings[0].resources[0].region #=> String
resp.findings[0].resources[0].resource_role #=> String
resp.findings[0].resources[0].tags #=> Hash
resp.findings[0].resources[0].tags["NonEmptyString"] #=> String
resp.findings[0].resources[0].data_classification.detailed_results_location #=> String
resp.findings[0].resources[0].data_classification.result.mime_type #=> String
resp.findings[0].resources[0].data_classification.result.size_classified #=> Integer
resp.findings[0].resources[0].data_classification.result.additional_occurrences #=> Boolean
resp.findings[0].resources[0].data_classification.result.status.code #=> String
resp.findings[0].resources[0].data_classification.result.status.reason #=> String
resp.findings[0].resources[0].data_classification.result.sensitive_data #=> Array
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].category #=> String
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections #=> Array
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].count #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].type #=> String
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.line_ranges #=> Array
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.line_ranges[0].start #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.line_ranges[0].end #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.line_ranges[0].start_column #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.offset_ranges #=> Array
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.offset_ranges[0].start #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.offset_ranges[0].end #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.offset_ranges[0].start_column #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.pages #=> Array
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.pages[0].page_number #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.pages[0].line_range.start #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.pages[0].line_range.end #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.pages[0].line_range.start_column #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.pages[0].offset_range.start #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.pages[0].offset_range.end #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.pages[0].offset_range.start_column #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.records #=> Array
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.records[0].json_path #=> String
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.records[0].record_index #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.cells #=> Array
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.cells[0].column #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.cells[0].row #=> Integer
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.cells[0].column_name #=> String
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].detections[0].occurrences.cells[0].cell_reference #=> String
resp.findings[0].resources[0].data_classification.result.sensitive_data[0].total_count #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections #=> Array
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].count #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].arn #=> String
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].name #=> String
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.line_ranges #=> Array
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.line_ranges[0].start #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.line_ranges[0].end #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.line_ranges[0].start_column #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.offset_ranges #=> Array
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.offset_ranges[0].start #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.offset_ranges[0].end #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.offset_ranges[0].start_column #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.pages #=> Array
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.pages[0].page_number #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.pages[0].line_range.start #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.pages[0].line_range.end #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.pages[0].line_range.start_column #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.pages[0].offset_range.start #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.pages[0].offset_range.end #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.pages[0].offset_range.start_column #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.records #=> Array
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.records[0].json_path #=> String
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.records[0].record_index #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.cells #=> Array
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.cells[0].column #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.cells[0].row #=> Integer
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.cells[0].column_name #=> String
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.detections[0].occurrences.cells[0].cell_reference #=> String
resp.findings[0].resources[0].data_classification.result.custom_data_identifiers.total_count #=> Integer
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.launch_configuration_name #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.load_balancer_names #=> Array
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.load_balancer_names[0] #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.health_check_type #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.health_check_grace_period #=> Integer
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.created_time #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.on_demand_allocation_strategy #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.on_demand_base_capacity #=> Integer
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.on_demand_percentage_above_base_capacity #=> Integer
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.spot_allocation_strategy #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.spot_instance_pools #=> Integer
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.instances_distribution.spot_max_price #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.launch_template_specification.launch_template_id #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.launch_template_specification.launch_template_name #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.launch_template_specification.version #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.overrides #=> Array
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.overrides[0].instance_type #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.mixed_instances_policy.launch_template.overrides[0].weighted_capacity #=> String
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.availability_zones #=> Array
resp.findings[0].resources[0].details.aws_auto_scaling_auto_scaling_group.availability_zones[0].value #=> String
resp.findings[0].resources[0].details.aws_code_build_project.encryption_key #=> String
resp.findings[0].resources[0].details.aws_code_build_project.artifacts #=> Array
resp.findings[0].resources[0].details.aws_code_build_project.artifacts[0].artifact_identifier #=> String
resp.findings[0].resources[0].details.aws_code_build_project.artifacts[0].encryption_disabled #=> Boolean
resp.findings[0].resources[0].details<