Macie2 / Client / get_macie_session

get_macie_session#

Macie2.Client.get_macie_session()#

Retrieves the status and configuration settings for an Amazon Macie account.

Request Syntax

response = client.get_macie_session()

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'findingPublishingFrequency': 'FIFTEEN_MINUTES'|'ONE_HOUR'|'SIX_HOURS',
    'serviceRole': 'string',
    'status': 'PAUSED'|'ENABLED',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –

The request succeeded.
- createdAt (datetime) –
  
  The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.
- findingPublishingFrequency (string) –
  
  The frequency with which Amazon Macie publishes updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).
- serviceRole (string) –
  
  The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in Amazon Web Services resources for the account.
- status (string) –
  
  The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.
- updatedAt (datetime) –
  
  The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status or configuration settings for the Amazon Macie account.

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