Skip to content

GetRemediationsV2Request

Source code in docs_src/capo_securityhub/types/get_remediations_v2_request.py
class GetRemediationsV2Request(TypedDict, closed=True):
    target_uid: NotRequired[
        "capo_securityhub.types.remediation_string_uid.RemediationStringUid"
    ]
    """<p>The unique identifier (ID) of an existing remediation target to return. Returns the single matching target. You can't use <code>TargetUid</code> together with <code>MetadataUid</code> or <code>Filters</code>.</p>"""
    metadata_uid: NotRequired[
        "capo_securityhub.types.remediation_string_uid.RemediationStringUid"
    ]
    """<p>The unique identifier (ID) of the Security Hub exposure finding, found under the <code>metadata.uid</code> field of the finding. Returns the remediation targets associated with that finding. You can't use <code>MetadataUid</code> together with <code>TargetUid</code> or <code>Filters</code>.</p>"""
    filters: NotRequired[
        "capo_securityhub.types.remediation_filters.RemediationFilters"
    ]
    """<p>Filters remediation targets based on a set of criteria. You can't use <code>Filters</code> together with <code>TargetUid</code> or <code>MetadataUid</code>.</p>"""
    show_guidance: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Specifies whether to show remediation target guidance.</p>"""
    guidance_format: NotRequired[
        "capo_securityhub.types.guidance_format.GuidanceFormat"
    ]
    """<p>The format of the remediation guidance examples to return. Valid values are <code>All</code>, <code>AwsCli</code>, <code>Cli</code>, <code>Python</code>, <code>Terraform</code>, <code>Cdk</code>, <code>CloudFormation</code>, <code>IaC</code>, and <code>Template</code>. If you don't specify a value, all formats are returned. Applies only when <code>ShowGuidance</code> is <code>true</code>.</p>"""
    max_results: NotRequired["capo_securityhub.types.max_results.MaxResults"]
    """<p>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.</p>"""
    next_token: NotRequired["capo_securityhub.types.next_token.NextToken"]
    """<p>The token used to paginate the remediations target list returned. On your first call to <code>GetRemediationsV2</code>, omit this parameter or set it to <code>NULL</code>. For subsequent calls, use the <code>NextToken</code> value returned in the previous response to retrieve the next page of results.</p>"""

filters instance-attribute

filters: NotRequired[RemediationFilters]

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

guidance_format instance-attribute

guidance_format: NotRequired[GuidanceFormat]

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.

max_results instance-attribute

max_results: NotRequired[MaxResults]

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.

metadata_uid instance-attribute

metadata_uid: NotRequired[RemediationStringUid]

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.

next_token instance-attribute

next_token: NotRequired[NextToken]

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.

show_guidance instance-attribute

show_guidance: NotRequired[Boolean]

Specifies whether to show remediation target guidance.

target_uid instance-attribute

target_uid: NotRequired[RemediationStringUid]

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.