Class: Aws::Inspector::Types::GetExclusionsPreviewRequest

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

{
  assessment_template_arn: "Arn", # required
  preview_token: "UUID", # required
  next_token: "PaginationToken",
  max_results: 1,
  locale: "EN_US", # accepts EN_US
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_template_arnString

The ARN that specifies the assessment template for which the exclusions preview was requested.

Returns:

  • (String)


1771
1772
1773
1774
1775
1776
1777
1778
1779
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1771

class GetExclusionsPreviewRequest < Struct.new(
  :assessment_template_arn,
  :preview_token,
  :next_token,
  :max_results,
  :locale)
  SENSITIVE = []
  include Aws::Structure
end

#localeString

The locale into which you want to translate the exclusion's title, description, and recommendation.

Returns:

  • (String)


1771
1772
1773
1774
1775
1776
1777
1778
1779
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1771

class GetExclusionsPreviewRequest < Struct.new(
  :assessment_template_arn,
  :preview_token,
  :next_token,
  :max_results,
  :locale)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


1771
1772
1773
1774
1775
1776
1777
1778
1779
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1771

class GetExclusionsPreviewRequest < Struct.new(
  :assessment_template_arn,
  :preview_token,
  :next_token,
  :max_results,
  :locale)
  SENSITIVE = []
  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 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.

Returns:

  • (String)


1771
1772
1773
1774
1775
1776
1777
1778
1779
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1771

class GetExclusionsPreviewRequest < Struct.new(
  :assessment_template_arn,
  :preview_token,
  :next_token,
  :max_results,
  :locale)
  SENSITIVE = []
  include Aws::Structure
end

#preview_tokenString

The unique identifier associated of the exclusions preview.

Returns:

  • (String)


1771
1772
1773
1774
1775
1776
1777
1778
1779
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1771

class GetExclusionsPreviewRequest < Struct.new(
  :assessment_template_arn,
  :preview_token,
  :next_token,
  :max_results,
  :locale)
  SENSITIVE = []
  include Aws::Structure
end