{
"api_version": "2013-11-01",
"type": "json",
"json_version": 1.1,
"target_prefix": "com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101",
"signature_version": "v4",
"service_full_name": "AWS CloudTrail",
"service_abbreviation": "CloudTrail",
"endpoint_prefix": "cloudtrail",
"xmlnamespace": "http://cloudtrail.amazonaws.com/doc/2013-11-01/",
"documentation": "\n
This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
\nCloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.
\n \n \nSee the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.
", "operations": { "CreateTrail": { "name": "CreateTrail", "input": { "shape_name": "CreateTrailRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the trail.
\n \n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the Amazon S3 bucket designated for publishing log files.
\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.
\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the Amazon SNS topic defined for notification of log file delivery.
\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether the trail is publishing events from global services such as IAM to the log files.
\n " }, "trail": { "shape_name": "Trail", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nName of the trail set by calling CreateTrail.
\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\nName of the Amazon S3 bucket into which CloudTrail delivers your trail files.
\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\nValue of the Amazon S3 prefix.
\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\nName of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSet to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
\n " } }, "documentation": "\nSupport for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions.
\n " } }, "documentation": "\nSpecifies the settings for each trail.
\n " }, "output": { "shape_name": "CreateTrailResponse", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the trail.
\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the Amazon S3 bucket designated for publishing log files.
\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.
\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the Amazon SNS topic defined for notification of log file delivery.
\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether the trail is publishing events from global services such as IAM to the log files.
\n " }, "trail": { "shape_name": "Trail", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nName of the trail set by calling CreateTrail.
\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\nName of the Amazon S3 bucket into which CloudTrail delivers your trail files.
\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\nValue of the Amazon S3 prefix.
\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\nName of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSet to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
\n " } }, "documentation": "\nSupport for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions.
\n " } }, "documentation": "\n Returns the objects or data listed below if successful. Otherwise, returns an error.\n " }, "errors": [ { "shape_name": "MaximumNumberOfTrailsExceededException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the maximum number of trails is reached.\n\t" }, { "shape_name": "TrailAlreadyExistsException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the specified trail already exists.\n\t" }, { "shape_name": "S3BucketDoesNotExistException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the specified S3 bucket does not exist.\n\t" }, { "shape_name": "InsufficientS3BucketPolicyException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the policy on the S3 bucket is not sufficient.\n\t" }, { "shape_name": "InsufficientSnsTopicPolicyException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the policy on the SNS topic is not sufficient.\n\t" }, { "shape_name": "InvalidS3BucketNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided S3 bucket name is not valid.\n\t" }, { "shape_name": "InvalidS3PrefixException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided S3 prefix is not valid.\n\t" }, { "shape_name": "InvalidSnsTopicNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided SNS topic name is not valid.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" }, { "shape_name": "TrailNotProvidedException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when no trail is provided.\n\t" } ], "documentation": "\nFrom the command line, use create-subscription
.
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
\nThe name of a trail to be deleted.
\n ", "required": true } }, "documentation": "\n The request that specifies the name of a trail to delete.\n " }, "output": { "shape_name": "DeleteTrailResponse", "type": "structure", "members": {}, "documentation": "\nReturns the objects or data listed below if successful. Otherwise, returns an error.
\n " }, "errors": [ { "shape_name": "TrailNotFoundException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" } ], "documentation": "\nDeletes a trail.
\n " }, "DescribeTrails": { "name": "DescribeTrails", "input": { "shape_name": "DescribeTrailsRequest", "type": "structure", "members": { "trailNameList": { "shape_name": "TrailNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nThe list of trails.
\n " } }, "documentation": "\nReturns the list of trails.
\n " }, "output": { "shape_name": "DescribeTrailsResponse", "type": "structure", "members": { "trailList": { "shape_name": "TrailList", "type": "list", "members": { "shape_name": "Trail", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nName of the trail set by calling CreateTrail.
\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\nName of the Amazon S3 bucket into which CloudTrail delivers your trail files.
\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\nValue of the Amazon S3 prefix.
\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\nName of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSet to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
\n " } }, "documentation": "\nThe settings for a trail.
\n " }, "documentation": "\nThe list of trails.
\n " } }, "documentation": "\nReturns the objects or data listed below if successful. Otherwise, returns an error.
\n " }, "errors": [], "documentation": "\nRetrieves the settings for some or all trails associated with an account.
\n " }, "GetTrailStatus": { "name": "GetTrailStatus", "input": { "shape_name": "GetTrailStatusRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the trail for which you are requesting the current status.
\n ", "required": true } }, "documentation": "\nThe name of a trail about which you want the current status.
\n " }, "output": { "shape_name": "GetTrailStatusResponse", "type": "structure", "members": { "IsLogging": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the CloudTrail is currently logging AWS API calls.
\n " }, "LatestDeliveryError": { "shape_name": "String", "type": "string", "documentation": "\nDisplays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.
\n " }, "LatestNotificationError": { "shape_name": "String", "type": "string", "documentation": "\nDisplays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.
\n " }, "LatestDeliveryTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nSpecifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
\n " }, "LatestNotificationTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nSpecifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.
\n " }, "StartLoggingTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nSpecifies the most recent date and time when CloudTrail started recording API calls for an AWS account.
\n " }, "StopLoggingTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nSpecifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.
\n " }, "LatestDeliveryAttemptTime": { "shape_name": "String", "type": "string", "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " }, "LatestNotificationAttemptTime": { "shape_name": "String", "type": "string", "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " }, "LatestNotificationAttemptSucceeded": { "shape_name": "String", "type": "string", "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " }, "LatestDeliveryAttemptSucceeded": { "shape_name": "String", "type": "string", "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " }, "TimeLoggingStarted": { "shape_name": "String", "type": "string", "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " }, "TimeLoggingStopped": { "shape_name": "String", "type": "string", "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " } }, "documentation": "\nReturns the objects or data listed below if successful. Otherwise, returns an error.
\n " }, "errors": [ { "shape_name": "TrailNotFoundException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" } ], "documentation": "\nReturns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail.
\n \nThe CloudTrail API is currently undergoing revision. This action currently returns both\n new fields and fields slated for removal from the API. The following lists indicate the\n plans for each field:
\n\nList of Members Planned for Ongoing Support
\nList of Members Scheduled for Removal
\nThe name of the trail for which CloudTrail logs AWS API calls.
\n ", "required": true } }, "documentation": "\nThe request to CloudTrail to start logging AWS API calls for an account.
\n " }, "output": { "shape_name": "StartLoggingResponse", "type": "structure", "members": {}, "documentation": "\nReturns the objects or data listed below if successful. Otherwise, returns an error.
\n " }, "errors": [ { "shape_name": "TrailNotFoundException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" } ], "documentation": "\nStarts the recording of AWS API calls and log file delivery for a trail.
\n " }, "StopLogging": { "name": "StopLogging", "input": { "shape_name": "StopLoggingRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nCommunicates to CloudTrail the name of the trail for which to stop logging AWS API calls.
\n ", "required": true } }, "documentation": "\nPasses the request to CloudTrail to stop logging AWS API calls for the specified account.
\n " }, "output": { "shape_name": "StopLoggingResponse", "type": "structure", "members": {}, "documentation": "\nReturns the objects or data listed below if successful. Otherwise, returns an error.
\n " }, "errors": [ { "shape_name": "TrailNotFoundException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" } ], "documentation": "\nSuspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording.
\n " }, "UpdateTrail": { "name": "UpdateTrail", "input": { "shape_name": "UpdateTrailRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the trail.
\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the Amazon S3 bucket designated for publishing log files.
\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.
\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the Amazon SNS topic defined for notification of log file delivery.
\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether the trail is publishing events from global services such as IAM to the log files.
\n " }, "trail": { "shape_name": "Trail", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nName of the trail set by calling CreateTrail.
\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\nName of the Amazon S3 bucket into which CloudTrail delivers your trail files.
\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\nValue of the Amazon S3 prefix.
\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\nName of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSet to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
\n " } }, "documentation": "\nSupport for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions.
\n " } }, "documentation": "\nSpecifies settings to update for the trail.
\n " }, "output": { "shape_name": "UpdateTrailResponse", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the trail.
\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the Amazon S3 bucket designated for publishing log files.
\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.
\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the Amazon SNS topic defined for notification of log file delivery.
\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether the trail is publishing events from global services such as IAM to the log files.
\n " }, "trail": { "shape_name": "Trail", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nName of the trail set by calling CreateTrail.
\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\nName of the Amazon S3 bucket into which CloudTrail delivers your trail files.
\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\nValue of the Amazon S3 prefix.
\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\nName of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSet to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
\n " } }, "documentation": "\nRepresents the CloudTrail settings that were updated by calling UpdateTrail.
\n " } }, "documentation": "\n Returns the objects or data listed below if successful. Otherwise, returns an error.\n " }, "errors": [ { "shape_name": "S3BucketDoesNotExistException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the specified S3 bucket does not exist.\n\t" }, { "shape_name": "InsufficientS3BucketPolicyException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the policy on the S3 bucket is not sufficient.\n\t" }, { "shape_name": "InsufficientSnsTopicPolicyException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the policy on the SNS topic is not sufficient.\n\t" }, { "shape_name": "TrailNotFoundException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t" }, { "shape_name": "InvalidS3BucketNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided S3 bucket name is not valid.\n\t" }, { "shape_name": "InvalidS3PrefixException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided S3 prefix is not valid.\n\t" }, { "shape_name": "InvalidSnsTopicNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided SNS topic name is not valid.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" }, { "shape_name": "TrailNotProvidedException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when no trail is provided.\n\t" } ], "documentation": "\nFrom the command line, use update-subscription
.
Updates the settings that specify delivery of log files. Changes to a trail do not require\n stopping the CloudTrail service. Use this action to designate an existing bucket for log\n delivery. If the existing bucket has previously been a target for CloudTrail log files,\n an IAM policy exists for the bucket.
\n \n