CloudTrail.Client.create_trail(**kwargs)¶Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
See also: AWS API Documentation
Request Syntax
response = client.create_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,
TagsList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Specifies the name of the trail. The name must meet the following requirements:
my-_namespace and my--namespace are not valid.[REQUIRED]
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
Specifies whether log file integrity 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.
Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. You must use a log group that exists in your account.
Not required unless you specify CloudWatchLogsRoleArn .
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/MyAliasNamearn:aws:kms:us-east-2:123456789012:alias/MyAliasNamearn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-12345678901212345678-1234-1234-1234-123456789012A list of tags.
A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, or channel.
The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.
The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
dict
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 CloudTrail 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 format of a topic ARN is:
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 created. The format of a trail ARN is:
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 will be 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 events 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.MaximumNumberOfTrailsExceededExceptionCloudTrail.Client.exceptions.TrailAlreadyExistsExceptionCloudTrail.Client.exceptions.S3BucketDoesNotExistExceptionCloudTrail.Client.exceptions.InsufficientS3BucketPolicyExceptionCloudTrail.Client.exceptions.InsufficientSnsTopicPolicyExceptionCloudTrail.Client.exceptions.InsufficientEncryptionPolicyExceptionCloudTrail.Client.exceptions.InvalidS3BucketNameExceptionCloudTrail.Client.exceptions.InvalidS3PrefixExceptionCloudTrail.Client.exceptions.InvalidSnsTopicNameExceptionCloudTrail.Client.exceptions.InvalidKmsKeyIdExceptionCloudTrail.Client.exceptions.InvalidTrailNameExceptionCloudTrail.Client.exceptions.TrailNotProvidedExceptionCloudTrail.Client.exceptions.TagsLimitExceededExceptionCloudTrail.Client.exceptions.InvalidParameterCombinationExceptionCloudTrail.Client.exceptions.KmsKeyNotFoundExceptionCloudTrail.Client.exceptions.KmsKeyDisabledExceptionCloudTrail.Client.exceptions.KmsExceptionCloudTrail.Client.exceptions.InvalidCloudWatchLogsLogGroupArnExceptionCloudTrail.Client.exceptions.InvalidCloudWatchLogsRoleArnExceptionCloudTrail.Client.exceptions.CloudWatchLogsDeliveryUnavailableExceptionCloudTrail.Client.exceptions.InvalidTagParameterExceptionCloudTrail.Client.exceptions.UnsupportedOperationExceptionCloudTrail.Client.exceptions.OperationNotPermittedExceptionCloudTrail.Client.exceptions.CloudTrailAccessNotEnabledExceptionCloudTrail.Client.exceptions.InsufficientDependencyServiceAccessPermissionExceptionCloudTrail.Client.exceptions.NotOrganizationMasterAccountExceptionCloudTrail.Client.exceptions.OrganizationsNotInUseExceptionCloudTrail.Client.exceptions.OrganizationNotInAllFeaturesModeExceptionCloudTrail.Client.exceptions.NoManagementAccountSLRExistsExceptionCloudTrail.Client.exceptions.CloudTrailInvalidClientTokenIdExceptionCloudTrail.Client.exceptions.ConflictException