You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SecurityHub::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::SecurityHub::Client

Includes:

ClientStubs

Defined in:

gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations

• #accept_invitation(params = {}) ⇒ Struct

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

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

  Disables the standards specified by the provided StandardsSubscriptionArns.

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

  Enables the standards specified by the provided StandardsArn.

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

  Imports security findings generated from an integrated third-party product into Security Hub.

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

  Creates a custom action target in Security Hub.

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

  Creates a custom insight in Security Hub.

• #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 master account.

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

  Declines invitations to become a member account.

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

  Deletes a custom action target from Security Hub.

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

  Deletes the insight specified by the InsightArn.

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

  Deletes invitations received by the AWS account to become a member account.

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

  Deletes the specified member accounts from Security Hub.

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

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

• #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.

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

  Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.

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

  Returns a list of the available standards in Security Hub.

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

  Returns a list of security standards controls.

• #disable_import_findings_for_product(params = {}) ⇒ Struct

  Disables the integration of the specified product with Security Hub.

• #disable_security_hub(params = {}) ⇒ Struct

  Disables Security Hub in your account only in the current Region.

• #disassociate_from_master_account(params = {}) ⇒ Struct

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

• #disassociate_members(params = {}) ⇒ Struct

  Disassociates the specified member accounts from the associated master account.

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

  Enables the integration of a partner product with Security Hub.

• #enable_security_hub(params = {}) ⇒ Struct

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

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

  Returns a list of the standards that are currently enabled.

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

  Returns a list of findings that match the specified criteria.

• #get_insight_results(params = {}) ⇒ Types::GetInsightResultsResponse

  Lists the results of the Security Hub insight specified by the insight ARN.

• #get_insights(params = {}) ⇒ Types::GetInsightsResponse

  Lists and describes insights for the specified insight ARNs.

• #get_invitations_count(params = {}) ⇒ Types::GetInvitationsCountResponse

  Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.

• #get_master_account(params = {}) ⇒ Types::GetMasterAccountResponse

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

• #get_members(params = {}) ⇒ Types::GetMembersResponse

  Returns the details for the Security Hub member accounts for the specified account IDs.

• #invite_members(params = {}) ⇒ Types::InviteMembersResponse

  Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from.

• #list_enabled_products_for_import(params = {}) ⇒ Types::ListEnabledProductsForImportResponse

  Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.

• #list_invitations(params = {}) ⇒ Types::ListInvitationsResponse

  Lists all Security Hub membership invitations that were sent to the current AWS account.

• #list_members(params = {}) ⇒ Types::ListMembersResponse

  Lists details about all member accounts for the current Security Hub master account.

• #list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

  Returns a list of tags associated with a resource.

• #tag_resource(params = {}) ⇒ Struct

  Adds one or more tags to a resource.

• #untag_resource(params = {}) ⇒ Struct

  Removes one or more tags from a resource.

• #update_action_target(params = {}) ⇒ Struct

  Updates the name and description of a custom action target in Security Hub.

• #update_findings(params = {}) ⇒ Struct

  Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify.

• #update_insight(params = {}) ⇒ Struct

  Updates the Security Hub insight identified by the specified insight ARN.

• #update_standards_control(params = {}) ⇒ Struct

  Used to control whether an individual security standard control is enabled or disabled.

Instance Method Summary

• #initialize(options) ⇒ Client constructor

  A new instance of Client.

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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

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

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

  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 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
• :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 search 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.

• :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.

• :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 endpoints. This should be avalid 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. Defaults to false.

• :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.

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

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

• :retry_base_delay (Float) — default: 0.3 —

  The base delay in seconds used by the default backoff function.

• :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.

  @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 and auth errors from expired credentials.

• :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.

• :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.

• :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 rasing a Timeout::Error.

• :http_read_timeout (Integer) — default: 60 —

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

• :http_idle_timeout (Float) — default: 5 —

  The number of seconds a connection is allowed to sit idble 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 yeidled by #session_for.

• :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.

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 251

def initialize(*args)
  super
end

Instance Method Details

#accept_invitation(params = {}) ⇒ Struct

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

When the member account accepts the invitation, permission is granted to the master 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 master account that sent the invitation.

• :invitation_id (required, String) —

  The ID of the invitation sent from the Security Hub master account.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 284

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 AWS 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"

Parameters:

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

  ({})

Options Hash (params):

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

  The ARNs of the standards subscriptions to disable.

Returns:

• (Types::BatchDisableStandardsResponse) —

  Returns a response object which responds to the following methods:

  • #standards_subscriptions => Array<Types::StandardsSubscription>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 325

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 AWS 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"

Parameters:

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

  ({})

Options Hash (params):

• :standards_subscription_requests (required, Array<Types::StandardsSubscriptionRequest>) —

  The list of standards checks to enable.

Returns:

• (Types::BatchEnableStandardsResponse) —

  Returns a response object which responds to the following methods:

  • #standards_subscriptions => Array<Types::StandardsSubscription>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 374

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 from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.

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

Examples:

Request syntax with placeholder values

resp = client.batch_import_findings({
  findings: [ # required
    {
      schema_version: "NonEmptyString", # required
      id: "NonEmptyString", # required
      product_arn: "NonEmptyString", # required
      generator_id: "NonEmptyString", # required
      aws_account_id: "NonEmptyString", # required
      types: ["NonEmptyString"], # required
      first_observed_at: "NonEmptyString",
      last_observed_at: "NonEmptyString",
      created_at: "NonEmptyString", # required
      updated_at: "NonEmptyString", # required
      severity: { # required
        product: 1.0,
        normalized: 1, # required
      },
      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",
        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",
      },
      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",
          tags: {
            "NonEmptyString" => "NonEmptyString",
          },
          details: {
            aws_code_build_project: {
              encryption_key: "NonEmptyString",
              environment: {
                certificate: "NonEmptyString",
                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",
              vpc_config: {
                vpc_id: "NonEmptyString",
                subnets: ["NonEmptyString"],
                security_group_ids: ["NonEmptyString"],
              },
            },
            aws_cloud_front_distribution: {
              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",
                  },
                ],
              },
              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",
            },
            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,
            },
            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_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",
            },
            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",
              encryption_at_rest_options: {
                enabled: false,
                kms_key_id: "NonEmptyString",
              },
              node_to_node_encryption_options: {
                enabled: false,
              },
              vpc_options: {
                availability_zones: ["NonEmptyString"],
                security_group_ids: ["NonEmptyString"],
                subnet_ids: ["NonEmptyString"],
                vpc_id: "NonEmptyString",
              },
            },
            aws_s3_bucket: {
              owner_id: "NonEmptyString",
              owner_name: "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",
            },
            aws_iam_role: {
              assume_role_policy_document: "AwsIamRoleAssumeRolePolicyDocument",
              create_date: "NonEmptyString",
              role_id: "NonEmptyString",
              role_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",
            },
            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",
                },
              ],
            },
            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",
            },
            container: {
              name: "NonEmptyString",
              image_id: "NonEmptyString",
              image_name: "NonEmptyString",
              launched_at: "NonEmptyString",
            },
            other: {
              "NonEmptyString" => "NonEmptyString",
            },
          },
        },
      ],
      compliance: {
        status: "PASSED", # accepts PASSED, WARNING, FAILED, NOT_AVAILABLE
        related_requirements: ["NonEmptyString"],
      },
      verification_state: "UNKNOWN", # accepts UNKNOWN, TRUE_POSITIVE, FALSE_POSITIVE, BENIGN_POSITIVE
      workflow_state: "NEW", # accepts NEW, ASSIGNED, IN_PROGRESS, DEFERRED, RESOLVED
      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
      },
    },
  ],
})

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):

• :findings (required, Array<Types::AwsSecurityFinding>) —

  A list of findings to import. To successfully import a finding, it must follow the AWS Security Finding Format. Maximum of 100 findings per request.

Returns:

• (Types::BatchImportFindingsResponse) —

  Returns a response object which responds to the following methods:

  • #failed_count => Integer
  • #success_count => Integer
  • #failed_findings => Array<Types::ImportFindingsError>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 882

def batch_import_findings(params = {}, options = {})
  req = build_request(:batch_import_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.

• :description (required, String) —

  The description for the custom action target.

• :id (required, String) —

  The ID for the custom action target.

Returns:

• (Types::CreateActionTargetResponse) —

  Returns a response object which responds to the following methods:

  • #action_target_arn => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 921

def create_action_target(params = {}, options = {})
  req = build_request(:create_action_target, 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
      },
    ],
    aws_account_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    generator_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    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
      },
    ],
    description: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    recommendation_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    product_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    product_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    company_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    user_defined_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    malware_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    network_direction: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    network_protocol: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    network_source_mac: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    process_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    process_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    threat_intel_indicator_value: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    threat_intel_indicator_category: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    threat_intel_indicator_source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_partition: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_region: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_tags: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    resource_aws_ec2_instance_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    resource_aws_ec2_instance_iam_instance_profile_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_vpc_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_subnet_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    resource_aws_s3_bucket_owner_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_user_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_created_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    resource_container_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_container_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_container_image_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    compliance_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    verification_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    workflow_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    record_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    related_findings_product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    related_findings_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    note_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    keyword: [
      {
        value: "NonEmptyString",
      },
    ],
  },
  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 as the aggregator to group related findings for the insight.

Returns:

• (Types::CreateInsightResponse) —

  Returns a response object which responds to the following methods:

  • #insight_arn => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1513

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 master account. To successfully create a member, you must use this action from an account that already has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.

After you use CreateMembers to create member account associations in Security Hub, you must use the InviteMembers operation to invite the accounts to enable Security Hub and become member accounts in Security Hub.

If the account owner accepts the invitation, the account becomes a member account in Security Hub, and a permission policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in the invited account, findings start to be sent to both the member and master accounts.

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

Examples:

Request syntax with placeholder values

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

Response structure

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

Parameters:

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

  ({})

Options Hash (params):

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

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

Returns:

• (Types::CreateMembersResponse) —

  Returns a response object which responds to the following methods:

  • #unprocessed_accounts => Array<Types::Result>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1569

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.

Examples:

Request syntax with placeholder values

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

Response structure

resp.unprocessed_accounts #=> Array
resp.unprocessed_accounts[0].account_id #=> 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:

• (Types::DeclineInvitationsResponse) —

  Returns a response object which responds to the following methods:

  • #unprocessed_accounts => Array<Types::Result>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1600

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:

• (Types::DeleteActionTargetResponse) —

  Returns a response object which responds to the following methods:

  • #action_target_arn => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1632

def delete_action_target(params = {}, options = {})
  req = build_request(:delete_action_target, 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:

• (Types::DeleteInsightResponse) —

  Returns a response object which responds to the following methods:

  • #insight_arn => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1660

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 AWS account to become a member account.

Examples:

Request syntax with placeholder values

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

Response structure

resp.unprocessed_accounts #=> Array
resp.unprocessed_accounts[0].account_id #=> 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:

• (Types::DeleteInvitationsResponse) —

  Returns a response object which responds to the following methods:

  • #unprocessed_accounts => Array<Types::Result>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1691

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.

Examples:

Request syntax with placeholder values

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

Response structure

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

Parameters:

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

  ({})

Options Hash (params):

• :account_ids (Array<String>) —

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

Returns:

• (Types::DeleteMembersResponse) —

  Returns a response object which responds to the following methods:

  • #unprocessed_accounts => Array<Types::Result>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1721

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.

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:

• (Types::DescribeActionTargetsResponse) —

  Returns a response object which responds to the following methods:

  • #action_targets => Array<Types::ActionTarget>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1770

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

Parameters:

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

  ({})

Options Hash (params):

• :hub_arn (String) —

  The ARN of the Hub resource to retrieve.

Returns:

• (Types::DescribeHubResponse) —

  Returns a response object which responds to the following methods:

  • #hub_arn => String
  • #subscribed_at => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1801

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

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

Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.

Examples:

Request syntax with placeholder values

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

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"
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.

Returns:

• (Types::DescribeProductsResponse) —

  Returns a response object which responds to the following methods:

  • #products => Array<Types::Product>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1854

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.

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.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:

• (Types::DescribeStandardsResponse) —

  Returns a response object which responds to the following methods:

  • #standards => Array<Types::Standard>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1900

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.

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.

• :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:

• (Types::DescribeStandardsControlsResponse) —

  Returns a response object which responds to the following methods:

  • #controls => Array<Types::StandardsControl>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1960

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:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1984

def disable_import_findings_for_product(params = {}, options = {})
  req = build_request(:disable_import_findings_for_product, 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 a master 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 master 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:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2010

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

#disassociate_from_master_account(params = {}) ⇒ Struct

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

Parameters:

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

  ({})

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2024

def disassociate_from_master_account(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 master account.

Examples:

Request syntax with placeholder values

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

Parameters:

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

  ({})

Options Hash (params):

• :account_ids (Array<String>) —

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

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2048

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 permission 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:

• (Types::EnableImportFindingsForProductResponse) —

  Returns a response object which responds to the following methods:

  • #product_subscription_arn => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2081

def enable_import_findings_for_product(params = {}, options = {})
  req = build_request(:enable_import_findings_for_product, 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 AWS Config, Amazon GuardDuty, Amazon Inspector, and Amazon Macie.

When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the CIS AWS Foundations standard. You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. To enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation.

To learn more, see Setting Up AWS Security Hub in the AWS Security Hub User Guide.

Examples:

Request syntax with placeholder values

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

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.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2124

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

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

Returns a list of the standards that are currently enabled.

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.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:

• (Types::GetEnabledStandardsResponse) —

  Returns a response object which responds to the following methods:

  • #standards_subscriptions => Array<Types::StandardsSubscription>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2174

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

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

Returns a list of findings that match the specified criteria.

Examples:

Request syntax with placeholder values

resp = client.get_findings({
  filters: {
    product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    aws_account_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    generator_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    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
      },
    ],
    description: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    recommendation_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    product_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    product_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    company_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    user_defined_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    malware_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    network_direction: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    network_protocol: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    network_source_mac: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    process_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    process_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    threat_intel_indicator_value: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    threat_intel_indicator_category: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    threat_intel_indicator_source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_partition: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_region: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_tags: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    resource_aws_ec2_instance_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    resource_aws_ec2_instance_iam_instance_profile_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_vpc_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_subnet_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    resource_aws_s3_bucket_owner_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_user_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_created_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    resource_container_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_container_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_container_image_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    compliance_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    verification_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    workflow_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    record_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    related_findings_product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    related_findings_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    note_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    keyword: [
      {
        value: "NonEmptyString",
      },
    ],
  },
  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].generator_id #=> String
resp.findings[0].aws_account_id #=> 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.normalized #=> Integer
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.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].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].tags #=> Hash
resp.findings[0].resources[0].tags["NonEmptyString"] #=> String
resp.findings[0].resources[0].details.aws_code_build_project.encryption_key #=> String
resp.findings[0].resources[0].details.aws_code_build_project.environment.certificate #=> String
resp.findings[0].resources[0].details.aws_code_build_project.environment.image_pull_credentials_type #=> String
resp.findings[0].resources[0].details.aws_code_build_project.environment.registry_credential.credential #=> String
resp.findings[0].resources[0].details.aws_code_build_project.environment.registry_credential.credential_provider #=> String
resp.findings[0].resources[0].details.aws_code_build_project.environment.type #=> String
resp.findings[0].resources[0].details.aws_code_build_project.name #=> String
resp.findings[0].resources[0].details.aws_code_build_project.source.type #=> String
resp.findings[0].resources[0].details.aws_code_build_project.source.location #=> String
resp.findings[0].resources[0].details.aws_code_build_project.source.git_clone_depth #=> Integer
resp.findings[0].resources[0].details.aws_code_build_project.source.insecure_ssl #=> Boolean
resp.findings[0].resources[0].details.aws_code_build_project.service_role #=> String
resp.findings[0].resources[0].details.aws_code_build_project.vpc_config.vpc_id #=> String
resp.findings[0].resources[0].details.aws_code_build_project.vpc_config.subnets #=> Array
resp.findings[0].resources[0].details.aws_code_build_project.vpc_config.subnets[0] #=> String
resp.findings[0].resources[0].details.aws_code_build_project.vpc_config.security_group_ids #=> Array
resp.findings[0].resources[0].details.aws_code_build_project.vpc_config.security_group_ids[0] #=> String
resp.findings[0].resources[0].details.aws_cloud_front_distribution.domain_name #=> String
resp.findings[0].resources[0].details.aws_cloud_front_distribution.etag #=> String
resp.findings[0].resources[0].details.aws_cloud_front_distribution.last_modified_time #=> String
resp.findings[0].resources[0].details.aws_cloud_front_distribution.logging.bucket #=> String
resp.findings[0].resources[0].details.aws_cloud_front_distribution.logging.enabled #=> Boolean
resp.findings[0].resources[0].details.aws_cloud_front_distribution.logging.include_cookies #=> Boolean
resp.findings[0].resources[0].details.aws_cloud_front_distribution.logging.prefix #=> String
resp.findings[0].resources[0].details.aws_cloud_front_distribution.origins.items #=> Array
resp.findings[0].resources[0].details.aws_cloud_front_distribution.origins.items[0].domain_name #=> String
resp.findings[0].resources[0].details.aws_cloud_front_distribution.origins.items[0].id #=> String
resp.findings[0].resources[0].details.aws_cloud_front_distribution.origins.items[0].origin_path #=> String
resp.findings[0].resources[0].details.aws_cloud_front_distribution.status #=> String
resp.findings[0].resources[0].details.aws_cloud_front_distribution.web_acl_id #=> String
resp.findings[0].resources[0].details.aws_ec2_instance.type #=> String
resp.findings[0].resources[0].details.aws_ec2_instance.image_id #=> String
resp.findings[0].resources[0].details.aws_ec2_instance.ip_v4_addresses #=> Array
resp.findings[0].resources[0].details.aws_ec2_instance.ip_v4_addresses[0] #=> String
resp.findings[0].resources[0].details.aws_ec2_instance.ip_v6_addresses #=> Array
resp.findings[0].resources[0].details.aws_ec2_instance.ip_v6_addresses[0] #=> String
resp.findings[0].resources[0].details.aws_ec2_instance.key_name #=> String
resp.findings[0].resources[0].details.aws_ec2_instance.iam_instance_profile_arn #=> String
resp.findings[0].resources[0].details.aws_ec2_instance.vpc_id #=> String
resp.findings[0].resources[0].details.aws_ec2_instance.subnet_id #=> String
resp.findings[0].resources[0].details.aws_ec2_instance.launched_at #=> String
resp.findings[0].resources[0].details.aws_ec2_network_interface.attachment.attach_time #=> String
resp.findings[0].resources[0].details.aws_ec2_network_interface.attachment.attachment_id #=> String
resp.findings[0].resources[0].details.aws_ec2_network_interface.attachment.delete_on_termination #=> Boolean
resp.findings[0].resources[0].details.aws_ec2_network_interface.attachment.device_index #=> Integer
resp.findings[0].resources[0].details.aws_ec2_network_interface.attachment.instance_id #=> String
resp.findings[0].resources[0].details.aws_ec2_network_interface.attachment.instance_owner_id #=> String
resp.findings[0].resources[0].details.aws_ec2_network_interface.attachment.status #=> String
resp.findings[0].resources[0].details.aws_ec2_network_interface.network_interface_id #=> String
resp.findings[0].resources[0].details.aws_ec2_network_interface.security_groups #=> Array
resp.findings[0].resources[0].details.aws_ec2_network_interface.security_groups[0].group_name #=> String
resp.findings[0].resources[0].details.aws_ec2_network_interface.security_groups[0].group_id #=> String
resp.findings[0].resources[0].details.aws_ec2_network_interface.source_dest_check #=> Boolean
resp.findings[0].resources[0].details.aws_ec2_security_group.group_name #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.group_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.owner_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.vpc_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions #=> Array
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].ip_protocol #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].from_port #=> Integer
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].to_port #=> Integer
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].user_id_group_pairs #=> Array
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].user_id_group_pairs[0].group_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].user_id_group_pairs[0].group_name #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].user_id_group_pairs[0].peering_status #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].user_id_group_pairs[0].user_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].user_id_group_pairs[0].vpc_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].user_id_group_pairs[0].vpc_peering_connection_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].ip_ranges #=> Array
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].ip_ranges[0].cidr_ip #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].ipv_6_ranges #=> Array
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].ipv_6_ranges[0].cidr_ipv_6 #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].prefix_list_ids #=> Array
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions[0].prefix_list_ids[0].prefix_list_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress #=> Array
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].ip_protocol #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].from_port #=> Integer
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].to_port #=> Integer
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].user_id_group_pairs #=> Array
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].user_id_group_pairs[0].group_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].user_id_group_pairs[0].group_name #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].user_id_group_pairs[0].peering_status #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].user_id_group_pairs[0].user_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].user_id_group_pairs[0].vpc_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].user_id_group_pairs[0].vpc_peering_connection_id #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].ip_ranges #=> Array
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].ip_ranges[0].cidr_ip #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].ipv_6_ranges #=> Array
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].ipv_6_ranges[0].cidr_ipv_6 #=> String
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].prefix_list_ids #=> Array
resp.findings[0].resources[0].details.aws_ec2_security_group.ip_permissions_egress[0].prefix_list_ids[0].prefix_list_id #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.availability_zones #=> Array
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.availability_zones[0].zone_name #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.availability_zones[0].subnet_id #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.canonical_hosted_zone_id #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.created_time #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.dns_name #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.ip_address_type #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.scheme #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.security_groups #=> Array
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.security_groups[0] #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.state.code #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.state.reason #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.type #=> String
resp.findings[0].resources[0].details.aws_elbv_2_load_balancer.vpc_id #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.access_policies #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.domain_endpoint_options.enforce_https #=> Boolean
resp.findings[0].resources[0].details.aws_elasticsearch_domain.domain_endpoint_options.tls_security_policy #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.domain_id #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.domain_name #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.endpoint #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.endpoints #=> Hash
resp.findings[0].resources[0].details.aws_elasticsearch_domain.endpoints["NonEmptyString"] #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.elasticsearch_version #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.encryption_at_rest_options.enabled #=> Boolean
resp.findings[0].resources[0].details.aws_elasticsearch_domain.encryption_at_rest_options.kms_key_id #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.node_to_node_encryption_options.enabled #=> Boolean
resp.findings[0].resources[0].details.aws_elasticsearch_domain.vpc_options.availability_zones #=> Array
resp.findings[0].resources[0].details.aws_elasticsearch_domain.vpc_options.availability_zones[0] #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.vpc_options.security_group_ids #=> Array
resp.findings[0].resources[0].details.aws_elasticsearch_domain.vpc_options.security_group_ids[0] #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.vpc_options.subnet_ids #=> Array
resp.findings[0].resources[0].details.aws_elasticsearch_domain.vpc_options.subnet_ids[0] #=> String
resp.findings[0].resources[0].details.aws_elasticsearch_domain.vpc_options.vpc_id #=> String
resp.findings[0].resources[0].details.aws_s3_bucket.owner_id #=> String
resp.findings[0].resources[0].details.aws_s3_bucket.owner_name #=> String
resp.findings[0].resources[0].details.aws_iam_access_key.user_name #=> String
resp.findings[0].resources[0].details.aws_iam_access_key.status #=> String, one of "Active", "Inactive"
resp.findings[0].resources[0].details.aws_iam_access_key.created_at #=> String
resp.findings[0].resources[0].details.aws_iam_access_key.principal_id #=> String
resp.findings[0].resources[0].details.aws_iam_access_key.principal_type #=> String
resp.findings[0].resources[0].details.aws_iam_access_key.principal_name #=> String
resp.findings[0].resources[0].details.aws_iam_role.assume_role_policy_document #=> String
resp.findings[0].resources[0].details.aws_iam_role.create_date #=> String
resp.findings[0].resources[0].details.aws_iam_role.role_id #=> String
resp.findings[0].resources[0].details.aws_iam_role.role_name #=> String
resp.findings[0].resources[0].details.aws_iam_role.max_session_duration #=> Integer
resp.findings[0].resources[0].details.aws_iam_role.path #=> String
resp.findings[0].resources[0].details.aws_kms_key.aws_account_id #=> String
resp.findings[0].resources[0].details.aws_kms_key.creation_date #=> Float
resp.findings[0].resources[0].details.aws_kms_key.key_id #=> String
resp.findings[0].resources[0].details.aws_kms_key.key_manager #=> String
resp.findings[0].resources[0].details.aws_kms_key.key_state #=> String
resp.findings[0].resources[0].details.aws_kms_key.origin #=> String
resp.findings[0].resources[0].details.aws_lambda_function.code.s3_bucket #=> String
resp.findings[0].resources[0].details.aws_lambda_function.code.s3_key #=> String
resp.findings[0].resources[0].details.aws_lambda_function.code.s3_object_version #=> String
resp.findings[0].resources[0].details.aws_lambda_function.code.zip_file #=> String
resp.findings[0].resources[0].details.aws_lambda_function.code_sha_256 #=> String
resp.findings[0].resources[0].details.aws_lambda_function.dead_letter_config.target_arn #=> String
resp.findings[0].resources[0].details.aws_lambda_function.environment.variables #=> Hash
resp.findings[0].resources[0].details.aws_lambda_function.environment.variables["NonEmptyString"] #=> String
resp.findings[0].resources[0].details.aws_lambda_function.environment.error.error_code #=> String
resp.findings[0].resources[0].details.aws_lambda_function.environment.error.message #=> String
resp.findings[0].resources[0].details.aws_lambda_function.function_name #=> String
resp.findings[0].resources[0].details.aws_lambda_function.handler #=> String
resp.findings[0].resources[0].details.aws_lambda_function.kms_key_arn #=> String
resp.findings[0].resources[0].details.aws_lambda_function.last_modified #=> String
resp.findings[0].resources[0].details.aws_lambda_function.layers #=> Array
resp.findings[0].resources[0].details.aws_lambda_function.layers[0].arn #=> String
resp.findings[0].resources[0].details.aws_lambda_function.layers[0].code_size #=> Integer
resp.findings[0].resources[0].details.aws_lambda_function.master_arn #=> String
resp.findings[0].resources[0].details.aws_lambda_function.memory_size #=> Integer
resp.findings[0].resources[0].details.aws_lambda_function.revision_id #=> String
resp.findings[0].resources[0].details.aws_lambda_function.role #=> String
resp.findings[0].resources[0].details.aws_lambda_function.runtime #=> String
resp.findings[0].resources[0].details.aws_lambda_function.timeout #=> Integer
resp.findings[0].resources[0].details.aws_lambda_function.tracing_config.mode #=> String
resp.findings[0].resources[0].details.aws_lambda_function.vpc_config.security_group_ids #=> Array
resp.findings[0].resources[0].details.aws_lambda_function.vpc_config.security_group_ids[0] #=> String
resp.findings[0].resources[0].details.aws_lambda_function.vpc_config.subnet_ids #=> Array
resp.findings[0].resources[0].details.aws_lambda_function.vpc_config.subnet_ids[0] #=> String
resp.findings[0].resources[0].details.aws_lambda_function.vpc_config.vpc_id #=> String
resp.findings[0].resources[0].details.aws_lambda_function.version #=> String
resp.findings[0].resources[0].details.aws_lambda_layer_version.version #=> Integer
resp.findings[0].resources[0].details.aws_lambda_layer_version.compatible_runtimes #=> Array
resp.findings[0].resources[0].details.aws_lambda_layer_version.compatible_runtimes[0] #=> String
resp.findings[0].resources[0].details.aws_lambda_layer_version.created_date #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.associated_roles #=> Array
resp.findings[0].resources[0].details.aws_rds_db_instance.associated_roles[0].role_arn #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.associated_roles[0].feature_name #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.associated_roles[0].status #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.ca_certificate_identifier #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.db_cluster_identifier #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.db_instance_identifier #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.db_instance_class #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.db_instance_port #=> Integer
resp.findings[0].resources[0].details.aws_rds_db_instance.dbi_resource_id #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.db_name #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.deletion_protection #=> Boolean
resp.findings[0].resources[0].details.aws_rds_db_instance.endpoint.address #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.endpoint.port #=> Integer
resp.findings[0].resources[0].details.aws_rds_db_instance.endpoint.hosted_zone_id #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.engine #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.engine_version #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.iam_database_authentication_enabled #=> Boolean
resp.findings[0].resources[0].details.aws_rds_db_instance.instance_create_time #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.kms_key_id #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.publicly_accessible #=> Boolean
resp.findings[0].resources[0].details.aws_rds_db_instance.storage_encrypted #=> Boolean
resp.findings[0].resources[0].details.aws_rds_db_instance.tde_credential_arn #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.vpc_security_groups #=> Array
resp.findings[0].resources[0].details.aws_rds_db_instance.vpc_security_groups[0].vpc_security_group_id #=> String
resp.findings[0].resources[0].details.aws_rds_db_instance.vpc_security_groups[0].status #=> String
resp.findings[0].resources[0].details.aws_sns_topic.kms_master_key_id #=> String
resp.findings[0].resources[0].details.aws_sns_topic.subscription #=> Array
resp.findings[0].resources[0].details.aws_sns_topic.subscription[0].endpoint #=> String
resp.findings[0].resources[0].details.aws_sns_topic.subscription[0].protocol #=> String
resp.findings[0].resources[0].details.aws_sns_topic.topic_name #=> String
resp.findings[0].resources[0].details.aws_sns_topic.owner #=> String
resp.findings[0].resources[0].details.aws_sqs_queue.kms_data_key_reuse_period_seconds #=> Integer
resp.findings[0].resources[0].details.aws_sqs_queue.kms_master_key_id #=> String
resp.findings[0].resources[0].details.aws_sqs_queue.queue_name #=> String
resp.findings[0].resources[0].details.aws_sqs_queue.dead_letter_target_arn #=> String
resp.findings[0].resources[0].details.aws_waf_web_acl.name #=> String
resp.findings[0].resources[0].details.aws_waf_web_acl.default_action #=> String
resp.findings[0].resources[0].details.aws_waf_web_acl.rules #=> Array
resp.findings[0].resources[0].details.aws_waf_web_acl.rules[0].action.type #=> String
resp.findings[0].resources[0].details.aws_waf_web_acl.rules[0].excluded_rules #=> Array
resp.findings[0].resources[0].details.aws_waf_web_acl.rules[0].excluded_rules[0].rule_id #=> String
resp.findings[0].resources[0].details.aws_waf_web_acl.rules[0].override_action.type #=> String
resp.findings[0].resources[0].details.aws_waf_web_acl.rules[0].priority #=> Integer
resp.findings[0].resources[0].details.aws_waf_web_acl.rules[0].rule_id #=> String
resp.findings[0].resources[0].details.aws_waf_web_acl.rules[0].type #=> String
resp.findings[0].resources[0].details.aws_waf_web_acl.web_acl_id #=> String
resp.findings[0].resources[0].details.container.name #=> String
resp.findings[0].resources[0].details.container.image_id #=> String
resp.findings[0].resources[0].details.container.image_name #=> String
resp.findings[0].resources[0].details.container.launched_at #=> String
resp.findings[0].resources[0].details.other #=> Hash
resp.findings[0].resources[0].details.other["NonEmptyString"] #=> String
resp.findings[0].compliance.status #=> String, one of "PASSED", "WARNING", "FAILED", "NOT_AVAILABLE"
resp.findings[0].compliance.related_requirements #=> Array
resp.findings[0].compliance.related_requirements[0] #=> String
resp.findings[0].verification_state #=> String, one of "UNKNOWN", "TRUE_POSITIVE", "FALSE_POSITIVE", "BENIGN_POSITIVE"
resp.findings[0].workflow_state #=> String, one of "NEW", "ASSIGNED", "IN_PROGRESS", "DEFERRED", "RESOLVED"
resp.findings[0].record_state #=> String, one of "ACTIVE", "ARCHIVED"
resp.findings[0].related_findings #=> Array
resp.findings[0].related_findings[0].product_arn #=> String
resp.findings[0].related_findings[0].id #=> String
resp.findings[0].note.text #=> String
resp.findings[0].note.updated_by #=> String
resp.findings[0].note.updated_at #=> String
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :filters (Types::AwsSecurityFindingFilters) —

  The finding attributes used to define a condition to filter the returned findings.

