Macie2 / Client / get_sensitive_data_occurrences_availability

get_sensitive_data_occurrences_availability#

Macie2.Client.get_sensitive_data_occurrences_availability(**kwargs)#

Checks whether occurrences of sensitive data can be retrieved for a finding.

See also: AWS API Documentation

Request Syntax

response = client.get_sensitive_data_occurrences_availability(
    findingId='string'
)
Parameters:

findingId (string) –

[REQUIRED]

The unique identifier for the finding.

Return type:

dict

Returns:

Response Syntax

{
    'code': 'AVAILABLE'|'UNAVAILABLE',
    'reasons': [
        'OBJECT_EXCEEDS_SIZE_QUOTA'|'UNSUPPORTED_OBJECT_TYPE'|'UNSUPPORTED_FINDING_TYPE'|'INVALID_CLASSIFICATION_RESULT'|'OBJECT_UNAVAILABLE',
    ]
}

Response Structure

  • (dict) –

    The request succeeded.

    • code (string) –

      Specifies whether occurrences of sensitive data can be retrieved for the finding. Possible values are: AVAILABLE, the sensitive data can be retrieved; and, UNAVAILABLE, the sensitive data can’t be retrieved. If this value is UNAVAILABLE, the reasons array indicates why the data can’t be retrieved.

    • reasons (list) –

      Specifies why occurrences of sensitive data can’t be retrieved for the finding. Possible values are:

      • INVALID_CLASSIFICATION_RESULT - Amazon Macie can’t verify the location of the sensitive data to retrieve. There isn’t a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the classificationDetails.detailedResultsLocation field of the finding isn’t available, is malformed or corrupted, or uses an unsupported storage format.

      • OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data.

      • OBJECT_UNAVAILABLE - The affected S3 object isn’t available. The object might have been renamed, moved, or deleted. Or the object was changed after Macie created the finding.

      • UNSUPPORTED_FINDING_TYPE - The specified finding isn’t a sensitive data finding.

      • UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn’t support for retrieving occurrences of sensitive data.

      This value is null if sensitive data can be retrieved for the finding.

      • (string) –

        Specifies why occurrences of sensitive data can’t be retrieved for a finding. Possible values are:

Exceptions

  • Macie2.Client.exceptions.ResourceNotFoundException

  • Macie2.Client.exceptions.ThrottlingException

  • Macie2.Client.exceptions.InternalServerException

  • Macie2.Client.exceptions.AccessDeniedException