SecurityHub / Client / list_exposures_by_remediation_v2

list_exposures_by_remediation_v2

SecurityHub.Client.list_exposures_by_remediation_v2(**kwargs)

Retrieves the exposure findings tied to a specific remediation target. Results are sorted by previous severity, highest first, and are paginated.

See also: AWS API Documentation

Request Syntax

response = client.list_exposures_by_remediation_v2(
    TargetUid='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • TargetUid (string) –

    [REQUIRED]

    The unique identifier (ID) of an existing remediation target to list exposure findings for.

  • MaxResults (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.

  • NextToken (string) – The token used to paginate the exposures list returned. On your first call to ListExposuresByRemediationV2, 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.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'MetadataUid': 'string',
            'Title': 'string',
            'PreviousSeverity': 'Informational'|'Low'|'Medium'|'High'|'Critical',
            'ProjectedSeverity': 'Informational'|'Low'|'Medium'|'High'|'Critical',
            'Impact': 'Reduces'|'Resolves'|'Unchanged'
        },
    ],
    'TargetUid': 'string',
    'Resource': {
        'AccountId': 'string',
        'Region': 'string',
        'ResourceOwnerAccountId': 'string',
        'ResourceOwnerOrgId': 'string',
        'Type': 'string',
        'Name': 'string',
        'Id': 'string',
        'ResourceGuid': 'string',
        'ResourceRegion': 'string',
        'CloudProvider': 'Azure'|'AWS'
    },
    'TotalCount': 123,
    'Trait': {
        'Type': 'string',
        'Title': 'string'
    },
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      An array of exposure findings returned by the operation.

      • (dict) –

        Provides details about an exposure finding and the effect the specific remediation target has on it.

        • MetadataUid (string) –

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

        • Title (string) –

          The title of the exposure finding.

        • PreviousSeverity (string) –

          The severity of the exposure finding before the remediation target is resolved.

        • ProjectedSeverity (string) –

          The severity of the exposure finding after the remediation target is resolved.

        • Impact (string) –

          The impact resolving a remediation target has on the exposure finding.

          • Reduces specifies that resolving the remediation target lowers the severity of the exposure finding, but does not resolve it.

          • Resolves specifies that resolving the remediation target resolves the exposure finding.

          • Unchanged specifies that resolving the remediation target does not change the severity of the exposure finding.

    • TargetUid (string) –

      The unique identifier (ID) of the remediation target that the exposure findings are associated with.

    • Resource (dict) –

      Provides comprehensive details about a resource.

      • AccountId (string) –

        The Amazon Web Services account that recorded the resource data in Security Hub.

      • Region (string) –

        The Amazon Web Services Region in which Security Hub recorded the resource data.

      • ResourceOwnerAccountId (string) –

        The identifier of the cloud account that owns the resource. For Amazon Web Services resources, this is the Amazon Web Services account ID. For Azure resources, this is the Azure subscription ID.

      • ResourceOwnerOrgId (string) –

        The identifier of the cloud organization that owns the resource. For Amazon Web Services resources, this is the Organizations ID. For Azure resources, this is the Azure tenant ID.

      • Type (string) –

        The type of the resource.

      • Name (string) –

        The name of the resource.

      • Id (string) –

        The unique identifier for a resource.

      • ResourceGuid (string) –

        The global identifier used to identify a resource.

      • ResourceRegion (string) –

        The native cloud region where the resource is located. For Amazon Web Services, this is an Amazon Web Services Region (for example, us-east-1). For Azure resources, this is the Azure region (for example, westus2). This field is always included.

      • CloudProvider (string) –

        The cloud provider where the resource exists.

        • AWS specifies that the resource exists in Amazon Web Services.

        • Azure specifies that the resource exists in Microsoft Azure.

    • TotalCount (integer) –

      The total count of exposure findings associated with the remediation target.

    • Trait (dict) –

      The specific trait associated with the remediation target.

      • Type (string) –

        The trait type.

      • Title (string) –

        The trait title.

    • NextToken (string) –

      The pagination token to use to request the next page of results. Otherwise, this parameter is null.

Exceptions