AWS SDK for PHP 3.x

Client: Aws\CloudTrail\CloudTrailClient

Service ID: cloudtrail

Version: 2013-11-01

This page describes the parameters and results for the operations of the AWS CloudTrail (2013-11-01), and shows how to use the Aws\CloudTrail\CloudTrailClient object to call the described operations. This documentation is specific to the 2013-11-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddTags ( array $params = [] )
Adds one or more tags to a trail, up to a limit of 50.
CreateTrail ( array $params = [] )
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
DeleteTrail ( array $params = [] )
Deletes a trail.
DescribeTrails ( array $params = [] )
Retrieves settings for the trail associated with the current region for your account.
GetEventSelectors ( array $params = [] )
Describes the settings for the event selectors that you configured for your trail.
GetTrailStatus ( array $params = [] )
Returns a JSON-formatted list of information about the specified trail.
ListPublicKeys ( array $params = [] )
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
ListTags ( array $params = [] )
Lists the tags for the trail in the current region.
LookupEvents ( array $params = [] )
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account.
PutEventSelectors ( array $params = [] )
Configures an event selector for your trail.
RemoveTags ( array $params = [] )
Removes the specified tags from a trail.
StartLogging ( array $params = [] )
Starts the recording of AWS API calls and log file delivery for a trail.
StopLogging ( array $params = [] )
Suspends the recording of AWS API calls and log file delivery for the specified trail.
UpdateTrail ( array $params = [] )
Updates the settings that specify delivery of log files.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeTrails
LookupEvents

Operations

AddTags

$result = $client->addTags([/* ... */]);
$promise = $client->addTagsAsync([/* ... */]);

Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region).

Parameter Syntax

