class Aws::Inspector::Client
An API client for Inspector
. To construct a client, you need to configure a `:region` and `:credentials`.
client = Aws::Inspector::Client.new( region: region_name, credentials: credentials, # ... )
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See {#initialize} for a full list of supported configuration options.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-inspector/client.rb, line 3016 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials Your AWS credentials. This can be an instance of any one of the following classes: * `Aws::Credentials` - Used for configuring static, non-refreshing credentials. * `Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`. * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web. * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`. * `Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout. * `Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance. * `Aws::ECSCredentials` - Used for loading credentials from instances running in ECS. * `Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service. When `:credentials` are not configured directly, the following locations will be searched for credentials: * `Aws.config[:credentials]` * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] * `~/.aws/credentials` * `~/.aws/config` * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. @option options [required, String] :region The AWS region to connect to. The configured `:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations: * `Aws.config[:region]` * `ENV['AWS_REGION']` * `ENV['AMAZON_REGION']` * `ENV['AWS_DEFAULT_REGION']` * `~/.aws/credentials` * `~/.aws/config` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (true) Used only in `adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("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. @option options [Integer] :client_side_monitoring_port (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. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint The client endpoint is normally constructed from the `:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (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. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (3) An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in `standard` and `adaptive` retry modes. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (:none) A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the `legacy` retry mode. @see https://www.awsarchitectureblog.com/2015/03/backoff.html @option options [Integer] :retry_limit (3) The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the `legacy` retry mode. @option options [Integer] :retry_max_delay (0) The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [String] :retry_mode ("legacy") Specifies which retry algorithm to use. Values are: * `legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided. * `standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. * `adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :simple_json (false) Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures. When `:simple_json` is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. @option options [Boolean] :stub_responses (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. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Integer] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (5) The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request. @option options [Float] :http_continue_timeout (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. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle 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. @option options [String] :ssl_ca_directory 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 lib/aws-sdk-inspector/client.rb, line 334 def initialize(*args) super end
Public Instance Methods
Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
@option params [required, Array<String>] :finding_arns
The ARNs that specify the findings that you want to assign attributes to.
@option params [required, Array<Types::Attribute>] :attributes
The array of attributes that you want to assign to specified findings.
@return [Types::AddAttributesToFindingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::AddAttributesToFindingsResponse#failed_items #failed_items} => Hash<String,Types::FailedItemDetails>
@example Example: Add attributes to findings
# Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings. resp = client.add_attributes_to_findings({ attributes: [ { key: "Example", value: "example", }, ], finding_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU", ], }) resp.to_h outputs the following: { failed_items: { }, }
@example Request syntax with placeholder values
resp = client.add_attributes_to_findings({ finding_arns: ["Arn"], # required attributes: [ # required { key: "AttributeKey", # required value: "AttributeValue", }, ], })
@example Response structure
resp.failed_items #=> Hash resp.failed_items["Arn"].failure_code #=> String, one of "INVALID_ARN", "DUPLICATE_ARN", "ITEM_DOES_NOT_EXIST", "ACCESS_DENIED", "LIMIT_EXCEEDED", "INTERNAL_ERROR" resp.failed_items["Arn"].retryable #=> Boolean
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/AddAttributesToFindings AWS API Documentation
@overload add_attributes_to_findings
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 399 def add_attributes_to_findings(params = {}, options = {}) req = build_request(:add_attributes_to_findings, params) req.send_request(options) end
@param params ({}) @api private
# File lib/aws-sdk-inspector/client.rb, line 2991 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-inspector' context[:gem_version] = '1.37.0' Seahorse::Client::Request.new(handlers, context) end
Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the [service-linked role] isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector
access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see [ Amazon Inspector
Assessment Targets].
[1]: docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html [2]: docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html
@option params [required, String] :assessment_target_name
The user-defined name that identifies the assessment target that you want to create. The name must be unique within the AWS account.
@option params [String] :resource_group_arn
The ARN that specifies the resource group that is used to create the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.
@return [Types::CreateAssessmentTargetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateAssessmentTargetResponse#assessment_target_arn #assessment_target_arn} => String
@example Example: Create assessment target
# Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. You can # create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. resp = client.create_assessment_target({ assessment_target_name: "ExampleAssessmentTarget", resource_group_arn: "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv", }) resp.to_h outputs the following: { assessment_target_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX", }
@example Request syntax with placeholder values
resp = client.create_assessment_target({ assessment_target_name: "AssessmentTargetName", # required resource_group_arn: "Arn", })
@example Response structure
resp.assessment_target_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/CreateAssessmentTarget AWS API Documentation
@overload create_assessment_target
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 465 def create_assessment_target(params = {}, options = {}) req = build_request(:create_assessment_target, params) req.send_request(options) end
Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the [service-linked role] isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector
access to AWS Services needed to perform security assessments.
[1]: docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html
@option params [required, String] :assessment_target_arn
The ARN that specifies the assessment target for which you want to create the assessment template.
@option params [required, String] :assessment_template_name
The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique.
@option params [required, Integer] :duration_in_seconds
The duration of the assessment run in seconds.
@option params [required, Array<String>] :rules_package_arns
The ARNs that specify the rules packages that you want to attach to the assessment template.
@option params [Array<Types::Attribute>] :user_attributes_for_findings
The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template. An attribute is a key and value pair (an Attribute object). Within an assessment template, each key must be unique.
@return [Types::CreateAssessmentTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateAssessmentTemplateResponse#assessment_template_arn #assessment_template_arn} => String
@example Example: Create assessment template
# Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. resp = client.create_assessment_template({ assessment_target_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX", assessment_template_name: "ExampleAssessmentTemplate", duration_in_seconds: 180, rules_package_arns: [ "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-11B9DBXp", ], user_attributes_for_findings: [ { key: "Example", value: "example", }, ], }) resp.to_h outputs the following: { assessment_template_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T", }
@example Request syntax with placeholder values
resp = client.create_assessment_template({ assessment_target_arn: "Arn", # required assessment_template_name: "AssessmentTemplateName", # required duration_in_seconds: 1, # required rules_package_arns: ["Arn"], # required user_attributes_for_findings: [ { key: "AttributeKey", # required value: "AttributeValue", }, ], })
@example Response structure
resp.assessment_template_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/CreateAssessmentTemplate AWS API Documentation
@overload create_assessment_template
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 555 def create_assessment_template(params = {}, options = {}) req = build_request(:create_assessment_template, params) req.send_request(options) end
Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector
can detect before it runs the assessment.
@option params [required, String] :assessment_template_arn
The ARN that specifies the assessment template for which you want to create an exclusions preview.
@return [Types::CreateExclusionsPreviewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateExclusionsPreviewResponse#preview_token #preview_token} => String
@example Request syntax with placeholder values
resp = client.create_exclusions_preview({ assessment_template_arn: "Arn", # required })
@example Response structure
resp.preview_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/CreateExclusionsPreview AWS API Documentation
@overload create_exclusions_preview
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 587 def create_exclusions_preview(params = {}, options = {}) req = build_request(:create_exclusions_preview, params) req.send_request(options) end
Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector
assessment target. The created resource group is then used to create an Amazon Inspector
assessment target. For more information, see CreateAssessmentTarget.
@option params [required, Array<Types::ResourceGroupTag>] :resource_group_tags
A collection of keys and an array of possible values, '\[\\\{"key":"key1","values":\["Value1","Value2"\]\\},\\\{"key":"Key2","values":\["Value3"\]\\}\]'. For example,'\[\\\{"key":"Name","values":\["TestEC2Instance"\]\\}\]'.
@return [Types::CreateResourceGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateResourceGroupResponse#resource_group_arn #resource_group_arn} => String
@example Example: Create resource group
# Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances # to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon # Inspector assessment target. resp = client.create_resource_group({ resource_group_tags: [ { key: "Name", value: "example", }, ], }) resp.to_h outputs the following: { resource_group_arn: "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv", }
@example Request syntax with placeholder values
resp = client.create_resource_group({ resource_group_tags: [ # required { key: "TagKey", # required value: "TagValue", }, ], })
@example Response structure
resp.resource_group_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/CreateResourceGroup AWS API Documentation
@overload create_resource_group
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 649 def create_resource_group(params = {}, options = {}) req = build_request(:create_resource_group, params) req.send_request(options) end
Deletes the assessment run that is specified by the ARN of the assessment run.
@option params [required, String] :assessment_run_arn
The ARN that specifies the assessment run that you want to delete.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Example: Delete assessment run
# Deletes the assessment run that is specified by the ARN of the assessment run. resp = client.delete_assessment_run({ assessment_run_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe", })
@example Request syntax with placeholder values
resp = client.delete_assessment_run({ assessment_run_arn: "Arn", # required })
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/DeleteAssessmentRun AWS API Documentation
@overload delete_assessment_run
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 681 def delete_assessment_run(params = {}, options = {}) req = build_request(:delete_assessment_run, params) req.send_request(options) end
Deletes the assessment target that is specified by the ARN of the assessment target.
@option params [required, String] :assessment_target_arn
The ARN that specifies the assessment target that you want to delete.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Example: Delete assessment target
# Deletes the assessment target that is specified by the ARN of the assessment target. resp = client.delete_assessment_target({ assessment_target_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", })
@example Request syntax with placeholder values
resp = client.delete_assessment_target({ assessment_target_arn: "Arn", # required })
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/DeleteAssessmentTarget AWS API Documentation
@overload delete_assessment_target
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 713 def delete_assessment_target(params = {}, options = {}) req = build_request(:delete_assessment_target, params) req.send_request(options) end
Deletes the assessment template that is specified by the ARN of the assessment template.
@option params [required, String] :assessment_template_arn
The ARN that specifies the assessment template that you want to delete.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Example: Delete assessment template
# Deletes the assessment template that is specified by the ARN of the assessment template. resp = client.delete_assessment_template({ assessment_template_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T", })
@example Request syntax with placeholder values
resp = client.delete_assessment_template({ assessment_template_arn: "Arn", # required })
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/DeleteAssessmentTemplate AWS API Documentation
@overload delete_assessment_template
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 746 def delete_assessment_template(params = {}, options = {}) req = build_request(:delete_assessment_template, params) req.send_request(options) end
Describes the assessment runs that are specified by the ARNs of the assessment runs.
@option params [required, Array<String>] :assessment_run_arns
The ARN that specifies the assessment run that you want to describe.
@return [Types::DescribeAssessmentRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeAssessmentRunsResponse#assessment_runs #assessment_runs} => Array<Types::AssessmentRun> * {Types::DescribeAssessmentRunsResponse#failed_items #failed_items} => Hash<String,Types::FailedItemDetails>
@example Example: Describte assessment runs
# Describes the assessment runs that are specified by the ARNs of the assessment runs. resp = client.describe_assessment_runs({ assessment_run_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", ], }) resp.to_h outputs the following: { assessment_runs: [ { name: "Run 1 for ExampleAssessmentTemplate", arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", assessment_template_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", completed_at: Time.parse("1458680301.4"), created_at: Time.parse("1458680170.035"), data_collected: true, duration_in_seconds: 3600, finding_counts: { "High" => 14, "Informational" => 0, "Low" => 0, "Medium" => 2, "Undefined" => 0, }, notifications: [ ], rules_package_arns: [ "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP", ], started_at: Time.parse("1458680170.161"), state: "COMPLETED", state_changed_at: Time.parse("1458680301.4"), state_changes: [ { state: "CREATED", state_changed_at: Time.parse("1458680170.035"), }, { state: "START_DATA_COLLECTION_PENDING", state_changed_at: Time.parse("1458680170.065"), }, { state: "START_DATA_COLLECTION_IN_PROGRESS", state_changed_at: Time.parse("1458680170.096"), }, { state: "COLLECTING_DATA", state_changed_at: Time.parse("1458680170.161"), }, { state: "STOP_DATA_COLLECTION_PENDING", state_changed_at: Time.parse("1458680239.883"), }, { state: "DATA_COLLECTED", state_changed_at: Time.parse("1458680299.847"), }, { state: "EVALUATING_RULES", state_changed_at: Time.parse("1458680300.099"), }, { state: "COMPLETED", state_changed_at: Time.parse("1458680301.4"), }, ], user_attributes_for_findings: [ ], }, ], failed_items: { }, }
@example Request syntax with placeholder values
resp = client.describe_assessment_runs({ assessment_run_arns: ["Arn"], # required })
@example Response structure
resp.assessment_runs #=> Array resp.assessment_runs[0].arn #=> String resp.assessment_runs[0].name #=> String resp.assessment_runs[0].assessment_template_arn #=> String resp.assessment_runs[0].state #=> String, one of "CREATED", "START_DATA_COLLECTION_PENDING", "START_DATA_COLLECTION_IN_PROGRESS", "COLLECTING_DATA", "STOP_DATA_COLLECTION_PENDING", "DATA_COLLECTED", "START_EVALUATING_RULES_PENDING", "EVALUATING_RULES", "FAILED", "ERROR", "COMPLETED", "COMPLETED_WITH_ERRORS", "CANCELED" resp.assessment_runs[0].duration_in_seconds #=> Integer resp.assessment_runs[0].rules_package_arns #=> Array resp.assessment_runs[0].rules_package_arns[0] #=> String resp.assessment_runs[0].user_attributes_for_findings #=> Array resp.assessment_runs[0].user_attributes_for_findings[0].key #=> String resp.assessment_runs[0].user_attributes_for_findings[0].value #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil> resp.assessment_runs[0].created_at #=> Time resp.assessment_runs[0].started_at #=> Time resp.assessment_runs[0].completed_at #=> Time resp.assessment_runs[0].state_changed_at #=> Time resp.assessment_runs[0].data_collected #=> Boolean resp.assessment_runs[0].state_changes #=> Array resp.assessment_runs[0].state_changes[0].state_changed_at #=> Time resp.assessment_runs[0].state_changes[0].state #=> String, one of "CREATED", "START_DATA_COLLECTION_PENDING", "START_DATA_COLLECTION_IN_PROGRESS", "COLLECTING_DATA", "STOP_DATA_COLLECTION_PENDING", "DATA_COLLECTED", "START_EVALUATING_RULES_PENDING", "EVALUATING_RULES", "FAILED", "ERROR", "COMPLETED", "COMPLETED_WITH_ERRORS", "CANCELED" resp.assessment_runs[0].notifications #=> Array resp.assessment_runs[0].notifications[0].date #=> Time resp.assessment_runs[0].notifications[0].event #=> String, one of "ASSESSMENT_RUN_STARTED", "ASSESSMENT_RUN_COMPLETED", "ASSESSMENT_RUN_STATE_CHANGED", "FINDING_REPORTED", "OTHER" resp.assessment_runs[0].notifications[0].message #=> String resp.assessment_runs[0].notifications[0].error #=> Boolean resp.assessment_runs[0].notifications[0].sns_topic_arn #=> String resp.assessment_runs[0].notifications[0].sns_publish_status_code #=> String, one of "SUCCESS", "TOPIC_DOES_NOT_EXIST", "ACCESS_DENIED", "INTERNAL_ERROR" resp.assessment_runs[0].finding_counts #=> Hash resp.assessment_runs[0].finding_counts["Severity"] #=> Integer resp.failed_items #=> Hash resp.failed_items["Arn"].failure_code #=> String, one of "INVALID_ARN", "DUPLICATE_ARN", "ITEM_DOES_NOT_EXIST", "ACCESS_DENIED", "LIMIT_EXCEEDED", "INTERNAL_ERROR" resp.failed_items["Arn"].retryable #=> Boolean
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/DescribeAssessmentRuns AWS API Documentation
@overload describe_assessment_runs
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 885 def describe_assessment_runs(params = {}, options = {}) req = build_request(:describe_assessment_runs, params) req.send_request(options) end
Describes the assessment targets that are specified by the ARNs of the assessment targets.
@option params [required, Array<String>] :assessment_target_arns
The ARNs that specifies the assessment targets that you want to describe.
@return [Types::DescribeAssessmentTargetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeAssessmentTargetsResponse#assessment_targets #assessment_targets} => Array<Types::AssessmentTarget> * {Types::DescribeAssessmentTargetsResponse#failed_items #failed_items} => Hash<String,Types::FailedItemDetails>
@example Example: Describte assessment targets
# Describes the assessment targets that are specified by the ARNs of the assessment targets. resp = client.describe_assessment_targets({ assessment_target_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", ], }) resp.to_h outputs the following: { assessment_targets: [ { name: "ExampleAssessmentTarget", arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", created_at: Time.parse("1458074191.459"), resource_group_arn: "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", updated_at: Time.parse("1458074191.459"), }, ], failed_items: { }, }
@example Request syntax with placeholder values
resp = client.describe_assessment_targets({ assessment_target_arns: ["Arn"], # required })
@example Response structure
resp.assessment_targets #=> Array resp.assessment_targets[0].arn #=> String resp.assessment_targets[0].name #=> String resp.assessment_targets[0].resource_group_arn #=> String resp.assessment_targets[0].created_at #=> Time resp.assessment_targets[0].updated_at #=> Time resp.failed_items #=> Hash resp.failed_items["Arn"].failure_code #=> String, one of "INVALID_ARN", "DUPLICATE_ARN", "ITEM_DOES_NOT_EXIST", "ACCESS_DENIED", "LIMIT_EXCEEDED", "INTERNAL_ERROR" resp.failed_items["Arn"].retryable #=> Boolean
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/DescribeAssessmentTargets AWS API Documentation
@overload describe_assessment_targets
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 950 def describe_assessment_targets(params = {}, options = {}) req = build_request(:describe_assessment_targets, params) req.send_request(options) end
Describes the assessment templates that are specified by the ARNs of the assessment templates.
@option params [required, Array<String>] :assessment_template_arns
@return [Types::DescribeAssessmentTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeAssessmentTemplatesResponse#assessment_templates #assessment_templates} => Array<Types::AssessmentTemplate> * {Types::DescribeAssessmentTemplatesResponse#failed_items #failed_items} => Hash<String,Types::FailedItemDetails>
@example Example: Describte assessment templates
# Describes the assessment templates that are specified by the ARNs of the assessment templates. resp = client.describe_assessment_templates({ assessment_template_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", ], }) resp.to_h outputs the following: { assessment_templates: [ { name: "ExampleAssessmentTemplate", arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", assessment_run_count: 0, assessment_target_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", created_at: Time.parse("1458074191.844"), duration_in_seconds: 3600, rules_package_arns: [ "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP", ], user_attributes_for_findings: [ ], }, ], failed_items: { }, }
@example Request syntax with placeholder values
resp = client.describe_assessment_templates({ assessment_template_arns: ["Arn"], # required })
@example Response structure
resp.assessment_templates #=> Array resp.assessment_templates[0].arn #=> String resp.assessment_templates[0].name #=> String resp.assessment_templates[0].assessment_target_arn #=> String resp.assessment_templates[0].duration_in_seconds #=> Integer resp.assessment_templates[0].rules_package_arns #=> Array resp.assessment_templates[0].rules_package_arns[0] #=> String resp.assessment_templates[0].user_attributes_for_findings #=> Array resp.assessment_templates[0].user_attributes_for_findings[0].key #=> String resp.assessment_templates[0].user_attributes_for_findings[0].value #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil> resp.assessment_templates[0].last_assessment_run_arn #=> String resp.assessment_templates[0].assessment_run_count #=> Integer resp.assessment_templates[0].created_at #=> Time resp.failed_items #=> Hash resp.failed_items["Arn"].failure_code #=> String, one of "INVALID_ARN", "DUPLICATE_ARN", "ITEM_DOES_NOT_EXIST", "ACCESS_DENIED", "LIMIT_EXCEEDED", "INTERNAL_ERROR" resp.failed_items["Arn"].retryable #=> Boolean
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/DescribeAssessmentTemplates AWS API Documentation
@overload describe_assessment_templates
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 1026 def describe_assessment_templates(params = {}, options = {}) req = build_request(:describe_assessment_templates, params) req.send_request(options) end
Describes the IAM role that enables Amazon Inspector
to access your AWS account.
@return [Types::DescribeCrossAccountAccessRoleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeCrossAccountAccessRoleResponse#role_arn #role_arn} => String * {Types::DescribeCrossAccountAccessRoleResponse#valid #valid} => Boolean * {Types::DescribeCrossAccountAccessRoleResponse#registered_at #registered_at} => Time
@example Example: Describte cross account access role
# Describes the IAM role that enables Amazon Inspector to access your AWS account. resp = client.describe_cross_account_access_role({ }) resp.to_h outputs the following: { registered_at: Time.parse("1458069182.826"), role_arn: "arn:aws:iam::123456789012:role/inspector", valid: true, }
@example Response structure
resp.role_arn #=> String resp.valid #=> Boolean resp.registered_at #=> Time
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/DescribeCrossAccountAccessRole AWS API Documentation
@overload describe_cross_account_access_role
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 1065 def describe_cross_account_access_role(params = {}, options = {}) req = build_request(:describe_cross_account_access_role, params) req.send_request(options) end
Describes the exclusions that are specified by the exclusions' ARNs.
@option params [required, Array<String>] :exclusion_arns
The list of ARNs that specify the exclusions that you want to describe.
@option params [String] :locale
The locale into which you want to translate the exclusion's title, description, and recommendation.
@return [Types::DescribeExclusionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeExclusionsResponse#exclusions #exclusions} => Hash<String,Types::Exclusion> * {Types::DescribeExclusionsResponse#failed_items #failed_items} => Hash<String,Types::FailedItemDetails>
@example Request syntax with placeholder values
resp = client.describe_exclusions({ exclusion_arns: ["Arn"], # required locale: "EN_US", # accepts EN_US })
@example Response structure
resp.exclusions #=> Hash resp.exclusions["Arn"].arn #=> String resp.exclusions["Arn"].title #=> String resp.exclusions["Arn"].description #=> String resp.exclusions["Arn"].recommendation #=> String resp.exclusions["Arn"].scopes #=> Array resp.exclusions["Arn"].scopes[0].key #=> String, one of "INSTANCE_ID", "RULES_PACKAGE_ARN" resp.exclusions["Arn"].scopes[0].value #=> String resp.exclusions["Arn"].attributes #=> Array resp.exclusions["Arn"].attributes[0].key #=> String resp.exclusions["Arn"].attributes[0].value #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil> resp.failed_items #=> Hash resp.failed_items["Arn"].failure_code #=> String, one of "INVALID_ARN", "DUPLICATE_ARN", "ITEM_DOES_NOT_EXIST", "ACCESS_DENIED", "LIMIT_EXCEEDED", "INTERNAL_ERROR" resp.failed_items["Arn"].retryable #=> Boolean
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/DescribeExclusions AWS API Documentation
@overload describe_exclusions
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 1113 def describe_exclusions(params = {}, options = {}) req = build_request(:describe_exclusions, params) req.send_request(options) end
Describes the findings that are specified by the ARNs of the findings.
@option params [required, Array<String>] :finding_arns
The ARN that specifies the finding that you want to describe.
@option params [String] :locale
The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding.
@return [Types::DescribeFindingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeFindingsResponse#findings #findings} => Array<Types::Finding> * {Types::DescribeFindingsResponse#failed_items #failed_items} => Hash<String,Types::FailedItemDetails>
@example Example: Describe findings
# Describes the findings that are specified by the ARNs of the findings. resp = client.describe_findings({ finding_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", ], }) resp.to_h outputs the following: { failed_items: { }, findings: [ { arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", asset_attributes: { ipv4_addresses: [ ], schema_version: 1, }, asset_type: "ec2-instance", attributes: [ ], confidence: 10, created_at: Time.parse("1458680301.37"), description: "Amazon Inspector did not find any potential security issues during this assessment.", indicator_of_compromise: false, numeric_severity: 0, recommendation: "No remediation needed.", schema_version: 1, service: "Inspector", service_attributes: { assessment_run_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", rules_package_arn: "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP", schema_version: 1, }, severity: "Informational", title: "No potential security issues found", updated_at: Time.parse("1458680301.37"), user_attributes: [ ], }, ], }
@example Request syntax with placeholder values
resp = client.describe_findings({ finding_arns: ["Arn"], # required locale: "EN_US", # accepts EN_US })
@example Response structure
resp.findings #=> Array resp.findings[0].arn #=> String resp.findings[0].schema_version #=> Integer resp.findings[0].service #=> String resp.findings[0].service_attributes.schema_version #=> Integer resp.findings[0].service_attributes.assessment_run_arn #=> String resp.findings[0].service_attributes.rules_package_arn #=> String resp.findings[0].asset_type #=> String, one of "ec2-instance" resp.findings[0].asset_attributes.schema_version #=> Integer resp.findings[0].asset_attributes.agent_id #=> String resp.findings[0].asset_attributes.auto_scaling_group #=> String resp.findings[0].asset_attributes.ami_id #=> String resp.findings[0].asset_attributes.hostname #=> String resp.findings[0].asset_attributes.ipv4_addresses #=> Array resp.findings[0].asset_attributes.ipv4_addresses[0] #=> String resp.findings[0].asset_attributes.tags #=> Array resp.findings[0].asset_attributes.tags[0].key #=> String resp.findings[0].asset_attributes.tags[0].value #=> String resp.findings[0].asset_attributes.network_interfaces #=> Array resp.findings[0].asset_attributes.network_interfaces[0].network_interface_id #=> String resp.findings[0].asset_attributes.network_interfaces[0].subnet_id #=> String resp.findings[0].asset_attributes.network_interfaces[0].vpc_id #=> String resp.findings[0].asset_attributes.network_interfaces[0].private_dns_name #=> String resp.findings[0].asset_attributes.network_interfaces[0].private_ip_address #=> String resp.findings[0].asset_attributes.network_interfaces[0].private_ip_addresses #=> Array resp.findings[0].asset_attributes.network_interfaces[0].private_ip_addresses[0].private_dns_name #=> String resp.findings[0].asset_attributes.network_interfaces[0].private_ip_addresses[0].private_ip_address #=> String resp.findings[0].asset_attributes.network_interfaces[0].public_dns_name #=> String resp.findings[0].asset_attributes.network_interfaces[0].public_ip #=> String resp.findings[0].asset_attributes.network_interfaces[0].ipv6_addresses #=> Array resp.findings[0].asset_attributes.network_interfaces[0].ipv6_addresses[0] #=> String resp.findings[0].asset_attributes.network_interfaces[0].security_groups #=> Array resp.findings[0].asset_attributes.network_interfaces[0].security_groups[0].group_name #=> String resp.findings[0].asset_attributes.network_interfaces[0].security_groups[0].group_id #=> String resp.findings[0].id #=> String resp.findings[0].title #=> String resp.findings[0].description #=> String resp.findings[0].recommendation #=> String resp.findings[0].severity #=> String, one of "Low", "Medium", "High", "Informational", "Undefined" resp.findings[0].numeric_severity #=> Float resp.findings[0].confidence #=> Integer resp.findings[0].indicator_of_compromise #=> Boolean resp.findings[0].attributes #=> Array resp.findings[0].attributes[0].key #=> String resp.findings[0].attributes[0].value #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil> resp.findings[0].user_attributes #=> Array resp.findings[0].user_attributes[0].key #=> String resp.findings[0].user_attributes[0].value #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil> resp.findings[0].created_at #=> Time resp.findings[0].updated_at #=> Time resp.failed_items #=> Hash resp.failed_items["Arn"].failure_code #=> String, one of "INVALID_ARN", "DUPLICATE_ARN", "ITEM_DOES_NOT_EXIST", "ACCESS_DENIED", "LIMIT_EXCEEDED", "INTERNAL_ERROR" resp.failed_items["Arn"].retryable #=> Boolean
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/DescribeFindings AWS API Documentation
@overload describe_findings
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 1247 def describe_findings(params = {}, options = {}) req = build_request(:describe_findings, params) req.send_request(options) end
Describes the resource groups that are specified by the ARNs of the resource groups.
@option params [required, Array<String>] :resource_group_arns
The ARN that specifies the resource group that you want to describe.
@return [Types::DescribeResourceGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeResourceGroupsResponse#resource_groups #resource_groups} => Array<Types::ResourceGroup> * {Types::DescribeResourceGroupsResponse#failed_items #failed_items} => Hash<String,Types::FailedItemDetails>
@example Example: Describe resource groups
# Describes the resource groups that are specified by the ARNs of the resource groups. resp = client.describe_resource_groups({ resource_group_arns: [ "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", ], }) resp.to_h outputs the following: { failed_items: { }, resource_groups: [ { arn: "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", created_at: Time.parse("1458074191.098"), tags: [ { key: "Name", value: "example", }, ], }, ], }
@example Request syntax with placeholder values
resp = client.describe_resource_groups({ resource_group_arns: ["Arn"], # required })
@example Response structure
resp.resource_groups #=> Array resp.resource_groups[0].arn #=> String resp.resource_groups[0].tags #=> Array resp.resource_groups[0].tags[0].key #=> String resp.resource_groups[0].tags[0].value #=> String resp.resource_groups[0].created_at #=> Time resp.failed_items #=> Hash resp.failed_items["Arn"].failure_code #=> String, one of "INVALID_ARN", "DUPLICATE_ARN", "ITEM_DOES_NOT_EXIST", "ACCESS_DENIED", "LIMIT_EXCEEDED", "INTERNAL_ERROR" resp.failed_items["Arn"].retryable #=> Boolean
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/DescribeResourceGroups AWS API Documentation
@overload describe_resource_groups
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 1314 def describe_resource_groups(params = {}, options = {}) req = build_request(:describe_resource_groups, params) req.send_request(options) end
Describes the rules packages that are specified by the ARNs of the rules packages.
@option params [required, Array<String>] :rules_package_arns
The ARN that specifies the rules package that you want to describe.
@option params [String] :locale
The locale that you want to translate a rules package description into.
@return [Types::DescribeRulesPackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeRulesPackagesResponse#rules_packages #rules_packages} => Array<Types::RulesPackage> * {Types::DescribeRulesPackagesResponse#failed_items #failed_items} => Hash<String,Types::FailedItemDetails>
@example Example: Describe rules packages
# Describes the rules packages that are specified by the ARNs of the rules packages. resp = client.describe_rules_packages({ rules_package_arns: [ "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ", ], }) resp.to_h outputs the following: { failed_items: { }, rules_packages: [ { version: "1.1", name: "Security Best Practices", arn: "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ", description: "The rules in this package help determine whether your systems are configured securely.", provider: "Amazon Web Services, Inc.", }, ], }
@example Request syntax with placeholder values
resp = client.describe_rules_packages({ rules_package_arns: ["Arn"], # required locale: "EN_US", # accepts EN_US })
@example Response structure
resp.rules_packages #=> Array resp.rules_packages[0].arn #=> String resp.rules_packages[0].name #=> String resp.rules_packages[0].version #=> String resp.rules_packages[0].provider #=> String resp.rules_packages[0].description #=> String resp.failed_items #=> Hash resp.failed_items["Arn"].failure_code #=> String, one of "INVALID_ARN", "DUPLICATE_ARN", "ITEM_DOES_NOT_EXIST", "ACCESS_DENIED", "LIMIT_EXCEEDED", "INTERNAL_ERROR" resp.failed_items["Arn"].retryable #=> Boolean
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/DescribeRulesPackages AWS API Documentation
@overload describe_rules_packages
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 1383 def describe_rules_packages(params = {}, options = {}) req = build_request(:describe_rules_packages, params) req.send_request(options) end
Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
@option params [required, String] :assessment_run_arn
The ARN that specifies the assessment run for which you want to generate a report.
@option params [required, String] :report_file_format
Specifies the file format (html or pdf) of the assessment report that you want to generate.
@option params [required, String] :report_type
Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see [Assessment Reports][1]. [1]: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_reports.html
@return [Types::GetAssessmentReportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetAssessmentReportResponse#status #status} => String * {Types::GetAssessmentReportResponse#url #url} => String
@example Request syntax with placeholder values
resp = client.get_assessment_report({ assessment_run_arn: "Arn", # required report_file_format: "HTML", # required, accepts HTML, PDF report_type: "FINDING", # required, accepts FINDING, FULL })
@example Response structure
resp.status #=> String, one of "WORK_IN_PROGRESS", "FAILED", "COMPLETED" resp.url #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/GetAssessmentReport AWS API Documentation
@overload get_assessment_report
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 1430 def get_assessment_report(params = {}, options = {}) req = build_request(:get_assessment_report, params) req.send_request(options) end
Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.
@option params [required, String] :assessment_template_arn
The ARN that specifies the assessment template for which the exclusions preview was requested.
@option params [required, String] :preview_token
The unique identifier associated of the exclusions preview.
@option params [String] :next_token
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
@option params [Integer] :max_results
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.
@option params [String] :locale
The locale into which you want to translate the exclusion's title, description, and recommendation.
@return [Types::GetExclusionsPreviewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetExclusionsPreviewResponse#preview_status #preview_status} => String * {Types::GetExclusionsPreviewResponse#exclusion_previews #exclusion_previews} => Array<Types::ExclusionPreview> * {Types::GetExclusionsPreviewResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.get_exclusions_preview({ assessment_template_arn: "Arn", # required preview_token: "UUID", # required next_token: "PaginationToken", max_results: 1, locale: "EN_US", # accepts EN_US })
@example Response structure
resp.preview_status #=> String, one of "WORK_IN_PROGRESS", "COMPLETED" resp.exclusion_previews #=> Array resp.exclusion_previews[0].title #=> String resp.exclusion_previews[0].description #=> String resp.exclusion_previews[0].recommendation #=> String resp.exclusion_previews[0].scopes #=> Array resp.exclusion_previews[0].scopes[0].key #=> String, one of "INSTANCE_ID", "RULES_PACKAGE_ARN" resp.exclusion_previews[0].scopes[0].value #=> String resp.exclusion_previews[0].attributes #=> Array resp.exclusion_previews[0].attributes[0].key #=> String resp.exclusion_previews[0].attributes[0].value #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil> resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/GetExclusionsPreview AWS API Documentation
@overload get_exclusions_preview
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 1499 def get_exclusions_preview(params = {}, options = {}) req = build_request(:get_exclusions_preview, params) req.send_request(options) end
Information about the data that is collected for the specified assessment run.
@option params [required, String] :assessment_run_arn
The ARN that specifies the assessment run that has the telemetry data that you want to obtain.
@return [Types::GetTelemetryMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetTelemetryMetadataResponse#telemetry_metadata #telemetry_metadata} => Array<Types::TelemetryMetadata>
@example Example: Get telemetry metadata
# Information about the data that is collected for the specified assessment run. resp = client.get_telemetry_metadata({ assessment_run_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", }) resp.to_h outputs the following: { telemetry_metadata: [ { count: 2, data_size: 345, message_type: "InspectorDuplicateProcess", }, { count: 3, data_size: 255, message_type: "InspectorTimeEventMsg", }, { count: 4, data_size: 1082, message_type: "InspectorNetworkInterface", }, { count: 2, data_size: 349, message_type: "InspectorDnsEntry", }, { count: 11, data_size: 2514, message_type: "InspectorDirectoryInfoMsg", }, { count: 1, data_size: 179, message_type: "InspectorTcpV6ListeningPort", }, { count: 101, data_size: 10949, message_type: "InspectorTerminal", }, { count: 26, data_size: 5916, message_type: "InspectorUser", }, { count: 282, data_size: 32148, message_type: "InspectorDynamicallyLoadedCodeModule", }, { count: 18, data_size: 10172, message_type: "InspectorCreateProcess", }, { count: 3, data_size: 8001, message_type: "InspectorProcessPerformance", }, { count: 1, data_size: 360, message_type: "InspectorOperatingSystem", }, { count: 6, data_size: 546, message_type: "InspectorStopProcess", }, { count: 1, data_size: 1553, message_type: "InspectorInstanceMetaData", }, { count: 2, data_size: 434, message_type: "InspectorTcpV4Connection", }, { count: 474, data_size: 2960322, message_type: "InspectorPackageInfo", }, { count: 3, data_size: 2235, message_type: "InspectorSystemPerformance", }, { count: 105, data_size: 46048, message_type: "InspectorCodeModule", }, { count: 1, data_size: 182, message_type: "InspectorUdpV6ListeningPort", }, { count: 2, data_size: 371, message_type: "InspectorUdpV4ListeningPort", }, { count: 18, data_size: 8362, message_type: "InspectorKernelModule", }, { count: 29, data_size: 48788, message_type: "InspectorConfigurationInfo", }, { count: 1, data_size: 79, message_type: "InspectorMonitoringStart", }, { count: 5, data_size: 0, message_type: "InspectorSplitMsgBegin", }, { count: 51, data_size: 4593, message_type: "InspectorGroup", }, { count: 1, data_size: 184, message_type: "InspectorTcpV4ListeningPort", }, { count: 1159, data_size: 3146579, message_type: "Total", }, { count: 5, data_size: 0, message_type: "InspectorSplitMsgEnd", }, { count: 1, data_size: 612, message_type: "InspectorLoadImageInProcess", }, ], }
@example Request syntax with placeholder values
resp = client.get_telemetry_metadata({ assessment_run_arn: "Arn", # required })
@example Response structure
resp.telemetry_metadata #=> Array resp.telemetry_metadata[0].message_type #=> String resp.telemetry_metadata[0].count #=> Integer resp.telemetry_metadata[0].data_size #=> Integer
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/GetTelemetryMetadata AWS API Documentation
@overload get_telemetry_metadata
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 1692 def get_telemetry_metadata(params = {}, options = {}) req = build_request(:get_telemetry_metadata, params) req.send_request(options) end
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
@option params [required, String] :assessment_run_arn
The ARN that specifies the assessment run whose agents you want to list.
@option params [Types::AgentFilter] :filter
You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
@option params [String] :next_token
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the **ListAssessmentRunAgents** action. Subsequent calls to the action fill **nextToken** in the request with the value of **NextToken** from the previous response to continue listing data.
@option params [Integer] :max_results
You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.
@return [Types::ListAssessmentRunAgentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListAssessmentRunAgentsResponse#assessment_run_agents #assessment_run_agents} => Array<Types::AssessmentRunAgent> * {Types::ListAssessmentRunAgentsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Example: List assessment run agents
# Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs. resp = client.list_assessment_run_agents({ assessment_run_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", max_results: 123, }) resp.to_h outputs the following: { assessment_run_agents: [ { agent_health: "HEALTHY", agent_health_code: "RUNNING", agent_id: "i-49113b93", assessment_run_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", telemetry_metadata: [ { count: 2, data_size: 345, message_type: "InspectorDuplicateProcess", }, { count: 3, data_size: 255, message_type: "InspectorTimeEventMsg", }, { count: 4, data_size: 1082, message_type: "InspectorNetworkInterface", }, { count: 2, data_size: 349, message_type: "InspectorDnsEntry", }, { count: 11, data_size: 2514, message_type: "InspectorDirectoryInfoMsg", }, { count: 1, data_size: 179, message_type: "InspectorTcpV6ListeningPort", }, { count: 101, data_size: 10949, message_type: "InspectorTerminal", }, { count: 26, data_size: 5916, message_type: "InspectorUser", }, { count: 282, data_size: 32148, message_type: "InspectorDynamicallyLoadedCodeModule", }, { count: 18, data_size: 10172, message_type: "InspectorCreateProcess", }, { count: 3, data_size: 8001, message_type: "InspectorProcessPerformance", }, { count: 1, data_size: 360, message_type: "InspectorOperatingSystem", }, { count: 6, data_size: 546, message_type: "InspectorStopProcess", }, { count: 1, data_size: 1553, message_type: "InspectorInstanceMetaData", }, { count: 2, data_size: 434, message_type: "InspectorTcpV4Connection", }, { count: 474, data_size: 2960322, message_type: "InspectorPackageInfo", }, { count: 3, data_size: 2235, message_type: "InspectorSystemPerformance", }, { count: 105, data_size: 46048, message_type: "InspectorCodeModule", }, { count: 1, data_size: 182, message_type: "InspectorUdpV6ListeningPort", }, { count: 2, data_size: 371, message_type: "InspectorUdpV4ListeningPort", }, { count: 18, data_size: 8362, message_type: "InspectorKernelModule", }, { count: 29, data_size: 48788, message_type: "InspectorConfigurationInfo", }, { count: 1, data_size: 79, message_type: "InspectorMonitoringStart", }, { count: 5, data_size: 0, message_type: "InspectorSplitMsgBegin", }, { count: 51, data_size: 4593, message_type: "InspectorGroup", }, { count: 1, data_size: 184, message_type: "InspectorTcpV4ListeningPort", }, { count: 1159, data_size: 3146579, message_type: "Total", }, { count: 5, data_size: 0, message_type: "InspectorSplitMsgEnd", }, { count: 1, data_size: 612, message_type: "InspectorLoadImageInProcess", }, ], }, ], next_token: "1", }
@example Request syntax with placeholder values
resp = client.list_assessment_run_agents({ assessment_run_arn: "Arn", # required filter: { agent_healths: ["HEALTHY"], # required, accepts HEALTHY, UNHEALTHY, UNKNOWN agent_health_codes: ["IDLE"], # required, accepts IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, UNKNOWN }, next_token: "PaginationToken", max_results: 1, })
@example Response structure
resp.assessment_run_agents #=> Array resp.assessment_run_agents[0].agent_id #=> String resp.assessment_run_agents[0].assessment_run_arn #=> String resp.assessment_run_agents[0].agent_health #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN" resp.assessment_run_agents[0].agent_health_code #=> String, one of "IDLE", "RUNNING", "SHUTDOWN", "UNHEALTHY", "THROTTLED", "UNKNOWN" resp.assessment_run_agents[0].agent_health_details #=> String resp.assessment_run_agents[0].auto_scaling_group #=> String resp.assessment_run_agents[0].telemetry_metadata #=> Array resp.assessment_run_agents[0].telemetry_metadata[0].message_type #=> String resp.assessment_run_agents[0].telemetry_metadata[0].count #=> Integer resp.assessment_run_agents[0].telemetry_metadata[0].data_size #=> Integer resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/ListAssessmentRunAgents AWS API Documentation
@overload list_assessment_run_agents
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 1932 def list_assessment_run_agents(params = {}, options = {}) req = build_request(:list_assessment_run_agents, params) req.send_request(options) end
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
@option params [Array<String>] :assessment_template_arns
The ARNs that specify the assessment templates whose assessment runs you want to list.
@option params [Types::AssessmentRunFilter] :filter
You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
@option params [String] :next_token
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the **ListAssessmentRuns** action. Subsequent calls to the action fill **nextToken** in the request with the value of **NextToken** from the previous response to continue listing data.
@option params [Integer] :max_results
You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.
@return [Types::ListAssessmentRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListAssessmentRunsResponse#assessment_run_arns #assessment_run_arns} => Array<String> * {Types::ListAssessmentRunsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Example: List assessment runs
# Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment # templates. resp = client.list_assessment_runs({ assessment_template_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", ], max_results: 123, }) resp.to_h outputs the following: { assessment_run_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v", ], next_token: "1", }
@example Request syntax with placeholder values
resp = client.list_assessment_runs({ assessment_template_arns: ["Arn"], filter: { name_pattern: "NamePattern", states: ["CREATED"], # accepts CREATED, START_DATA_COLLECTION_PENDING, START_DATA_COLLECTION_IN_PROGRESS, COLLECTING_DATA, STOP_DATA_COLLECTION_PENDING, DATA_COLLECTED, START_EVALUATING_RULES_PENDING, EVALUATING_RULES, FAILED, ERROR, COMPLETED, COMPLETED_WITH_ERRORS, CANCELED duration_range: { min_seconds: 1, max_seconds: 1, }, rules_package_arns: ["Arn"], start_time_range: { begin_date: Time.now, end_date: Time.now, }, completion_time_range: { begin_date: Time.now, end_date: Time.now, }, state_change_time_range: { begin_date: Time.now, end_date: Time.now, }, }, next_token: "PaginationToken", max_results: 1, })
@example Response structure
resp.assessment_run_arns #=> Array resp.assessment_run_arns[0] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/ListAssessmentRuns AWS API Documentation
@overload list_assessment_runs
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2032 def list_assessment_runs(params = {}, options = {}) req = build_request(:list_assessment_runs, params) req.send_request(options) end
Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see [Amazon Inspector
Assessment Targets].
[1]: docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html
@option params [Types::AssessmentTargetFilter] :filter
You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
@option params [String] :next_token
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the **ListAssessmentTargets** action. Subsequent calls to the action fill **nextToken** in the request with the value of **NextToken** from the previous response to continue listing data.
@option params [Integer] :max_results
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
@return [Types::ListAssessmentTargetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListAssessmentTargetsResponse#assessment_target_arns #assessment_target_arns} => Array<String> * {Types::ListAssessmentTargetsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Example: List assessment targets
# Lists the ARNs of the assessment targets within this AWS account. resp = client.list_assessment_targets({ max_results: 123, }) resp.to_h outputs the following: { assessment_target_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", ], next_token: "1", }
@example Request syntax with placeholder values
resp = client.list_assessment_targets({ filter: { assessment_target_name_pattern: "NamePattern", }, next_token: "PaginationToken", max_results: 1, })
@example Response structure
resp.assessment_target_arns #=> Array resp.assessment_target_arns[0] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/ListAssessmentTargets AWS API Documentation
@overload list_assessment_targets
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2109 def list_assessment_targets(params = {}, options = {}) req = build_request(:list_assessment_targets, params) req.send_request(options) end
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
@option params [Array<String>] :assessment_target_arns
A list of ARNs that specifies the assessment targets whose assessment templates you want to list.
@option params [Types::AssessmentTemplateFilter] :filter
You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
@option params [String] :next_token
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the **ListAssessmentTemplates** action. Subsequent calls to the action fill **nextToken** in the request with the value of **NextToken** from the previous response to continue listing data.
@option params [Integer] :max_results
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
@return [Types::ListAssessmentTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListAssessmentTemplatesResponse#assessment_template_arns #assessment_template_arns} => Array<String> * {Types::ListAssessmentTemplatesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Example: List assessment templates
# Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the # assessment targets. resp = client.list_assessment_templates({ assessment_target_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", ], max_results: 123, }) resp.to_h outputs the following: { assessment_template_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-Uza6ihLh", ], next_token: "1", }
@example Request syntax with placeholder values
resp = client.list_assessment_templates({ assessment_target_arns: ["Arn"], filter: { name_pattern: "NamePattern", duration_range: { min_seconds: 1, max_seconds: 1, }, rules_package_arns: ["Arn"], }, next_token: "PaginationToken", max_results: 1, })
@example Response structure
resp.assessment_template_arns #=> Array resp.assessment_template_arns[0] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/ListAssessmentTemplates AWS API Documentation
@overload list_assessment_templates
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2196 def list_assessment_templates(params = {}, options = {}) req = build_request(:list_assessment_templates, params) req.send_request(options) end
Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.
@option params [String] :resource_arn
The ARN of the assessment template for which you want to list the existing event subscriptions.
@option params [String] :next_token
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the **ListEventSubscriptions** action. Subsequent calls to the action fill **nextToken** in the request with the value of **NextToken** from the previous response to continue listing data.
@option params [Integer] :max_results
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
@return [Types::ListEventSubscriptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListEventSubscriptionsResponse#subscriptions #subscriptions} => Array<Types::Subscription> * {Types::ListEventSubscriptionsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Example: List event subscriptions
# Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. resp = client.list_event_subscriptions({ max_results: 123, resource_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", }) resp.to_h outputs the following: { next_token: "1", subscriptions: [ { event_subscriptions: [ { event: "ASSESSMENT_RUN_COMPLETED", subscribed_at: Time.parse("1459455440.867"), }, ], resource_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", topic_arn: "arn:aws:sns:us-west-2:123456789012:exampletopic", }, ], }
@example Request syntax with placeholder values
resp = client.list_event_subscriptions({ resource_arn: "Arn", next_token: "PaginationToken", max_results: 1, })
@example Response structure
resp.subscriptions #=> Array resp.subscriptions[0].resource_arn #=> String resp.subscriptions[0].topic_arn #=> String resp.subscriptions[0].event_subscriptions #=> Array resp.subscriptions[0].event_subscriptions[0].event #=> String, one of "ASSESSMENT_RUN_STARTED", "ASSESSMENT_RUN_COMPLETED", "ASSESSMENT_RUN_STATE_CHANGED", "FINDING_REPORTED", "OTHER" resp.subscriptions[0].event_subscriptions[0].subscribed_at #=> Time resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/ListEventSubscriptions AWS API Documentation
@overload list_event_subscriptions
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2277 def list_event_subscriptions(params = {}, options = {}) req = build_request(:list_event_subscriptions, params) req.send_request(options) end
List exclusions that are generated by the assessment run.
@option params [required, String] :assessment_run_arn
The ARN of the assessment run that generated the exclusions that you want to list.
@option params [String] :next_token
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListExclusionsRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
@option params [Integer] :max_results
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.
@return [Types::ListExclusionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListExclusionsResponse#exclusion_arns #exclusion_arns} => Array<String> * {Types::ListExclusionsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_exclusions({ assessment_run_arn: "Arn", # required next_token: "PaginationToken", max_results: 1, })
@example Response structure
resp.exclusion_arns #=> Array resp.exclusion_arns[0] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/ListExclusions AWS API Documentation
@overload list_exclusions
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2325 def list_exclusions(params = {}, options = {}) req = build_request(:list_exclusions, params) req.send_request(options) end
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
@option params [Array<String>] :assessment_run_arns
The ARNs of the assessment runs that generate the findings that you want to list.
@option params [Types::FindingFilter] :filter
You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
@option params [String] :next_token
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the **ListFindings** action. Subsequent calls to the action fill **nextToken** in the request with the value of **NextToken** from the previous response to continue listing data.
@option params [Integer] :max_results
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
@return [Types::ListFindingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListFindingsResponse#finding_arns #finding_arns} => Array<String> * {Types::ListFindingsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Example: List findings
# Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs. resp = client.list_findings({ assessment_run_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", ], max_results: 123, }) resp.to_h outputs the following: { finding_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v/finding/0-tyvmqBLy", ], next_token: "1", }
@example Request syntax with placeholder values
resp = client.list_findings({ assessment_run_arns: ["Arn"], filter: { agent_ids: ["AgentId"], auto_scaling_groups: ["AutoScalingGroup"], rule_names: ["RuleName"], severities: ["Low"], # accepts Low, Medium, High, Informational, Undefined rules_package_arns: ["Arn"], attributes: [ { key: "AttributeKey", # required value: "AttributeValue", }, ], user_attributes: [ { key: "AttributeKey", # required value: "AttributeValue", }, ], creation_time_range: { begin_date: Time.now, end_date: Time.now, }, }, next_token: "PaginationToken", max_results: 1, })
@example Response structure
resp.finding_arns #=> Array resp.finding_arns[0] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/ListFindings AWS API Documentation
@overload list_findings
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2426 def list_findings(params = {}, options = {}) req = build_request(:list_findings, params) req.send_request(options) end
Lists all available Amazon Inspector
rules packages.
@option params [String] :next_token
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the **ListRulesPackages** action. Subsequent calls to the action fill **nextToken** in the request with the value of **NextToken** from the previous response to continue listing data.
@option params [Integer] :max_results
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
@return [Types::ListRulesPackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListRulesPackagesResponse#rules_package_arns #rules_package_arns} => Array<String> * {Types::ListRulesPackagesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Example: List rules packages
# Lists all available Amazon Inspector rules packages. resp = client.list_rules_packages({ max_results: 123, }) resp.to_h outputs the following: { next_token: "1", rules_package_arns: [ "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p", "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc", "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ", "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD", ], }
@example Request syntax with placeholder values
resp = client.list_rules_packages({ next_token: "PaginationToken", max_results: 1, })
@example Response structure
resp.rules_package_arns #=> Array resp.rules_package_arns[0] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/ListRulesPackages AWS API Documentation
@overload list_rules_packages
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2489 def list_rules_packages(params = {}, options = {}) req = build_request(:list_rules_packages, params) req.send_request(options) end
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
@option params [required, String] :preview_agents_arn
The ARN of the assessment target whose agents you want to preview.
@option params [String] :next_token
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the **PreviewAgents** action. Subsequent calls to the action fill **nextToken** in the request with the value of **NextToken** from the previous response to continue listing data.
@option params [Integer] :max_results
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
@return [Types::PreviewAgentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::PreviewAgentsResponse#agent_previews #agent_previews} => Array<Types::AgentPreview> * {Types::PreviewAgentsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Example: Preview agents
# Previews the agents installed on the EC2 instances that are part of the specified assessment target. resp = client.preview_agents({ max_results: 123, preview_agents_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", }) resp.to_h outputs the following: { agent_previews: [ { agent_id: "i-49113b93", }, ], next_token: "1", }
@example Request syntax with placeholder values
resp = client.preview_agents({ preview_agents_arn: "Arn", # required next_token: "PaginationToken", max_results: 1, })
@example Response structure
resp.agent_previews #=> Array resp.agent_previews[0].hostname #=> String resp.agent_previews[0].agent_id #=> String resp.agent_previews[0].auto_scaling_group #=> String resp.agent_previews[0].agent_health #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN" resp.agent_previews[0].agent_version #=> String resp.agent_previews[0].operating_system #=> String resp.agent_previews[0].kernel_version #=> String resp.agent_previews[0].ipv4_address #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/PreviewAgents AWS API Documentation
@overload preview_agents
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2614 def preview_agents(params = {}, options = {}) req = build_request(:preview_agents, params) req.send_request(options) end
Registers the IAM role that grants Amazon Inspector
access to AWS Services needed to perform security assessments.
@option params [required, String] :role_arn
The ARN of the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Example: Register cross account access role
# Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when # you call the PreviewAgents action. resp = client.register_cross_account_access_role({ role_arn: "arn:aws:iam::123456789012:role/inspector", })
@example Request syntax with placeholder values
resp = client.register_cross_account_access_role({ role_arn: "Arn", # required })
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/RegisterCrossAccountAccessRole AWS API Documentation
@overload register_cross_account_access_role
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2648 def register_cross_account_access_role(params = {}, options = {}) req = build_request(:register_cross_account_access_role, params) req.send_request(options) end
Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.
@option params [required, Array<String>] :finding_arns
The ARNs that specify the findings that you want to remove attributes from.
@option params [required, Array<String>] :attribute_keys
The array of attribute keys that you want to remove from specified findings.
@return [Types::RemoveAttributesFromFindingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::RemoveAttributesFromFindingsResponse#failed_items #failed_items} => Hash<String,Types::FailedItemDetails>
@example Example: Remove attributes from findings
# Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where # an attribute with the specified key exists. resp = client.remove_attributes_from_findings({ attribute_keys: [ "key=Example,value=example", ], finding_arns: [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU", ], }) resp.to_h outputs the following: { failed_items: { }, }
@example Request syntax with placeholder values
resp = client.remove_attributes_from_findings({ finding_arns: ["Arn"], # required attribute_keys: ["AttributeKey"], # required })
@example Response structure
resp.failed_items #=> Hash resp.failed_items["Arn"].failure_code #=> String, one of "INVALID_ARN", "DUPLICATE_ARN", "ITEM_DOES_NOT_EXIST", "ACCESS_DENIED", "LIMIT_EXCEEDED", "INTERNAL_ERROR" resp.failed_items["Arn"].retryable #=> Boolean
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/RemoveAttributesFromFindings AWS API Documentation
@overload remove_attributes_from_findings
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2707 def remove_attributes_from_findings(params = {}, options = {}) req = build_request(:remove_attributes_from_findings, params) req.send_request(options) end
Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.
@option params [required, String] :assessment_template_arn
The ARN of the assessment template of the assessment run that you want to start.
@option params [String] :assessment_run_name
You can specify the name for the assessment run. The name must be unique for the assessment template whose ARN is used to start the assessment run.
@return [Types::StartAssessmentRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::StartAssessmentRunResponse#assessment_run_arn #assessment_run_arn} => String
@example Example: Start assessment run
# Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must # not exceed the limit of running up to 500 concurrent agents per AWS account. resp = client.start_assessment_run({ assessment_run_name: "examplerun", assessment_template_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T", }) resp.to_h outputs the following: { assessment_run_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY", }
@example Request syntax with placeholder values
resp = client.start_assessment_run({ assessment_template_arn: "Arn", # required assessment_run_name: "AssessmentRunName", })
@example Response structure
resp.assessment_run_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/StartAssessmentRun AWS API Documentation
@overload start_assessment_run
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2808 def start_assessment_run(params = {}, options = {}) req = build_request(:start_assessment_run, params) req.send_request(options) end
Stops the assessment run that is specified by the ARN of the assessment run.
@option params [required, String] :assessment_run_arn
The ARN of the assessment run that you want to stop.
@option params [String] :stop_action
An input option that can be set to either START\_EVALUATION or SKIP\_EVALUATION. START\_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP\_EVALUATION cancels the assessment run immediately, after which no findings are generated.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Example: Stop assessment run
# Stops the assessment run that is specified by the ARN of the assessment run. resp = client.stop_assessment_run({ assessment_run_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe", })
@example Request syntax with placeholder values
resp = client.stop_assessment_run({ assessment_run_arn: "Arn", # required stop_action: "START_EVALUATION", # accepts START_EVALUATION, SKIP_EVALUATION })
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/StopAssessmentRun AWS API Documentation
@overload stop_assessment_run
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2848 def stop_assessment_run(params = {}, options = {}) req = build_request(:stop_assessment_run, params) req.send_request(options) end
Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
@option params [required, String] :resource_arn
The ARN of the assessment template that is used during the event for which you want to receive SNS notifications.
@option params [required, String] :event
The event for which you want to receive SNS notifications.
@option params [required, String] :topic_arn
The ARN of the SNS topic to which the SNS notifications are sent.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Example: Subscribe to event
# Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a # specified SNS topic. resp = client.subscribe_to_event({ event: "ASSESSMENT_RUN_COMPLETED", resource_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", topic_arn: "arn:aws:sns:us-west-2:123456789012:exampletopic", })
@example Request syntax with placeholder values
resp = client.subscribe_to_event({ resource_arn: "Arn", # required event: "ASSESSMENT_RUN_STARTED", # required, accepts ASSESSMENT_RUN_STARTED, ASSESSMENT_RUN_COMPLETED, ASSESSMENT_RUN_STATE_CHANGED, FINDING_REPORTED, OTHER topic_arn: "Arn", # required })
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/SubscribeToEvent AWS API Documentation
@overload subscribe_to_event
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2892 def subscribe_to_event(params = {}, options = {}) req = build_request(:subscribe_to_event, params) req.send_request(options) end
Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
@option params [required, String] :resource_arn
The ARN of the assessment template that is used during the event for which you want to stop receiving SNS notifications.
@option params [required, String] :event
The event for which you want to stop receiving SNS notifications.
@option params [required, String] :topic_arn
The ARN of the SNS topic to which SNS notifications are sent.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Example: Unsubscribe from event
# Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a # specified SNS topic. resp = client.unsubscribe_from_event({ event: "ASSESSMENT_RUN_COMPLETED", resource_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", topic_arn: "arn:aws:sns:us-west-2:123456789012:exampletopic", })
@example Request syntax with placeholder values
resp = client.unsubscribe_from_event({ resource_arn: "Arn", # required event: "ASSESSMENT_RUN_STARTED", # required, accepts ASSESSMENT_RUN_STARTED, ASSESSMENT_RUN_COMPLETED, ASSESSMENT_RUN_STATE_CHANGED, FINDING_REPORTED, OTHER topic_arn: "Arn", # required })
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/UnsubscribeFromEvent AWS API Documentation
@overload unsubscribe_from_event
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2936 def unsubscribe_from_event(params = {}, options = {}) req = build_request(:unsubscribe_from_event, params) req.send_request(options) end
Updates the assessment target that is specified by the ARN of the assessment target.
If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.
@option params [required, String] :assessment_target_arn
The ARN of the assessment target that you want to update.
@option params [required, String] :assessment_target_name
The name of the assessment target that you want to update.
@option params [String] :resource_group_arn
The ARN of the resource group that is used to specify the new resource group to associate with the assessment target.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Example: Update assessment target
# Updates the assessment target that is specified by the ARN of the assessment target. resp = client.update_assessment_target({ assessment_target_arn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX", assessment_target_name: "Example", resource_group_arn: "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-yNbgL5Pt", })
@example Request syntax with placeholder values
resp = client.update_assessment_target({ assessment_target_arn: "Arn", # required assessment_target_name: "AssessmentTargetName", # required resource_group_arn: "Arn", })
@see docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/UpdateAssessmentTarget AWS API Documentation
@overload update_assessment_target
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-inspector/client.rb, line 2982 def update_assessment_target(params = {}, options = {}) req = build_request(:update_assessment_target, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-inspector/client.rb, line 3006 def waiter_names [] end