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

Class: Aws::Inspector::Types::StopAssessmentRunRequest

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

Overview

Note:

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

{
  assessment_run_arn: "Arn", # required
  stop_action: "START_EVALUATION", # accepts START_EVALUATION, SKIP_EVALUATION
}

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_run_arnString

The ARN of the assessment run that you want to stop.

Returns:

  • (String)


2262
2263
2264
2265
2266
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 2262

class StopAssessmentRunRequest < Struct.new(
  :assessment_run_arn,
  :stop_action)
  include Aws::Structure
end

#stop_actionString

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.

Returns:

  • (String)


2262
2263
2264
2265
2266
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 2262

class StopAssessmentRunRequest < Struct.new(
  :assessment_run_arn,
  :stop_action)
  include Aws::Structure
end