Inspector / Client / describe_exclusions

describe_exclusions#

Inspector.Client.describe_exclusions(**kwargs)#

Describes the exclusions that are specified by the exclusions’ ARNs.

See also: AWS API Documentation

Request Syntax

response = client.describe_exclusions(
    exclusionArns=[
        'string',
    ],
    locale='EN_US'
)
Parameters:

  • exclusionArns (list) –

    [REQUIRED]

    The list of ARNs that specify the exclusions that you want to describe.

    • (string) –

  • locale (string) – The locale into which you want to translate the exclusion’s title, description, and recommendation.

Return type:

dict

Returns:

Response Syntax

{
    'exclusions': {
        'string': {
            'arn': 'string',
            'title': 'string',
            'description': 'string',
            'recommendation': 'string',
            'scopes': [
                {
                    'key': 'INSTANCE_ID'|'RULES_PACKAGE_ARN',
                    'value': 'string'
                },
            ],
            'attributes': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ]
        }
    },
    'failedItems': {
        'string': {
            'failureCode': 'INVALID_ARN'|'DUPLICATE_ARN'|'ITEM_DOES_NOT_EXIST'|'ACCESS_DENIED'|'LIMIT_EXCEEDED'|'INTERNAL_ERROR',
            'retryable': True|False
        }
    }
}

Response Structure

  • (dict) –

    • exclusions (dict) –

      Information about the exclusions.

      • (string) –

        • (dict) –

          Contains information about what was excluded from an assessment run.

          • arn (string) –

            The ARN that specifies the exclusion.

          • title (string) –

            The name of the exclusion.

          • description (string) –

            The description of the exclusion.

          • recommendation (string) –

            The recommendation for the exclusion.

          • scopes (list) –

            The AWS resources for which the exclusion pertains.

            • (dict) –

              This data type contains key-value pairs that identify various Amazon resources.

              • key (string) –

                The type of the scope.

              • value (string) –

                The resource identifier for the specified scope type.

          • attributes (list) –

            The system-defined attributes for the exclusion.

            • (dict) –

              This data type is used as a request parameter in the AddAttributesToFindings and CreateAssessmentTemplate actions.

              • key (string) –

                The attribute key.

              • value (string) –

                The value assigned to the attribute key.

    • failedItems (dict) –

      Exclusion details that cannot be described. An error code is provided for each failed item.

      • (string) –

        • (dict) –

          Includes details about the failed items.

          • failureCode (string) –

            The status code of a failed item.

          • retryable (boolean) –

            Indicates whether you can immediately retry a request for this item for a specified resource.

Exceptions

  • Inspector.Client.exceptions.InternalException

  • Inspector.Client.exceptions.InvalidInputException