CreateTrail
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
Request Syntax
{
"CloudWatchLogsLogGroupArn": "string
",
"CloudWatchLogsRoleArn": "string
",
"EnableLogFileValidation": boolean
,
"IncludeGlobalServiceEvents": boolean
,
"IsMultiRegionTrail": boolean
,
"IsOrganizationTrail": boolean
,
"KmsKeyId": "string
",
"Name": "string
",
"S3BucketName": "string
",
"S3KeyPrefix": "string
",
"SnsTopicName": "string
",
"TagsList": [
{
"Key": "string
",
"Value": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- CloudWatchLogsLogGroupArn
-
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
.Type: String
Required: No
- CloudWatchLogsRoleArn
-
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.
Type: String
Required: No
- EnableLogFileValidation
-
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.
Type: Boolean
Required: No
- IncludeGlobalServiceEvents
-
Specifies whether the trail is publishing events from global services such as IAM to the log files.
Type: Boolean
Required: No
- IsMultiRegionTrail
-
Specifies whether the trail is created in the current Region or in all Regions. The default is false, which creates a trail only in the Region where you are signed in. As a best practice, consider creating trails that log events in all Regions.
Type: Boolean
Required: No
- IsOrganizationTrail
-
Specifies whether the trail is created for all accounts in an organization in Amazon 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 or delegated administrator account for an organization in Amazon Organizations.
Type: Boolean
Required: No
- KmsKeyId
-
Specifies the Amazon 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 Amazon KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Amazon 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
Type: String
Required: No
-
- Name
-
Specifies the name of the trail. The name 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
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
Type: String
Required: Yes
-
- S3BucketName
-
Specifies the name of the Amazon S3 bucket designated for publishing log files. For information about bucket naming rules, see Bucket naming rules in the Amazon Simple Storage Service User Guide.
Type: String
Required: Yes
- S3KeyPrefix
-
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.
Type: String
Required: No
- SnsTopicName
-
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
Type: String
Required: No
- TagsList
-
A list of tags.
Type: Array of Tag objects
Array Members: Maximum number of 200 items.
Required: No
Response Syntax
{
"CloudWatchLogsLogGroupArn": "string",
"CloudWatchLogsRoleArn": "string",
"IncludeGlobalServiceEvents": boolean,
"IsMultiRegionTrail": boolean,
"IsOrganizationTrail": boolean,
"KmsKeyId": "string",
"LogFileValidationEnabled": boolean,
"Name": "string",
"S3BucketName": "string",
"S3KeyPrefix": "string",
"SnsTopicARN": "string",
"SnsTopicName": "string",
"TrailARN": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CloudWatchLogsLogGroupArn
-
Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
Type: String
- CloudWatchLogsRoleArn
-
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
Type: String
- IncludeGlobalServiceEvents
-
Specifies whether the trail is publishing events from global services such as IAM to the log files.
Type: Boolean
- IsMultiRegionTrail
-
Specifies whether the trail exists in one Region or in all Regions.
Type: Boolean
- IsOrganizationTrail
-
Specifies whether the trail is an organization trail.
Type: Boolean
- KmsKeyId
-
Specifies the Amazon KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a Amazon KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
Type: String
- LogFileValidationEnabled
-
Specifies whether log file integrity validation is enabled.
Type: Boolean
- Name
-
Specifies the name of the trail.
Type: String
- S3BucketName
-
Specifies the name of the Amazon S3 bucket designated for publishing log files.
Type: String
- S3KeyPrefix
-
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.
Type: String
- SnsTopicARN
-
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
Type: String
- SnsTopicName
-
This parameter has been deprecated.
This field is no longer in use. Use
SnsTopicARN
.Type: String
- TrailARN
-
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
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- CloudTrailAccessNotEnabledException
-
This exception is thrown when trusted access has not been enabled between Amazon CloudTrail and Amazon Organizations. For more information, see How to enable or disable trusted access in the Amazon Organizations User Guide and Prepare For Creating a Trail For Your Organization in the Amazon CloudTrail User Guide.
HTTP Status Code: 400
- CloudTrailInvalidClientTokenIdException
-
This exception is thrown when a call results in the
InvalidClientTokenId
error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account.HTTP Status Code: 400
- CloudWatchLogsDeliveryUnavailableException
-
Cannot set a CloudWatch Logs delivery for this Region.
HTTP Status Code: 400
- ConflictException
-
This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
HTTP Status Code: 400
- InsufficientDependencyServiceAccessPermissionException
-
This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
HTTP Status Code: 400
- InsufficientEncryptionPolicyException
-
For the
CreateTrail
PutInsightSelectors
,UpdateTrail
,StartQuery
, andStartImport
operations, this exception is thrown when the policy on the S3 bucket or Amazon KMS key does not have sufficient permissions for the operation.For all other operations, this exception is thrown when the policy for the Amazon KMS key does not have sufficient permissions for the operation.
HTTP Status Code: 400
- InsufficientS3BucketPolicyException
-
This exception is thrown when the policy on the S3 bucket is not sufficient.
HTTP Status Code: 400
- InsufficientSnsTopicPolicyException
-
This exception is thrown when the policy on the Amazon SNS topic is not sufficient.
HTTP Status Code: 400
- InvalidCloudWatchLogsLogGroupArnException
-
This exception is thrown when the provided CloudWatch Logs log group is not valid.
HTTP Status Code: 400
- InvalidCloudWatchLogsRoleArnException
-
This exception is thrown when the provided role is not valid.
HTTP Status Code: 400
- InvalidKmsKeyIdException
-
This exception is thrown when the Amazon KMS key ARN is not valid.
HTTP Status Code: 400
- InvalidParameterCombinationException
-
This exception is thrown when the combination of parameters provided is not valid.
HTTP Status Code: 400
- InvalidParameterException
-
The request includes a parameter that is not valid.
HTTP Status Code: 400
- InvalidS3BucketNameException
-
This exception is thrown when the provided S3 bucket name is not valid.
HTTP Status Code: 400
- InvalidS3PrefixException
-
This exception is thrown when the provided S3 prefix is not valid.
HTTP Status Code: 400
- InvalidSnsTopicNameException
-
This exception is thrown when the provided SNS topic name is not valid.
HTTP Status Code: 400
- InvalidTagParameterException
-
This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
HTTP Status Code: 400
- InvalidTrailNameException
-
This exception is thrown when the provided trail name is not valid. Trail names 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
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
HTTP Status Code: 400
-
- KmsException
-
This exception is thrown when there is an issue with the specified Amazon KMS key and the trail or event data store can't be updated.
HTTP Status Code: 400
- KmsKeyDisabledException
-
This error has been deprecated.
This exception is no longer in use.
HTTP Status Code: 400
- KmsKeyNotFoundException
-
This exception is thrown when the Amazon KMS key does not exist, when the S3 bucket and the Amazon KMS key are not in the same Region, or when the Amazon KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.
HTTP Status Code: 400
- MaximumNumberOfTrailsExceededException
-
This exception is thrown when the maximum number of trails is reached.
HTTP Status Code: 400
- NoManagementAccountSLRExistsException
-
This exception is thrown when the management account does not have a service-linked role.
HTTP Status Code: 400
- NotOrganizationMasterAccountException
-
This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Amazon Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.
HTTP Status Code: 400
- OperationNotPermittedException
-
This exception is thrown when the requested operation is not permitted.
HTTP Status Code: 400
- OrganizationNotInAllFeaturesModeException
-
This exception is thrown when Amazon Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
HTTP Status Code: 400
- OrganizationsNotInUseException
-
This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
HTTP Status Code: 400
- S3BucketDoesNotExistException
-
This exception is thrown when the specified S3 bucket does not exist.
HTTP Status Code: 400
- TagsLimitExceededException
-
The number of tags per trail, event data store, dashboard, or channel has exceeded the permitted amount. Currently, the limit is 50.
HTTP Status Code: 400
- ThrottlingException
-
This exception is thrown when the request rate exceeds the limit.
HTTP Status Code: 400
- TrailAlreadyExistsException
-
This exception is thrown when the specified trail already exists.
HTTP Status Code: 400
- TrailNotProvidedException
-
This exception is no longer in use.
HTTP Status Code: 400
- UnsupportedOperationException
-
This exception is thrown when the requested operation is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: