CloudTrail / Client / update_trail

update_trail#

CloudTrail.Client.update_trail(**kwargs)#

Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the Region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

Request Syntax

response = client.update_trail(
    Name='string',
    S3BucketName='string',
    S3KeyPrefix='string',
    SnsTopicName='string',
    IncludeGlobalServiceEvents=True|False,
    IsMultiRegionTrail=True|False,
    EnableLogFileValidation=True|False,
    CloudWatchLogsLogGroupArn='string',
    CloudWatchLogsRoleArn='string',
    KmsKeyId='string',
    IsOrganizationTrail=True|False
)

Parameters:

Name (string) –
[REQUIRED]

Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the following requirements:
- Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
- Start with a letter or number, and end with a letter or number
- Be between 3 and 128 characters
- Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.
- Not be in IP address format (for example, 192.168.5.4)
If Name is a trail ARN, it must be in the following format.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
S3BucketName (string) – Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
S3KeyPrefix (string) – Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
SnsTopicName (string) – Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
IncludeGlobalServiceEvents (boolean) – Specifies whether the trail is publishing events from global services such as IAM to the log files.
IsMultiRegionTrail (boolean) – Specifies whether the trail applies only to the current Region or to all Regions. The default is false. If the trail exists only in the current Region and this value is set to true, shadow trails (replications of the trail) will be created in the other Regions. If the trail exists in all Regions and this value is set to false, the trail will remain in the Region where it was created, and its shadow trails in other Regions will be deleted. As a best practice, consider using trails that log events in all Regions.
EnableLogFileValidation (boolean) –
Specifies whether log file validation is enabled. The default is false.

Note
When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
CloudWatchLogsLogGroupArn (string) –
Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. You must use a log group that exists in your account.

Not required unless you specify CloudWatchLogsRoleArn.

Note
Only the management account can configure a CloudWatch Logs log group for an organization trail.
CloudWatchLogsRoleArn (string) – Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group. You must use a role that exists in your account.
KmsKeyId (string) –
Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by “alias/”, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

Examples:
- alias/MyAliasName
- arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
- arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
- 12345678-1234-1234-1234-123456789012
IsOrganizationTrail (boolean) –
Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all Amazon Web Services accounts that belong to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current Amazon Web Services account but be deleted from all member accounts in the organization.

Note
Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to an organization trail.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'S3BucketName': 'string',
    'S3KeyPrefix': 'string',
    'SnsTopicName': 'string',
    'SnsTopicARN': 'string',
    'IncludeGlobalServiceEvents': True|False,
    'IsMultiRegionTrail': True|False,
    'TrailARN': 'string',
    'LogFileValidationEnabled': True|False,
    'CloudWatchLogsLogGroupArn': 'string',
    'CloudWatchLogsRoleArn': 'string',
    'KmsKeyId': 'string',
    'IsOrganizationTrail': True|False
}

Response Structure

(dict) –

Returns the objects or data listed below if successful. Otherwise, returns an error.
- Name (string) –
  
  Specifies the name of the trail.
- S3BucketName (string) –
  
  Specifies the name of the Amazon S3 bucket designated for publishing log files.
- S3KeyPrefix (string) –
  
  Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your IAM Log Files.
- SnsTopicName (string) –
  
  This field is no longer in use. Use SnsTopicARN.
- SnsTopicARN (string) –
  
  Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.
  
  arn:aws:sns:us-east-2:123456789012:MyTopic
- IncludeGlobalServiceEvents (boolean) –
  
  Specifies whether the trail is publishing events from global services such as IAM to the log files.
- IsMultiRegionTrail (boolean) –
  
  Specifies whether the trail exists in one Region or in all Regions.
- TrailARN (string) –
  
  Specifies the ARN of the trail that was updated. The following is the format of a trail ARN.
  
  arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
- LogFileValidationEnabled (boolean) –
  
  Specifies whether log file integrity validation is enabled.
- CloudWatchLogsLogGroupArn (string) –
  
  Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs are delivered.
- CloudWatchLogsRoleArn (string) –
  
  Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.
- KmsKeyId (string) –
  
  Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.
  
  arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
- IsOrganizationTrail (boolean) –
  
  Specifies whether the trail is an organization trail.

Exceptions

CloudTrail.Client.exceptions.S3BucketDoesNotExistException
CloudTrail.Client.exceptions.InsufficientS3BucketPolicyException
CloudTrail.Client.exceptions.InsufficientSnsTopicPolicyException
CloudTrail.Client.exceptions.InsufficientEncryptionPolicyException
CloudTrail.Client.exceptions.TrailNotFoundException
CloudTrail.Client.exceptions.InvalidS3BucketNameException
CloudTrail.Client.exceptions.InvalidS3PrefixException
CloudTrail.Client.exceptions.InvalidSnsTopicNameException
CloudTrail.Client.exceptions.InvalidKmsKeyIdException
CloudTrail.Client.exceptions.InvalidTrailNameException
CloudTrail.Client.exceptions.TrailNotProvidedException
CloudTrail.Client.exceptions.InvalidEventSelectorsException
CloudTrail.Client.exceptions.CloudTrailARNInvalidException
CloudTrail.Client.exceptions.ConflictException
CloudTrail.Client.exceptions.ThrottlingException
CloudTrail.Client.exceptions.InvalidParameterCombinationException
CloudTrail.Client.exceptions.InvalidHomeRegionException
CloudTrail.Client.exceptions.KmsKeyNotFoundException
CloudTrail.Client.exceptions.KmsKeyDisabledException
CloudTrail.Client.exceptions.KmsException
CloudTrail.Client.exceptions.InvalidCloudWatchLogsLogGroupArnException
CloudTrail.Client.exceptions.InvalidCloudWatchLogsRoleArnException
CloudTrail.Client.exceptions.CloudWatchLogsDeliveryUnavailableException
CloudTrail.Client.exceptions.UnsupportedOperationException
CloudTrail.Client.exceptions.OperationNotPermittedException
CloudTrail.Client.exceptions.CloudTrailAccessNotEnabledException
CloudTrail.Client.exceptions.InsufficientDependencyServiceAccessPermissionException
CloudTrail.Client.exceptions.OrganizationsNotInUseException
CloudTrail.Client.exceptions.NotOrganizationMasterAccountException
CloudTrail.Client.exceptions.OrganizationNotInAllFeaturesModeException
CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException
CloudTrail.Client.exceptions.CloudTrailInvalidClientTokenIdException
CloudTrail.Client.exceptions.InvalidParameterException