• :sort_criteria (Array<Types::SortCriterion>) —

  The finding attributes used to sort the list of returned findings.

• :next_token (String) —

  The token that is required for pagination. On your first call to the GetFindings 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 findings to return.

Returns:

• (Types::GetFindingsResponse) —

  Returns a response object which responds to the following methods:

  • #findings => Array<Types::AwsSecurityFinding>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3078

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

#get_insight_results(params = {}) ⇒ Types::GetInsightResultsResponse

Lists the results of the Security Hub insight specified by the insight ARN.

Examples:

Request syntax with placeholder values

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

Response structure

resp.insight_results.insight_arn #=> String
resp.insight_results.group_by_attribute #=> String
resp.insight_results.result_values #=> Array
resp.insight_results.result_values[0].group_by_attribute_value #=> String
resp.insight_results.result_values[0].count #=> Integer

Parameters:

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

  ({})

Options Hash (params):

• :insight_arn (required, String) —

  The ARN of the insight for which to return results.

Returns:

• (Types::GetInsightResultsResponse) —

  Returns a response object which responds to the following methods:

  • #insight_results => Types::InsightResults

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3111

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

#get_insights(params = {}) ⇒ Types::GetInsightsResponse

Lists and describes insights for the specified insight ARNs.

Examples:

Request syntax with placeholder values

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

Response structure

resp.insights #=> Array
resp.insights[0].insight_arn #=> String
resp.insights[0].name #=> String
resp.insights[0].filters.product_arn #=> Array
resp.insights[0].filters.product_arn[0].value #=> String
resp.insights[0].filters.product_arn[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.aws_account_id #=> Array
resp.insights[0].filters.aws_account_id[0].value #=> String
resp.insights[0].filters.aws_account_id[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.id #=> Array
resp.insights[0].filters.id[0].value #=> String
resp.insights[0].filters.id[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.generator_id #=> Array
resp.insights[0].filters.generator_id[0].value #=> String
resp.insights[0].filters.generator_id[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.type #=> Array
resp.insights[0].filters.type[0].value #=> String
resp.insights[0].filters.type[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.first_observed_at #=> Array
resp.insights[0].filters.first_observed_at[0].start #=> String
resp.insights[0].filters.first_observed_at[0].end #=> String
resp.insights[0].filters.first_observed_at[0].date_range.value #=> Integer
resp.insights[0].filters.first_observed_at[0].date_range.unit #=> String, one of "DAYS"
resp.insights[0].filters.last_observed_at #=> Array
resp.insights[0].filters.last_observed_at[0].start #=> String
resp.insights[0].filters.last_observed_at[0].end #=> String
resp.insights[0].filters.last_observed_at[0].date_range.value #=> Integer
resp.insights[0].filters.last_observed_at[0].date_range.unit #=> String, one of "DAYS"
resp.insights[0].filters.created_at #=> Array
resp.insights[0].filters.created_at[0].start #=> String
resp.insights[0].filters.created_at[0].end #=> String
resp.insights[0].filters.created_at[0].date_range.value #=> Integer
resp.insights[0].filters.created_at[0].date_range.unit #=> String, one of "DAYS"
resp.insights[0].filters.updated_at #=> Array
resp.insights[0].filters.updated_at[0].start #=> String
resp.insights[0].filters.updated_at[0].end #=> String
resp.insights[0].filters.updated_at[0].date_range.value #=> Integer
resp.insights[0].filters.updated_at[0].date_range.unit #=> String, one of "DAYS"
resp.insights[0].filters.severity_product #=> Array
resp.insights[0].filters.severity_product[0].gte #=> Float
resp.insights[0].filters.severity_product[0].lte #=> Float
resp.insights[0].filters.severity_product[0].eq #=> Float
resp.insights[0].filters.severity_normalized #=> Array
resp.insights[0].filters.severity_normalized[0].gte #=> Float
resp.insights[0].filters.severity_normalized[0].lte #=> Float
resp.insights[0].filters.severity_normalized[0].eq #=> Float
resp.insights[0].filters.severity_label #=> Array
resp.insights[0].filters.severity_label[0].value #=> String
resp.insights[0].filters.severity_label[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.confidence #=> Array
resp.insights[0].filters.confidence[0].gte #=> Float
resp.insights[0].filters.confidence[0].lte #=> Float
resp.insights[0].filters.confidence[0].eq #=> Float
resp.insights[0].filters.criticality #=> Array
resp.insights[0].filters.criticality[0].gte #=> Float
resp.insights[0].filters.criticality[0].lte #=> Float
resp.insights[0].filters.criticality[0].eq #=> Float
resp.insights[0].filters.title #=> Array
resp.insights[0].filters.title[0].value #=> String
resp.insights[0].filters.title[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.description #=> Array
resp.insights[0].filters.description[0].value #=> String
resp.insights[0].filters.description[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.recommendation_text #=> Array
resp.insights[0].filters.recommendation_text[0].value #=> String
resp.insights[0].filters.recommendation_text[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.source_url #=> Array
resp.insights[0].filters.source_url[0].value #=> String
resp.insights[0].filters.source_url[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.product_fields #=> Array
resp.insights[0].filters.product_fields[0].key #=> String
resp.insights[0].filters.product_fields[0].value #=> String
resp.insights[0].filters.product_fields[0].comparison #=> String, one of "EQUALS"
resp.insights[0].filters.product_name #=> Array
resp.insights[0].filters.product_name[0].value #=> String
resp.insights[0].filters.product_name[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.company_name #=> Array
resp.insights[0].filters.company_name[0].value #=> String
resp.insights[0].filters.company_name[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.user_defined_fields #=> Array
resp.insights[0].filters.user_defined_fields[0].key #=> String
resp.insights[0].filters.user_defined_fields[0].value #=> String
resp.insights[0].filters.user_defined_fields[0].comparison #=> String, one of "EQUALS"
resp.insights[0].filters.malware_name #=> Array
resp.insights[0].filters.malware_name[0].value #=> String
resp.insights[0].filters.malware_name[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.malware_type #=> Array
resp.insights[0].filters.malware_type[0].value #=> String
resp.insights[0].filters.malware_type[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.malware_path #=> Array
resp.insights[0].filters.malware_path[0].value #=> String
resp.insights[0].filters.malware_path[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.malware_state #=> Array
resp.insights[0].filters.malware_state[0].value #=> String
resp.insights[0].filters.malware_state[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.network_direction #=> Array
resp.insights[0].filters.network_direction[0].value #=> String
resp.insights[0].filters.network_direction[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.network_protocol #=> Array
resp.insights[0].filters.network_protocol[0].value #=> String
resp.insights[0].filters.network_protocol[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.network_source_ip_v4 #=> Array
resp.insights[0].filters.network_source_ip_v4[0].cidr #=> String
resp.insights[0].filters.network_source_ip_v6 #=> Array
resp.insights[0].filters.network_source_ip_v6[0].cidr #=> String
resp.insights[0].filters.network_source_port #=> Array
resp.insights[0].filters.network_source_port[0].gte #=> Float
resp.insights[0].filters.network_source_port[0].lte #=> Float
resp.insights[0].filters.network_source_port[0].eq #=> Float
resp.insights[0].filters.network_source_domain #=> Array
resp.insights[0].filters.network_source_domain[0].value #=> String
resp.insights[0].filters.network_source_domain[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.network_source_mac #=> Array
resp.insights[0].filters.network_source_mac[0].value #=> String
resp.insights[0].filters.network_source_mac[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.network_destination_ip_v4 #=> Array
resp.insights[0].filters.network_destination_ip_v4[0].cidr #=> String
resp.insights[0].filters.network_destination_ip_v6 #=> Array
resp.insights[0].filters.network_destination_ip_v6[0].cidr #=> String
resp.insights[0].filters.network_destination_port #=> Array
resp.insights[0].filters.network_destination_port[0].gte #=> Float
resp.insights[0].filters.network_destination_port[0].lte #=> Float
resp.insights[0].filters.network_destination_port[0].eq #=> Float
resp.insights[0].filters.network_destination_domain #=> Array
resp.insights[0].filters.network_destination_domain[0].value #=> String
resp.insights[0].filters.network_destination_domain[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.process_name #=> Array
resp.insights[0].filters.process_name[0].value #=> String
resp.insights[0].filters.process_name[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.process_path #=> Array
resp.insights[0].filters.process_path[0].value #=> String
resp.insights[0].filters.process_path[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.process_pid #=> Array
resp.insights[0].filters.process_pid[0].gte #=> Float
resp.insights[0].filters.process_pid[0].lte #=> Float
resp.insights[0].filters.process_pid[0].eq #=> Float
resp.insights[0].filters.process_parent_pid #=> Array
resp.insights[0].filters.process_parent_pid[0].gte #=> Float
resp.insights[0].filters.process_parent_pid[0].lte #=> Float
resp.insights[0].filters.process_parent_pid[0].eq #=> Float
resp.insights[0].filters.process_launched_at #=> Array
resp.insights[0].filters.process_launched_at[0].start #=> String
resp.insights[0].filters.process_launched_at[0].end #=> String
resp.insights[0].filters.process_launched_at[0].date_range.value #=> Integer
resp.insights[0].filters.process_launched_at[0].date_range.unit #=> String, one of "DAYS"
resp.insights[0].filters.process_terminated_at #=> Array
resp.insights[0].filters.process_terminated_at[0].start #=> String
resp.insights[0].filters.process_terminated_at[0].end #=> String
resp.insights[0].filters.process_terminated_at[0].date_range.value #=> Integer
resp.insights[0].filters.process_terminated_at[0].date_range.unit #=> String, one of "DAYS"
resp.insights[0].filters.threat_intel_indicator_type #=> Array
resp.insights[0].filters.threat_intel_indicator_type[0].value #=> String
resp.insights[0].filters.threat_intel_indicator_type[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.threat_intel_indicator_value #=> Array
resp.insights[0].filters.threat_intel_indicator_value[0].value #=> String
resp.insights[0].filters.threat_intel_indicator_value[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.threat_intel_indicator_category #=> Array
resp.insights[0].filters.threat_intel_indicator_category[0].value #=> String
resp.insights[0].filters.threat_intel_indicator_category[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.threat_intel_indicator_last_observed_at #=> Array
resp.insights[0].filters.threat_intel_indicator_last_observed_at[0].start #=> String
resp.insights[0].filters.threat_intel_indicator_last_observed_at[0].end #=> String
resp.insights[0].filters.threat_intel_indicator_last_observed_at[0].date_range.value #=> Integer
resp.insights[0].filters.threat_intel_indicator_last_observed_at[0].date_range.unit #=> String, one of "DAYS"
resp.insights[0].filters.threat_intel_indicator_source #=> Array
resp.insights[0].filters.threat_intel_indicator_source[0].value #=> String
resp.insights[0].filters.threat_intel_indicator_source[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.threat_intel_indicator_source_url #=> Array
resp.insights[0].filters.threat_intel_indicator_source_url[0].value #=> String
resp.insights[0].filters.threat_intel_indicator_source_url[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_type #=> Array
resp.insights[0].filters.resource_type[0].value #=> String
resp.insights[0].filters.resource_type[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_id #=> Array
resp.insights[0].filters.resource_id[0].value #=> String
resp.insights[0].filters.resource_id[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_partition #=> Array
resp.insights[0].filters.resource_partition[0].value #=> String
resp.insights[0].filters.resource_partition[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_region #=> Array
resp.insights[0].filters.resource_region[0].value #=> String
resp.insights[0].filters.resource_region[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_tags #=> Array
resp.insights[0].filters.resource_tags[0].key #=> String
resp.insights[0].filters.resource_tags[0].value #=> String
resp.insights[0].filters.resource_tags[0].comparison #=> String, one of "EQUALS"
resp.insights[0].filters.resource_aws_ec2_instance_type #=> Array
resp.insights[0].filters.resource_aws_ec2_instance_type[0].value #=> String
resp.insights[0].filters.resource_aws_ec2_instance_type[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_aws_ec2_instance_image_id #=> Array
resp.insights[0].filters.resource_aws_ec2_instance_image_id[0].value #=> String
resp.insights[0].filters.resource_aws_ec2_instance_image_id[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_aws_ec2_instance_ip_v4_addresses #=> Array
resp.insights[0].filters.resource_aws_ec2_instance_ip_v4_addresses[0].cidr #=> String
resp.insights[0].filters.resource_aws_ec2_instance_ip_v6_addresses #=> Array
resp.insights[0].filters.resource_aws_ec2_instance_ip_v6_addresses[0].cidr #=> String
resp.insights[0].filters.resource_aws_ec2_instance_key_name #=> Array
resp.insights[0].filters.resource_aws_ec2_instance_key_name[0].value #=> String
resp.insights[0].filters.resource_aws_ec2_instance_key_name[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_aws_ec2_instance_iam_instance_profile_arn #=> Array
resp.insights[0].filters.resource_aws_ec2_instance_iam_instance_profile_arn[0].value #=> String
resp.insights[0].filters.resource_aws_ec2_instance_iam_instance_profile_arn[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_aws_ec2_instance_vpc_id #=> Array
resp.insights[0].filters.resource_aws_ec2_instance_vpc_id[0].value #=> String
resp.insights[0].filters.resource_aws_ec2_instance_vpc_id[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_aws_ec2_instance_subnet_id #=> Array
resp.insights[0].filters.resource_aws_ec2_instance_subnet_id[0].value #=> String
resp.insights[0].filters.resource_aws_ec2_instance_subnet_id[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_aws_ec2_instance_launched_at #=> Array
resp.insights[0].filters.resource_aws_ec2_instance_launched_at[0].start #=> String
resp.insights[0].filters.resource_aws_ec2_instance_launched_at[0].end #=> String
resp.insights[0].filters.resource_aws_ec2_instance_launched_at[0].date_range.value #=> Integer
resp.insights[0].filters.resource_aws_ec2_instance_launched_at[0].date_range.unit #=> String, one of "DAYS"
resp.insights[0].filters.resource_aws_s3_bucket_owner_id #=> Array
resp.insights[0].filters.resource_aws_s3_bucket_owner_id[0].value #=> String
resp.insights[0].filters.resource_aws_s3_bucket_owner_id[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_aws_s3_bucket_owner_name #=> Array
resp.insights[0].filters.resource_aws_s3_bucket_owner_name[0].value #=> String
resp.insights[0].filters.resource_aws_s3_bucket_owner_name[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_aws_iam_access_key_user_name #=> Array
resp.insights[0].filters.resource_aws_iam_access_key_user_name[0].value #=> String
resp.insights[0].filters.resource_aws_iam_access_key_user_name[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_aws_iam_access_key_status #=> Array
resp.insights[0].filters.resource_aws_iam_access_key_status[0].value #=> String
resp.insights[0].filters.resource_aws_iam_access_key_status[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_aws_iam_access_key_created_at #=> Array
resp.insights[0].filters.resource_aws_iam_access_key_created_at[0].start #=> String
resp.insights[0].filters.resource_aws_iam_access_key_created_at[0].end #=> String
resp.insights[0].filters.resource_aws_iam_access_key_created_at[0].date_range.value #=> Integer
resp.insights[0].filters.resource_aws_iam_access_key_created_at[0].date_range.unit #=> String, one of "DAYS"
resp.insights[0].filters.resource_container_name #=> Array
resp.insights[0].filters.resource_container_name[0].value #=> String
resp.insights[0].filters.resource_container_name[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_container_image_id #=> Array
resp.insights[0].filters.resource_container_image_id[0].value #=> String
resp.insights[0].filters.resource_container_image_id[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_container_image_name #=> Array
resp.insights[0].filters.resource_container_image_name[0].value #=> String
resp.insights[0].filters.resource_container_image_name[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.resource_container_launched_at #=> Array
resp.insights[0].filters.resource_container_launched_at[0].start #=> String
resp.insights[0].filters.resource_container_launched_at[0].end #=> String
resp.insights[0].filters.resource_container_launched_at[0].date_range.value #=> Integer
resp.insights[0].filters.resource_container_launched_at[0].date_range.unit #=> String, one of "DAYS"
resp.insights[0].filters.resource_details_other #=> Array
resp.insights[0].filters.resource_details_other[0].key #=> String
resp.insights[0].filters.resource_details_other[0].value #=> String
resp.insights[0].filters.resource_details_other[0].comparison #=> String, one of "EQUALS"
resp.insights[0].filters.compliance_status #=> Array
resp.insights[0].filters.compliance_status[0].value #=> String
resp.insights[0].filters.compliance_status[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.verification_state #=> Array
resp.insights[0].filters.verification_state[0].value #=> String
resp.insights[0].filters.verification_state[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.workflow_state #=> Array
resp.insights[0].filters.workflow_state[0].value #=> String
resp.insights[0].filters.workflow_state[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.record_state #=> Array
resp.insights[0].filters.record_state[0].value #=> String
resp.insights[0].filters.record_state[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.related_findings_product_arn #=> Array
resp.insights[0].filters.related_findings_product_arn[0].value #=> String
resp.insights[0].filters.related_findings_product_arn[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.related_findings_id #=> Array
resp.insights[0].filters.related_findings_id[0].value #=> String
resp.insights[0].filters.related_findings_id[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.note_text #=> Array
resp.insights[0].filters.note_text[0].value #=> String
resp.insights[0].filters.note_text[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.note_updated_at #=> Array
resp.insights[0].filters.note_updated_at[0].start #=> String
resp.insights[0].filters.note_updated_at[0].end #=> String
resp.insights[0].filters.note_updated_at[0].date_range.value #=> Integer
resp.insights[0].filters.note_updated_at[0].date_range.unit #=> String, one of "DAYS"
resp.insights[0].filters.note_updated_by #=> Array
resp.insights[0].filters.note_updated_by[0].value #=> String
resp.insights[0].filters.note_updated_by[0].comparison #=> String, one of "EQUALS", "PREFIX"
resp.insights[0].filters.keyword #=> Array
resp.insights[0].filters.keyword[0].value #=> String
resp.insights[0].group_by_attribute #=> String
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :insight_arns (Array<String>) —

  The ARNs of the insights to describe.

• :next_token (String) —

  The token that is required for pagination. On your first call to the GetInsights 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 items to return in the response.

Returns:

• (Types::GetInsightsResponse) —

  Returns a response object which responds to the following methods:

  • #insights => Array<Types::Insight>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3433

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

#get_invitations_count(params = {}) ⇒ Types::GetInvitationsCountResponse

Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.

Examples:

Response structure

resp.invitations_count #=> Integer

Parameters:

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

  ({})

Returns:

• (Types::GetInvitationsCountResponse) —

  Returns a response object which responds to the following methods:

  • #invitations_count => Integer

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3454

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

#get_master_account(params = {}) ⇒ Types::GetMasterAccountResponse

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

Examples:

Response structure

resp.master.account_id #=> String
resp.master.invitation_id #=> String
resp.master.invited_at #=> Time
resp.master.member_status #=> String

Parameters:

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

  ({})

Returns:

• (Types::GetMasterAccountResponse) —

  Returns a response object which responds to the following methods:

  • #master => Types::Invitation

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3477

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

#get_members(params = {}) ⇒ Types::GetMembersResponse

Returns the details for the Security Hub member accounts for the specified account IDs.

Examples:

Request syntax with placeholder values

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

Response structure

resp.members #=> Array
resp.members[0].account_id #=> String
resp.members[0].email #=> String
resp.members[0].master_id #=> String
resp.members[0].member_status #=> String
resp.members[0].invited_at #=> Time
resp.members[0].updated_at #=> Time
resp.unprocessed_accounts #=> Array
resp.unprocessed_accounts[0].account_id #=> 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 Security Hub member accounts to return the details for.

Returns:

• (Types::GetMembersResponse) —

  Returns a response object which responds to the following methods:

  • #members => Array<Types::Member>
  • #unprocessed_accounts => Array<Types::Result>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3517

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

#invite_members(params = {}) ⇒ Types::InviteMembersResponse

Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from.

Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.

When the account owner accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from the member account.

Examples:

Request syntax with placeholder values

resp = client.invite_members({
  account_ids: ["NonEmptyString"],
})

Response structure

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

Parameters:

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

  ({})

Options Hash (params):

• :account_ids (Array<String>) —

  The list of account IDs of the AWS accounts to invite to Security Hub as members.

Returns:

• (Types::InviteMembersResponse) —

  Returns a response object which responds to the following methods:

  • #unprocessed_accounts => Array<Types::Result>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3557

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

#list_enabled_products_for_import(params = {}) ⇒ Types::ListEnabledProductsForImportResponse

Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.

Examples:

Request syntax with placeholder values

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

Response structure

resp.product_subscriptions #=> Array
resp.product_subscriptions[0] #=> 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 ListEnabledProductsForImport 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 items to return in the response.

Returns:

• (Types::ListEnabledProductsForImportResponse) —

  Returns a response object which responds to the following methods:

  • #product_subscriptions => Array<String>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3599

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

#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse

Lists all Security Hub membership invitations that were sent to the current AWS account.

Examples:

Request syntax with placeholder values

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

Response structure

resp.invitations #=> Array
resp.invitations[0].account_id #=> String
resp.invitations[0].invitation_id #=> String
resp.invitations[0].invited_at #=> Time
resp.invitations[0].member_status #=> String
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :max_results (Integer) —

  The maximum number of items to return in the response.

• :next_token (String) —

  The token that is required for pagination. On your first call to the ListInvitations 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.

Returns:

• (Types::ListInvitationsResponse) —

  Returns a response object which responds to the following methods:

  • #invitations => Array<Types::Invitation>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3644

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

#list_members(params = {}) ⇒ Types::ListMembersResponse

Lists details about all member accounts for the current Security Hub master account.

Examples:

Request syntax with placeholder values

resp = client.list_members({
  only_associated: false,
  max_results: 1,
  next_token: "NextToken",
})

Response structure

resp.members #=> Array
resp.members[0].account_id #=> String
resp.members[0].email #=> String
resp.members[0].master_id #=> String
resp.members[0].member_status #=> String
resp.members[0].invited_at #=> Time
resp.members[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :only_associated (Boolean) —

  Specifies which member accounts to include in the response based on their relationship status with the master account. The default value is TRUE.

  If OnlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the master is set to ENABLED or DISABLED.

  If OnlyAssociated is set to FALSE, the response includes all existing member accounts.

• :max_results (Integer) —

  The maximum number of items to return in the response.

• :next_token (String) —

  The token that is required for pagination. On your first call to the ListMembers 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.

Returns:

• (Types::ListMembersResponse) —

  Returns a response object which responds to the following methods:

  • #members => Array<Types::Member>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3703

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of tags associated with a resource.

Examples:

Request syntax with placeholder values

resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure

resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

  ({})

Options Hash (params):

• :resource_arn (required, String) —

  The ARN of the resource to retrieve tags for.

Returns:

• (Types::ListTagsForResourceResponse) —

  Returns a response object which responds to the following methods:

  • #tags => Hash<String,String>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3732

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

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to a resource.

Examples:

Request syntax with placeholder values

resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

  ({})

Options Hash (params):

• :resource_arn (required, String) —

  The ARN of the resource to apply the tags to.

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

  The tags to add to the resource.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3760

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

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from a resource.

Examples:

Request syntax with placeholder values

resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

  ({})

Options Hash (params):

• :resource_arn (required, String) —

  The ARN of the resource to remove the tags from.

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

  The tag keys associated with the tags to remove from the resource.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3786

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

#update_action_target(params = {}) ⇒ Struct

Updates the name and description of a custom action target in Security Hub.

Examples:

Request syntax with placeholder values

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

Parameters:

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

  ({})

Options Hash (params):

• :action_target_arn (required, String) —

  The ARN of the custom action target to update.

• :name (String) —

  The updated name of the custom action target.

• :description (String) —

  The updated description for the custom action target.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3817

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

#update_findings(params = {}) ⇒ Struct

Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.

Examples:

Request syntax with placeholder values

resp = client.update_findings({
  filters: { # required
    product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    aws_account_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    generator_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    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
      },
    ],
    description: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    recommendation_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    product_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    product_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    company_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    user_defined_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    malware_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    network_direction: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    network_protocol: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    network_source_mac: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    process_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    process_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    threat_intel_indicator_value: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    threat_intel_indicator_category: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    threat_intel_indicator_source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_partition: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_region: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_tags: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    resource_aws_ec2_instance_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    resource_aws_ec2_instance_iam_instance_profile_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_vpc_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_subnet_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    resource_aws_s3_bucket_owner_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_user_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_created_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    resource_container_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_container_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_container_image_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    compliance_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    verification_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    workflow_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    record_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    related_findings_product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    related_findings_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    note_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    keyword: [
      {
        value: "NonEmptyString",
      },
    ],
  },
  note: {
    text: "NonEmptyString", # required
    updated_by: "NonEmptyString", # required
  },
  record_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
})

Parameters:

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

  ({})

Options Hash (params):

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

  A collection of attributes that specify which findings you want to update.

• :note (Types::NoteUpdate) —

  The updated note for the finding.

• :record_state (String) —

  The updated record state for the finding.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4401

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

#update_insight(params = {}) ⇒ Struct

Updates the Security Hub insight identified by the specified insight ARN.

Examples:

Request syntax with placeholder values

resp = client.update_insight({
  insight_arn: "NonEmptyString", # required
  name: "NonEmptyString",
  filters: {
    product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    aws_account_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    generator_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    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
      },
    ],
    description: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    recommendation_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    product_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    product_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    company_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    user_defined_fields: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    malware_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    malware_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    network_direction: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    network_protocol: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    network_source_mac: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    process_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    process_path: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    threat_intel_indicator_value: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    threat_intel_indicator_category: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    threat_intel_indicator_source_url: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_partition: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_region: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_tags: [
      {
        key: "NonEmptyString",
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS
      },
    ],
    resource_aws_ec2_instance_type: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    resource_aws_ec2_instance_iam_instance_profile_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_vpc_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_ec2_instance_subnet_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    resource_aws_s3_bucket_owner_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_user_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_aws_iam_access_key_created_at: [
      {
        start: "NonEmptyString",
        end: "NonEmptyString",
        date_range: {
          value: 1,
          unit: "DAYS", # accepts DAYS
        },
      },
    ],
    resource_container_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_container_image_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    resource_container_image_name: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    compliance_status: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    verification_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    workflow_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    record_state: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    related_findings_product_arn: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    related_findings_id: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    note_text: [
      {
        value: "NonEmptyString",
        comparison: "EQUALS", # accepts EQUALS, PREFIX
      },
    ],
    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
      },
    ],
    keyword: [
      {
        value: "NonEmptyString",
      },
    ],
  },
  group_by_attribute: "NonEmptyString",
})

Parameters:

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

  ({})

Options Hash (params):

• :insight_arn (required, String) —

  The ARN of the insight that you want to update.

• :name (String) —

  The updated name for the insight.

• :filters (Types::AwsSecurityFindingFilters) —

  The updated filters that define this insight.

• :group_by_attribute (String) —

  The updated GroupBy attribute that defines this insight.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4984

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

#update_standards_control(params = {}) ⇒ Struct

Used to control whether an individual security standard control is enabled or disabled.

Examples:

Request syntax with placeholder values

resp = client.update_standards_control({
  standards_control_arn: "NonEmptyString", # required
  control_status: "ENABLED", # accepts ENABLED, DISABLED
  disabled_reason: "NonEmptyString",
})

Parameters:

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

  ({})

Options Hash (params):

• :standards_control_arn (required, String) —

  The ARN of the security standard control to enable or disable.

• :control_status (String) —

  The updated status of the security standard control.

• :disabled_reason (String) —

  A description of the reason why you are disabling a security standard control.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5016

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