CloudWatchLogs / Client / put_account_policy
put_account_policy#
- CloudWatchLogs.Client.put_account_policy(**kwargs)#
Creates an account-level data protection policy that applies to all log groups in the account. A data protection policy can help safeguard sensitive data that’s ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level policy.
Warning
Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.
If you use
PutAccountPolicy
to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the
logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with theunmask
parameter set totrue
to view the unmasked log events. Users with thelogs:Unmask
can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with theunmask
query command.For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
To use the
PutAccountPolicy
operation, you must be signed on with thelogs:PutDataProtectionPolicy
andlogs:PutAccountPolicy
permissions.The
PutAccountPolicy
operation applies to all log groups in the account. You can also use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.See also: AWS API Documentation
Request Syntax
response = client.put_account_policy( policyName='string', policyDocument='string', policyType='DATA_PROTECTION_POLICY', scope='ALL' )
- Parameters:
policyName (string) –
[REQUIRED]
A name for the policy. This must be unique within the account.
policyDocument (string) –
[REQUIRED]
Specify the data protection policy, in JSON.
This policy must include two JSON blocks:
The first block must include both a
DataIdentifer
array and anOperation
property with anAudit
action. TheDataIdentifer
array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask. TheOperation
property with anAudit
action is required to find the sensitive data terms. ThisAudit
action must contain aFindingsDestination
object. You can optionally use thatFindingsDestination
object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, they must already exist.The second block must include both a
DataIdentifer
array and anOperation
property with anDeidentify
action. TheDataIdentifer
array must exactly match theDataIdentifer
array in the first block of the policy. TheOperation
property with theDeidentify
action is what actually masks the data, and it must contain the"MaskConfig": {}
object. The"MaskConfig": {}
object must be empty.
For an example data protection policy, see the Examples section on this page.
Warning
The contents of the two
DataIdentifer
arrays must match exactly.In addition to the two JSON blocks, the
policyDocument
can also includeName
,Description
, andVersion
fields. TheName
is different than the operation’spolicyName
parameter, and is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.The JSON specified in
policyDocument
can be up to 30,720 characters.policyType (string) –
[REQUIRED]
Currently the only valid value for this parameter is
DATA_PROTECTION_POLICY
.scope (string) – Currently the only valid value for this parameter is
ALL
, which specifies that the data protection policy applies to all log groups in the account. If you omit this parameter, the default ofALL
is used.
- Return type:
dict
- Returns:
Response Syntax
{ 'accountPolicy': { 'policyName': 'string', 'policyDocument': 'string', 'lastUpdatedTime': 123, 'policyType': 'DATA_PROTECTION_POLICY', 'scope': 'ALL', 'accountId': 'string' } }
Response Structure
(dict) –
accountPolicy (dict) –
The account policy that you created.
policyName (string) –
The name of the account policy.
policyDocument (string) –
The policy document for this account policy.
The JSON specified in
policyDocument
can be up to 30,720 characters.lastUpdatedTime (integer) –
The date and time that this policy was most recently updated.
policyType (string) –
The type of policy for this account policy.
scope (string) –
The scope of the account policy.
accountId (string) –
The Amazon Web Services account ID that the policy applies to.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterException
CloudWatchLogs.Client.exceptions.OperationAbortedException
CloudWatchLogs.Client.exceptions.ServiceUnavailableException
CloudWatchLogs.Client.exceptions.LimitExceededException