Class: Aws::SecurityHub::Types::GetRemediationsV2Request

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::GetRemediationsV2Request

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Types::RemediationFilters

  Filters remediation targets based on a set of criteria.

• #guidance_format ⇒ String

  The format of the remediation guidance examples to return.

• #max_results ⇒ Integer

  The maximum number of results to return.

• #metadata_uid ⇒ String

  The unique identifier (ID) of the Security Hub exposure finding, found under the metadata.uid field of the finding.

• #next_token ⇒ String

  The token used to paginate the remediations target list returned.

• #show_guidance ⇒ Boolean

  Specifies whether to show remediation target guidance.

• #target_uid ⇒ String

  The unique identifier (ID) of an existing remediation target to return.

Instance Attribute Details

#filters ⇒ Types::RemediationFilters

Filters remediation targets based on a set of criteria. You can't use Filters together with TargetUid or MetadataUid.

Returns:

• (Types::RemediationFilters)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27566

class GetRemediationsV2Request < Struct.new(
  :target_uid,
  :metadata_uid,
  :filters,
  :show_guidance,
  :guidance_format,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#guidance_format ⇒ String

The format of the remediation guidance examples to return. Valid values are All, AwsCli, Cli, Python, Terraform, Cdk, CloudFormation, IaC, and Template. If you don't specify a value, all formats are returned. Applies only when ShowGuidance is true.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27566

class GetRemediationsV2Request < Struct.new(
  :target_uid,
  :metadata_uid,
  :filters,
  :show_guidance,
  :guidance_format,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return. Valid range is 1-100. If you don't specify a value, the operation returns up to 25 results.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27566

class GetRemediationsV2Request < Struct.new(
  :target_uid,
  :metadata_uid,
  :filters,
  :show_guidance,
  :guidance_format,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_uid ⇒ String

The unique identifier (ID) of the Security Hub exposure finding, found under the metadata.uid field of the finding. Returns the remediation targets associated with that finding. You can't use MetadataUid together with TargetUid or Filters.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27566

class GetRemediationsV2Request < Struct.new(
  :target_uid,
  :metadata_uid,
  :filters,
  :show_guidance,
  :guidance_format,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token used to paginate the remediations target list returned. On your first call to GetRemediationsV2, omit this parameter or set it to NULL. For subsequent calls, use the NextToken value returned in the previous response to retrieve the next page of results.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27566

class GetRemediationsV2Request < Struct.new(
  :target_uid,
  :metadata_uid,
  :filters,
  :show_guidance,
  :guidance_format,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#show_guidance ⇒ Boolean

Specifies whether to show remediation target guidance.

Returns:

• (Boolean)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27566

class GetRemediationsV2Request < Struct.new(
  :target_uid,
  :metadata_uid,
  :filters,
  :show_guidance,
  :guidance_format,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#target_uid ⇒ String

The unique identifier (ID) of an existing remediation target to return. Returns the single matching target. You can't use TargetUid together with MetadataUid or Filters.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27566

class GetRemediationsV2Request < Struct.new(
  :target_uid,
  :metadata_uid,
  :filters,
  :show_guidance,
  :guidance_format,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end