$result = $client->addTags([
    'ResourceId' => '<string>', // REQUIRED
    'TagsList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceId

Type: string

Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

TagsList

Type: Array of Tag structures

Contains a list of CloudTrail tags, up to a limit of 50

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the specified resource is not found.
CloudTrailARNInvalidException:
This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
ResourceTypeNotSupportedException:
This exception is thrown when the specified resource type is not supported by CloudTrail.
TagsLimitExceededException:
The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.
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 and my--namespace are invalid.
- Not be in IP address format (for example, 192.168.5.4)
InvalidTagParameterException:
This exception is thrown when the key or value specified for the tag does not match the regular expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$.
UnsupportedOperationException:
This exception is thrown when the requested operation is not supported.
OperationNotPermittedException:
This exception is thrown when the requested operation is not permitted.

CreateTrail

$result = $client->createTrail([/* ... */]);
$promise = $client->createTrailAsync([/* ... */]);

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.

Parameter Syntax

$result = $client->createTrail([
    'CloudWatchLogsLogGroupArn' => '<string>',
    'CloudWatchLogsRoleArn' => '<string>',
    'EnableLogFileValidation' => true || false,
    'IncludeGlobalServiceEvents' => true || false,
    'IsMultiRegionTrail' => true || false,
    'KmsKeyId' => '<string>',
    'Name' => '<string>', // REQUIRED
    'S3BucketName' => '<string>', // REQUIRED
    'S3KeyPrefix' => '<string>',
    'SnsTopicName' => '<string>',
]);

Parameter Details

Members

CloudWatchLogsLogGroupArn

Type: string

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. Not required unless you specify CloudWatchLogsRoleArn.

CloudWatchLogsRoleArn

Type: string

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

EnableLogFileValidation

Type: boolean

Specifies whether log file integrity validation is enabled. The default is false.

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will 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.

IncludeGlobalServiceEvents

Type: boolean

Specifies whether the trail is publishing events from global services such as IAM to the log files.

IsMultiRegionTrail

Type: boolean

Specifies whether the trail is created in the current region or in all regions. The default is false.

KmsKeyId

Type: 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.

Examples:

alias/MyAliasName
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012

Name

Type: string

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 and my--namespace are invalid.
Not be in IP address format (for example, 192.168.5.4)

S3BucketName

Type: string

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

S3KeyPrefix

Type: 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

Type: string

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

Result Syntax

[
    'CloudWatchLogsLogGroupArn' => '<string>',
    'CloudWatchLogsRoleArn' => '<string>',
    'IncludeGlobalServiceEvents' => true || false,
    'IsMultiRegionTrail' => true || false,
    'KmsKeyId' => '<string>',
    'LogFileValidationEnabled' => true || false,
    'Name' => '<string>',
    'S3BucketName' => '<string>',
    'S3KeyPrefix' => '<string>',
    'SnsTopicARN' => '<string>',
    'SnsTopicName' => '<string>',
    'TrailARN' => '<string>',
]

Result Details

Members

CloudWatchLogsLogGroupArn

Type: string

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

CloudWatchLogsRoleArn

Type: string

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

IncludeGlobalServiceEvents

Type: boolean

Specifies whether the trail is publishing events from global services such as IAM to the log files.

IsMultiRegionTrail

Type: boolean

Specifies whether the trail exists in one region or in all regions.

KmsKeyId

Type: 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 format:

arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

LogFileValidationEnabled

Type: boolean

Specifies whether log file integrity validation is enabled.

Name

Type: string

Specifies the name of the trail.

S3BucketName

Type: string

Specifies the name of the Amazon S3 bucket designated for publishing log files.

S3KeyPrefix

Type: 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.

SnsTopicARN

Type: 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-1:123456789012:MyTopic

SnsTopicName

Type: string

This field is deprecated. Use SnsTopicARN.

TrailARN

Type: string

Specifies the ARN of the trail that was created. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Errors

MaximumNumberOfTrailsExceededException:
This exception is thrown when the maximum number of trails is reached.
TrailAlreadyExistsException:
This exception is thrown when the specified trail already exists.
S3BucketDoesNotExistException:
This exception is thrown when the specified S3 bucket does not exist.
InsufficientS3BucketPolicyException:
This exception is thrown when the policy on the S3 bucket is not sufficient.
InsufficientSnsTopicPolicyException:
This exception is thrown when the policy on the SNS topic is not sufficient.
InsufficientEncryptionPolicyException:
This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.
InvalidS3BucketNameException:
This exception is thrown when the provided S3 bucket name is not valid.
InvalidS3PrefixException:
This exception is thrown when the provided S3 prefix is not valid.
InvalidSnsTopicNameException:
This exception is thrown when the provided SNS topic name is not valid.
InvalidKmsKeyIdException:
This exception is thrown when the KMS key ARN is invalid.
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 and my--namespace are invalid.
- Not be in IP address format (for example, 192.168.5.4)
TrailNotProvidedException:
This exception is deprecated.
InvalidParameterCombinationException:
This exception is thrown when the combination of parameters provided is not valid.
KmsKeyNotFoundException:
This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region.
KmsKeyDisabledException:
This exception is deprecated.
KmsException:
This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.
InvalidCloudWatchLogsLogGroupArnException:
This exception is thrown when the provided CloudWatch log group is not valid.
InvalidCloudWatchLogsRoleArnException:
This exception is thrown when the provided role is not valid.
CloudWatchLogsDeliveryUnavailableException:
Cannot set a CloudWatch Logs delivery for this region.
UnsupportedOperationException:
This exception is thrown when the requested operation is not supported.
OperationNotPermittedException:
This exception is thrown when the requested operation is not permitted.

DeleteTrail

$result = $client->deleteTrail([/* ... */]);
$promise = $client->deleteTrailAsync([/* ... */]);

Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

Parameter Syntax

$result = $client->deleteTrail([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Type: string

Specifies the name or the CloudTrail ARN of the trail to be deleted. The format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TrailNotFoundException:
This exception is thrown when the trail with the given name is not found.
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 and my--namespace are invalid.
- Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException:
This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.

DescribeTrails

$result = $client->describeTrails([/* ... */]);
$promise = $client->describeTrailsAsync([/* ... */]);

Retrieves settings for the trail associated with the current region for your account.

Parameter Syntax

$result = $client->describeTrails([
    'includeShadowTrails' => true || false,
    'trailNameList' => ['<string>', ...],
]);

Parameter Details

Members

includeShadowTrails

Type: boolean

Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region. The default is true.

trailNameList

Type: Array of strings

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

If an empty list is specified, information for the trail in the current region is returned.

If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current region is returned.
If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.

If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.

Result Syntax

[
    'trailList' => [
        [
            'CloudWatchLogsLogGroupArn' => '<string>',
            'CloudWatchLogsRoleArn' => '<string>',
            'HasCustomEventSelectors' => true || false,
            'HomeRegion' => '<string>',
            'IncludeGlobalServiceEvents' => true || false,
            'IsMultiRegionTrail' => true || false,
            'KmsKeyId' => '<string>',
            'LogFileValidationEnabled' => true || false,
            'Name' => '<string>',
            'S3BucketName' => '<string>',
            'S3KeyPrefix' => '<string>',
            'SnsTopicARN' => '<string>',
            'SnsTopicName' => '<string>',
            'TrailARN' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

trailList

Type: Array of Trail structures

The list of trail objects.

Errors

UnsupportedOperationException:
This exception is thrown when the requested operation is not supported.
OperationNotPermittedException:
This exception is thrown when the requested operation is not permitted.

GetEventSelectors

$result = $client->getEventSelectors([/* ... */]);
$promise = $client->getEventSelectorsAsync([/* ... */]);

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

The S3 objects that you are logging for data events.
If your event selector includes management events.
If your event selector includes read-only events, write-only events, or all.

For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.

Parameter Syntax

$result = $client->getEventSelectors([
    'TrailName' => '<string>', // REQUIRED
]);

Parameter Details

Members

TrailName

Type: string

Specifies the name of the trail or trail ARN. If you specify 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 invalid.
Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Result Syntax

[
    'EventSelectors' => [
        [
            'DataResources' => [
                [
                    'Type' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'IncludeManagementEvents' => true || false,
            'ReadWriteType' => 'ReadOnly|WriteOnly|All',
        ],
        // ...
    ],
    'TrailARN' => '<string>',
]

Result Details

Members

EventSelectors

Type: Array of EventSelector structures

The event selectors that are configured for the trail.

TrailARN

Type: string

The specified trail ARN that has the event selectors.

Errors

TrailNotFoundException:
This exception is thrown when the trail with the given name is not found.
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 and my--namespace are invalid.
- Not be in IP address format (for example, 192.168.5.4)
UnsupportedOperationException:
This exception is thrown when the requested operation is not supported.
OperationNotPermittedException:
This exception is thrown when the requested operation is not permitted.

GetTrailStatus

$result = $client->getTrailStatus([/* ... */]);
$promise = $client->getTrailStatusAsync([/* ... */]);

Returns 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. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.

Parameter Syntax

$result = $client->getTrailStatus([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Type: string

Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Result Syntax

[
    'IsLogging' => true || false,
    'LatestCloudWatchLogsDeliveryError' => '<string>',
    'LatestCloudWatchLogsDeliveryTime' => <DateTime>,
    'LatestDeliveryAttemptSucceeded' => '<string>',
    'LatestDeliveryAttemptTime' => '<string>',
    'LatestDeliveryError' => '<string>',
    'LatestDeliveryTime' => <DateTime>,
    'LatestDigestDeliveryError' => '<string>',
    'LatestDigestDeliveryTime' => <DateTime>,
    'LatestNotificationAttemptSucceeded' => '<string>',
    'LatestNotificationAttemptTime' => '<string>',
    'LatestNotificationError' => '<string>',
    'LatestNotificationTime' => <DateTime>,
    'StartLoggingTime' => <DateTime>,
    'StopLoggingTime' => <DateTime>,
    'TimeLoggingStarted' => '<string>',
    'TimeLoggingStopped' => '<string>',
]

Result Details

Members

IsLogging

Type: boolean

Whether the CloudTrail is currently logging AWS API calls.

LatestCloudWatchLogsDeliveryError

Type: string

Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.

LatestCloudWatchLogsDeliveryTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

LatestDeliveryAttemptSucceeded

Type: string

This field is deprecated.

LatestDeliveryAttemptTime

Type: string

This field is deprecated.

LatestDeliveryError

Type: string

Displays 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.

This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket.

LatestDeliveryTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

LatestDigestDeliveryError

Type: string

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.

LatestDigestDeliveryTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.

LatestNotificationAttemptSucceeded

Type: string

This field is deprecated.

LatestNotificationAttemptTime

Type: string

This field is deprecated.

LatestNotificationError

Type: string

Displays 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.

LatestNotificationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies 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.

StartLoggingTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.

StopLoggingTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.

TimeLoggingStarted

Type: string

This field is deprecated.

TimeLoggingStopped

Type: string

This field is deprecated.

Errors

TrailNotFoundException:
This exception is thrown when the trail with the given name is not found.
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 and my--namespace are invalid.
- Not be in IP address format (for example, 192.168.5.4)

ListPublicKeys

$result = $client->listPublicKeys([/* ... */]);
$promise = $client->listPublicKeysAsync([/* ... */]);

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.

Parameter Syntax

$result = $client->listPublicKeys([
    'EndTime' => <integer || string || DateTime>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.

NextToken

Type: string

Reserved for future use.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

Result Syntax

[
    'NextToken' => '<string>',
    'PublicKeyList' => [
        [
            'Fingerprint' => '<string>',
            'ValidityEndTime' => <DateTime>,
            'ValidityStartTime' => <DateTime>,
            'Value' => <string || resource || Psr\Http\Message\StreamInterface>,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

Reserved for future use.

PublicKeyList

Type: Array of PublicKey structures

Contains an array of PublicKey objects.

The returned public keys may have validity time ranges that overlap.

Errors

InvalidTimeRangeException:
Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values.
UnsupportedOperationException:
This exception is thrown when the requested operation is not supported.
OperationNotPermittedException:
This exception is thrown when the requested operation is not permitted.
InvalidTokenException:
Reserved for future use.

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

Lists the tags for the trail in the current region.

Parameter Syntax

$result = $client->listTags([
    'NextToken' => '<string>',
    'ResourceIdList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

NextToken

Type: string

Reserved for future use.

ResourceIdList

Type: Array of strings

Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceTagList' => [
        [
            'ResourceId' => '<string>',
            'TagsList' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

Reserved for future use.

ResourceTagList

Type: Array of ResourceTag structures

A list of resource tags.

Errors

ResourceNotFoundException:
This exception is thrown when the specified resource is not found.
CloudTrailARNInvalidException:
This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
ResourceTypeNotSupportedException:
This exception is thrown when the specified resource type is not supported by CloudTrail.
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 and my--namespace are invalid.
- Not be in IP address format (for example, 192.168.5.4)
UnsupportedOperationException:
This exception is thrown when the requested operation is not supported.
OperationNotPermittedException:
This exception is thrown when the requested operation is not permitted.
InvalidTokenException:
Reserved for future use.

LookupEvents

$result = $client->lookupEvents([/* ... */]);
$promise = $client->lookupEventsAsync([/* ... */]);

Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:

Event ID
Event name
Event source
Resource name
Resource type
User name

All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

Parameter Syntax

$result = $client->lookupEvents([
    'EndTime' => <integer || string || DateTime>,
    'LookupAttributes' => [
        [
            'AttributeKey' => 'EventId|EventName|Username|ResourceType|ResourceName|EventSource', // REQUIRED
            'AttributeValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

LookupAttributes

Type: Array of LookupAttribute structures

Contains a list of lookup attributes. Currently the list can contain only one item.

MaxResults

Type: int

The number of events to return. Possible values are 1 through 50. The default is 10.

NextToken

Type: string

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

Result Syntax

[
    'Events' => [
        [
            'CloudTrailEvent' => '<string>',
            'EventId' => '<string>',
            'EventName' => '<string>',
            'EventSource' => '<string>',
            'EventTime' => <DateTime>,
            'Resources' => [
                [
                    'ResourceName' => '<string>',
                    'ResourceType' => '<string>',
                ],
                // ...
            ],
            'Username' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Events

Type: Array of Event structures

A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.

NextToken

Type: string

The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

Errors

InvalidLookupAttributesException:
Occurs when an invalid lookup attribute is specified.
InvalidTimeRangeException:
Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values.
InvalidMaxResultsException:
This exception is thrown if the limit specified is invalid.
InvalidNextTokenException:
Invalid token or token that was previously used in a request with different parameters. This exception is thrown if the token is invalid.

PutEventSelectors

$result = $client->putEventSelectors([/* ... */]);
$promise = $client->putEventSelectorsAsync([/* ... */]);

Configures an event selector for your trail. Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

Example

You create an event selector for a trail and specify that you want write-only events.
The EC2 GetConsoleOutput and RunInstances API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput is a read-only event but it doesn't match your event selector. The trail doesn't log the event.

The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.

Parameter Syntax

$result = $client->putEventSelectors([
    'EventSelectors' => [ // REQUIRED
        [
            'DataResources' => [
                [
                    'Type' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'IncludeManagementEvents' => true || false,
            'ReadWriteType' => 'ReadOnly|WriteOnly|All',
        ],
        // ...
    ],
    'TrailName' => '<string>', // REQUIRED
]);

Parameter Details

Members

EventSelectors

Type: Array of EventSelector structures

Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.

TrailName

Type: string

Specifies the name of the trail or trail ARN. If you specify 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 invalid.
Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Result Syntax

[
    'EventSelectors' => [
        [
            'DataResources' => [
                [
                    'Type' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'IncludeManagementEvents' => true || false,
            'ReadWriteType' => 'ReadOnly|WriteOnly|All',
        ],
        // ...
    ],
    'TrailARN' => '<string>',
]

Result Details

Members

EventSelectors

Type: Array of EventSelector structures

Specifies the event selectors configured for your trail.

TrailARN

Type: string

Specifies the ARN of the trail that was updated with event selectors. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Errors

TrailNotFoundException:
This exception is thrown when the trail with the given name is not found.
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 and my--namespace are invalid.
- Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException:
This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.
InvalidEventSelectorsException:
This exception is thrown when the PutEventSelectors operation is called with an invalid number of event selectors, data resources, or an invalid value for a parameter:
- Specify a valid number of event selectors (1 to 5) for a trail.
- Specify a valid number of data resources (1 to 250) for an event selector.
- Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is invalid.
UnsupportedOperationException:
This exception is thrown when the requested operation is not supported.
OperationNotPermittedException:
This exception is thrown when the requested operation is not permitted.

RemoveTags

$result = $client->removeTags([/* ... */]);
$promise = $client->removeTagsAsync([/* ... */]);

Removes the specified tags from a trail.

Parameter Syntax

$result = $client->removeTags([
    'ResourceId' => '<string>', // REQUIRED
    'TagsList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceId

Type: string

Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

TagsList

Type: Array of Tag structures

Specifies a list of tags to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the specified resource is not found.
CloudTrailARNInvalidException:
This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
ResourceTypeNotSupportedException:
This exception is thrown when the specified resource type is not supported by CloudTrail.
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 and my--namespace are invalid.
- Not be in IP address format (for example, 192.168.5.4)
InvalidTagParameterException:
This exception is thrown when the key or value specified for the tag does not match the regular expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$.
UnsupportedOperationException:
This exception is thrown when the requested operation is not supported.
OperationNotPermittedException:
This exception is thrown when the requested operation is not permitted.

StartLogging

$result = $client->startLogging([/* ... */]);
$promise = $client->startLoggingAsync([/* ... */]);

Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

Parameter Syntax

$result = $client->startLogging([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Type: string

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TrailNotFoundException:
This exception is thrown when the trail with the given name is not found.
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 and my--namespace are invalid.
- Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException:
This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.

StopLogging

$result = $client->stopLogging([/* ... */]);
$promise = $client->stopLoggingAsync([/* ... */]);

Suspends 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. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

Parameter Syntax

$result = $client->stopLogging([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Type: string

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging AWS API calls. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TrailNotFoundException:
This exception is thrown when the trail with the given name is not found.
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 and my--namespace are invalid.
- Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException:
This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.

UpdateTrail

$result = $client->updateTrail([/* ... */]);
$promise = $client->updateTrailAsync([/* ... */]);

Updates the settings that specify delivery of 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.

Parameter Syntax

$result = $client->updateTrail([
    'CloudWatchLogsLogGroupArn' => '<string>',
    'CloudWatchLogsRoleArn' => '<string>',
    'EnableLogFileValidation' => true || false,
    'IncludeGlobalServiceEvents' => true || false,
    'IsMultiRegionTrail' => true || false,
    'KmsKeyId' => '<string>',
    'Name' => '<string>', // REQUIRED
    'S3BucketName' => '<string>',
    'S3KeyPrefix' => '<string>',
    'SnsTopicName' => '<string>',
]);

Parameter Details

Members

CloudWatchLogsLogGroupArn

Type: string

CloudWatchLogsRoleArn

Type: string

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

EnableLogFileValidation

Type: boolean

Specifies whether log file validation is enabled. The default is false.

IncludeGlobalServiceEvents

Type: boolean

Specifies whether the trail is publishing events from global services such as IAM to the log files.

IsMultiRegionTrail

Type: 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.

KmsKeyId

Type: string

Examples:

alias/MyAliasName
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012

Name

Type: string

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 invalid.
Not be in IP address format (for example, 192.168.5.4)

If Name is a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

S3BucketName

Type: string

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

S3KeyPrefix

Type: string

SnsTopicName

Type: string

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

Result Syntax

[
    'CloudWatchLogsLogGroupArn' => '<string>',
    'CloudWatchLogsRoleArn' => '<string>',
    'IncludeGlobalServiceEvents' => true || false,
    'IsMultiRegionTrail' => true || false,
    'KmsKeyId' => '<string>',
    'LogFileValidationEnabled' => true || false,
    'Name' => '<string>',
    'S3BucketName' => '<string>',
    'S3KeyPrefix' => '<string>',
    'SnsTopicARN' => '<string>',
    'SnsTopicName' => '<string>',
    'TrailARN' => '<string>',
]

Result Details

Members

CloudWatchLogsLogGroupArn

Type: string

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

CloudWatchLogsRoleArn

Type: string

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

IncludeGlobalServiceEvents

Type: boolean

Specifies whether the trail is publishing events from global services such as IAM to the log files.

IsMultiRegionTrail

Type: boolean

Specifies whether the trail exists in one region or in all regions.

KmsKeyId

Type: 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 format:

arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

LogFileValidationEnabled

Type: boolean

Specifies whether log file integrity validation is enabled.

Name

Type: string

Specifies the name of the trail.

S3BucketName

Type: string

Specifies the name of the Amazon S3 bucket designated for publishing log files.

S3KeyPrefix

Type: 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.

SnsTopicARN

Type: 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-1:123456789012:MyTopic

SnsTopicName

Type: string

This field is deprecated. Use SnsTopicARN.

TrailARN

Type: string

Specifies the ARN of the trail that was updated. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Errors

S3BucketDoesNotExistException:
This exception is thrown when the specified S3 bucket does not exist.
InsufficientS3BucketPolicyException:
This exception is thrown when the policy on the S3 bucket is not sufficient.
InsufficientSnsTopicPolicyException:
This exception is thrown when the policy on the SNS topic is not sufficient.
InsufficientEncryptionPolicyException:
This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.
TrailNotFoundException:
This exception is thrown when the trail with the given name is not found.
InvalidS3BucketNameException:
This exception is thrown when the provided S3 bucket name is not valid.
InvalidS3PrefixException:
This exception is thrown when the provided S3 prefix is not valid.
InvalidSnsTopicNameException:
This exception is thrown when the provided SNS topic name is not valid.
InvalidKmsKeyIdException:
This exception is thrown when the KMS key ARN is invalid.
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 and my--namespace are invalid.
- Not be in IP address format (for example, 192.168.5.4)
TrailNotProvidedException:
This exception is deprecated.
InvalidParameterCombinationException:
This exception is thrown when the combination of parameters provided is not valid.
InvalidHomeRegionException:
This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.
KmsKeyNotFoundException:
This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region.
KmsKeyDisabledException:
This exception is deprecated.
KmsException:
This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.
InvalidCloudWatchLogsLogGroupArnException:
This exception is thrown when the provided CloudWatch log group is not valid.
InvalidCloudWatchLogsRoleArnException:
This exception is thrown when the provided role is not valid.
CloudWatchLogsDeliveryUnavailableException:
Cannot set a CloudWatch Logs delivery for this region.
UnsupportedOperationException:
This exception is thrown when the requested operation is not supported.
OperationNotPermittedException:
This exception is thrown when the requested operation is not permitted.

Shapes

Example

You create an event selector for a trail and specify an S3 bucket and an empty prefix, such as arn:aws:s3:::bucket-1/.
You upload an image file to bucket-1.
The PutObject API operation occurs on an object in the S3 bucket that you specified in the event selector. The trail processes and logs the event.
You upload another image file to a different S3 bucket named arn:aws:s3:::bucket-2.
The event occurs on an object in an S3 bucket that you didn't specify in the event selector. The trail doesn’t log the event.

Members

Type

Type: string

The resource type in which you want to log data events. You can specify only the following value: AWS::S3::Object.

Values

Type: Array of strings

A list of ARN-like strings for the specified S3 objects.

To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3 bucket.

To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images. The trail logs data events for objects in this S3 bucket that match the prefix.

Event

Description

Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.

Members

CloudTrailEvent

Type: string

A JSON string that contains a representation of the event returned.

EventId

Type: string

The CloudTrail ID of the event returned.

EventName

Type: string

The name of the event returned.

EventSource

Type: string

The AWS service that the request was made to.

EventTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time of the event returned.

Resources

Type: Array of Resource structures

A list of resources referenced by the event returned.

Username

Type: string

A user name or role name of the requester that called the API in the event returned.

EventSelector

Description

Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

You can configure up to five event selectors for a trail.

Members

DataResources

Type: Array of DataResource structures

CloudTrail supports logging only data events for S3 objects. You can specify up to 250 S3 buckets and object prefixes for a trail.

For more information, see Data Events in the AWS CloudTrail User Guide.

IncludeManagementEvents

Type: boolean

Specify if you want your event selector to include management events for your trail.

For more information, see Management Events in the AWS CloudTrail User Guide.

By default, the value is true.

ReadWriteType

Type: string

Description

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 and my--namespace are invalid.
Not be in IP address format (for example, 192.168.5.4)

Members

KmsException

Description

This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.

Members

KmsKeyDisabledException

Description

This exception is deprecated.

Members

KmsKeyNotFoundException

Description

This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region.

Members

LookupAttribute

Description

Specifies an attribute and value that filter the events returned.

Members

AttributeKey

Type: string

Specifies an attribute on which to filter the events returned.

AttributeValue

Type: string

Members

Fingerprint

Type: string

The fingerprint of the public key.

ValidityEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The ending time of validity of the public key.

ValidityStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The starting time of validity of the public key.

Value

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The DER encoded public key value in PKCS#1 format.

Resource

Description

Specifies the type and name of a resource referenced by an event.

Members

ResourceName

Type: string

The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2 Instance.

ResourceType

Type: string

The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for RDS, and AccessKey for IAM. For a list of resource types supported for event lookup, see Resource Types Supported for Event Lookup.

ResourceNotFoundException

Description

This exception is thrown when the specified resource is not found.

Members

ResourceTag

Description

A resource tag.

Members

ResourceId

Type: string

Specifies the ARN of the resource.

TagsList

Type: Array of Tag structures

Members

CloudWatchLogsLogGroupArn

Type: string

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

CloudWatchLogsRoleArn

Type: string

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

HasCustomEventSelectors

Type: boolean

Specifies if the trail has custom event selectors.

HomeRegion

Type: string

The region in which the trail was created.

IncludeGlobalServiceEvents

Type: boolean

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

IsMultiRegionTrail

Type: boolean

Specifies whether the trail belongs only to one region or exists in all regions.

KmsKeyId

Type: 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 format:

arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

LogFileValidationEnabled

Type: boolean

Specifies whether log file validation is enabled.

Name

Type: string

Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

S3BucketName

Type: string

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

S3KeyPrefix

Type: string

SnsTopicARN

Type: 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-1:123456789012:MyTopic

SnsTopicName

Type: string

This field is deprecated. Use SnsTopicARN.

TrailARN

Type: string

Specifies the ARN of the trail. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

TrailAlreadyExistsException

Description

This exception is thrown when the specified trail already exists.

Members

TrailNotFoundException

Description

This exception is thrown when the trail with the given name is not found.

Members

TrailNotProvidedException

Description

This exception is deprecated.

Members

UnsupportedOperationException

Description

This exception is thrown when the requested operation is not supported.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS CloudTrail 2013-11-01

Operation Summary

Paginators

Operations

AddTags

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateTrail

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteTrail

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeTrails

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetEventSelectors

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetTrailStatus

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListPublicKeys

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTags

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

LookupEvents

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors