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

Class: Aws::Inspector::Types::PreviewAgentsRequest

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 PreviewAgentsRequest data as a hash:

{
  preview_agents_arn: "Arn", # required
  next_token: "PaginationToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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.

Returns:

  • (Integer)


2325
2326
2327
2328
2329
2330
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 2325

class PreviewAgentsRequest < Struct.new(
  :preview_agents_arn,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


2325
2326
2327
2328
2329
2330
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 2325

class PreviewAgentsRequest < Struct.new(
  :preview_agents_arn,
  :next_token,
  :max_results)
  include Aws::Structure
end

#preview_agents_arnString

The ARN of the assessment target whose agents you want to preview.

Returns:

  • (String)


2325
2326
2327
2328
2329
2330
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 2325

class PreviewAgentsRequest < Struct.new(
  :preview_agents_arn,
  :next_token,
  :max_results)
  include Aws::Structure
end