Boto3 Docs 1.26.87 documentation

get_reveal_configuration¶

get_reveal_configuration()¶

Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

See also: AWS API Documentation

Request Syntax

response = client.get_reveal_configuration()

Return type

dict

Returns

Response Syntax

{
    'configuration': {
        'kmsKeyId': 'string',
        'status': 'ENABLED'|'DISABLED'
    }
}

Response Structure

(dict) --
The request succeeded.
- configuration (dict) --
  The current configuration settings and the status of the configuration for the account.
  - kmsKeyId (string) --
    The Amazon Resource Name (ARN), ID, or alias of the KMS key to use to encrypt sensitive data that's retrieved. The key must be an existing, customer managed, symmetric encryption key that's in the same Amazon Web Services Region as the Amazon Macie account.
    
    If this value specifies an alias, it must include the following prefix: alias/. If this value specifies a key that's owned by another Amazon Web Services account, it must specify the ARN of the key or the ARN of the key's alias.
  - status (string) --
    The status of the configuration for the Amazon Macie account. In a request, valid values are: ENABLED, enable the configuration for the account; and, DISABLED, disable the configuration for the account. In a response, possible values are: ENABLED, the configuration is currently enabled for the account; and, DISABLED, the configuration is currently disabled for the account.

Exceptions

Macie2.Client.exceptions.ThrottlingException
Macie2.Client.exceptions.ValidationException
Macie2.Client.exceptions.InternalServerException
Macie2.Client.exceptions.AccessDeniedException