Macie2 / Client / enable_macie

enable_macie#

Macie2.Client.enable_macie(**kwargs)#

Enables Amazon Macie and specifies the configuration settings for a Macie account.

See also: AWS API Documentation

Request Syntax

response = client.enable_macie(
    clientToken='string',
    findingPublishingFrequency='FIFTEEN_MINUTES'|'ONE_HOUR'|'SIX_HOURS',
    status='PAUSED'|'ENABLED'
)
Parameters:

  • clientToken (string) –

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • findingPublishingFrequency (string) – Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).

  • status (string) – Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to ENABLED.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The request succeeded and there isn’t any content to include in the body of the response (No Content).

Exceptions

  • Macie2.Client.exceptions.ValidationException

  • Macie2.Client.exceptions.InternalServerException

  • Macie2.Client.exceptions.ServiceQuotaExceededException

  • Macie2.Client.exceptions.AccessDeniedException

  • Macie2.Client.exceptions.ResourceNotFoundException

  • Macie2.Client.exceptions.ThrottlingException

  • Macie2.Client.exceptions.ConflictException