AddTags

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

Adds one or more tags to a trail, event data store, dashboard, or channel, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique; you cannot have two keys with the same name but different values. 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 or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home Region).

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

ChannelARNInvalidException:

This exception is thrown when the specified value of ChannelARN is not valid.

ResourceTypeNotSupportedException:

This exception is thrown when the specified resource type is not supported by CloudTrail.

TagsLimitExceededException:

The number of tags per trail, event data store, dashboard, or channel 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 not valid.

• Not be in IP address format (for example, 192.168.5.4)

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.

InactiveEventDataStoreException:

The event data store is inactive.

EventDataStoreNotFoundException:

The specified event data store was not found.

ChannelNotFoundException:

This exception is thrown when CloudTrail cannot find the specified channel.

UnsupportedOperationException:

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

OperationNotPermittedException:

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

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 Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

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.

CancelQuery

$result = $client->cancelQuery([/* ... */]);
$promise = $client->cancelQueryAsync([/* ... */]);

Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might show as CANCELLED even if the operation is not yet finished.

Parameter Syntax

$result = $client->cancelQuery([
    'EventDataStore' => '<string>',
    'EventDataStoreOwnerAccountId' => '<string>',
    'QueryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventDataStoreOwnerAccountId' => '<string>',
    'QueryId' => '<string>',
    'QueryStatus' => 'QUEUED|RUNNING|FINISHED|FAILED|CANCELLED|TIMED_OUT',
]

Result Details

Errors

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

InactiveEventDataStoreException:

The event data store is inactive.

InactiveQueryException:

The specified query cannot be canceled because it is in the FINISHED, FAILED, TIMED_OUT, or CANCELLED state.

InvalidParameterException:

The request includes a parameter that is not valid.

QueryIdNotFoundException:

The query ID does not exist or does not map to a query.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

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.

CreateChannel

$result = $client->createChannel([/* ... */]);
$promise = $client->createChannelAsync([/* ... */]);

Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.

Parameter Syntax

$result = $client->createChannel([
    'Destinations' => [ // REQUIRED
        [
            'Location' => '<string>', // REQUIRED
            'Type' => 'EVENT_DATA_STORE|AWS_SERVICE', // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'Source' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'Destinations' => [
        [
            'Location' => '<string>',
            'Type' => 'EVENT_DATA_STORE|AWS_SERVICE',
        ],
        // ...
    ],
    'Name' => '<string>',
    'Source' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ChannelMaxLimitExceededException:

This exception is thrown when the maximum number of channels limit is exceeded.

InvalidSourceException:

This exception is thrown when the specified value of Source is not valid.

ChannelAlreadyExistsException:

This exception is thrown when the provided channel already exists.

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

InvalidEventDataStoreCategoryException:

This exception is thrown when event categories of specified event data stores are not valid.

InactiveEventDataStoreException:

The event data store is inactive.

InvalidParameterException:

The request includes a parameter that is not valid.

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.

TagsLimitExceededException:

The number of tags per trail, event data store, dashboard, or channel has exceeded the permitted amount. Currently, the limit is 50.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

CreateDashboard

$result = $client->createDashboard([/* ... */]);
$promise = $client->createDashboardAsync([/* ... */]);

Creates a custom dashboard or the Highlights dashboard.

• Custom dashboards - Custom dashboards allow you to query events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule.

• Highlights dashboard - You can create the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule.

CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.

To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, see Resource-based policy example for a dashboard in the CloudTrail User Guide.

For more information about dashboards, see CloudTrail Lake dashboards in the CloudTrail User Guide.

Parameter Syntax

$result = $client->createDashboard([
    'Name' => '<string>', // REQUIRED
    'RefreshSchedule' => [
        'Frequency' => [
            'Unit' => 'HOURS|DAYS',
            'Value' => <integer>,
        ],
        'Status' => 'ENABLED|DISABLED',
        'TimeOfDay' => '<string>',
    ],
    'TagsList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'TerminationProtectionEnabled' => true || false,
    'Widgets' => [
        [
            'QueryParameters' => ['<string>', ...],
            'QueryStatement' => '<string>', // REQUIRED
            'ViewProperties' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DashboardArn' => '<string>',
    'Name' => '<string>',
    'RefreshSchedule' => [
        'Frequency' => [
            'Unit' => 'HOURS|DAYS',
            'Value' => <integer>,
        ],
        'Status' => 'ENABLED|DISABLED',
        'TimeOfDay' => '<string>',
    ],
    'TagsList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TerminationProtectionEnabled' => true || false,
    'Type' => 'MANAGED|CUSTOM',
    'Widgets' => [
        [
            'QueryAlias' => '<string>',
            'QueryParameters' => ['<string>', ...],
            'QueryStatement' => '<string>',
            'ViewProperties' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

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.

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.

EventDataStoreNotFoundException:

The specified event data store was not found.

InactiveEventDataStoreException:

The event data store is inactive.

InsufficientEncryptionPolicyException:

For the CreateTrail PutInsightSelectors, UpdateTrail, StartQuery, and StartImport operations, this exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.

For all other operations, this exception is thrown when the policy for the KMS key does not have sufficient permissions for the operation.

InvalidQueryStatementException:

The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.

ServiceQuotaExceededException:

This exception is thrown when the quota is exceeded. For information about CloudTrail quotas, see Service quotas in the Amazon Web Services General Reference.

UnsupportedOperationException:

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

CreateEventDataStore

$result = $client->createEventDataStore([/* ... */]);
$promise = $client->createEventDataStoreAsync([/* ... */]);

Creates a new event data store.

Parameter Syntax

$result = $client->createEventDataStore([
    'AdvancedEventSelectors' => [
        [
            'FieldSelectors' => [ // REQUIRED
                [
                    'EndsWith' => ['<string>', ...],
                    'Equals' => ['<string>', ...],
                    'Field' => '<string>', // REQUIRED
                    'NotEndsWith' => ['<string>', ...],
                    'NotEquals' => ['<string>', ...],
                    'NotStartsWith' => ['<string>', ...],
                    'StartsWith' => ['<string>', ...],
                ],
                // ...
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
    'BillingMode' => 'EXTENDABLE_RETENTION_PRICING|FIXED_RETENTION_PRICING',
    'KmsKeyId' => '<string>',
    'MultiRegionEnabled' => true || false,
    'Name' => '<string>', // REQUIRED
    'OrganizationEnabled' => true || false,
    'RetentionPeriod' => <integer>,
    'StartIngestion' => true || false,
    'TagsList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'TerminationProtectionEnabled' => true || false,
]);

Parameter Details

Result Syntax

[
    'AdvancedEventSelectors' => [
        [
            'FieldSelectors' => [
                [
                    'EndsWith' => ['<string>', ...],
                    'Equals' => ['<string>', ...],
                    'Field' => '<string>',
                    'NotEndsWith' => ['<string>', ...],
                    'NotEquals' => ['<string>', ...],
                    'NotStartsWith' => ['<string>', ...],
                    'StartsWith' => ['<string>', ...],
                ],
                // ...
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
    'BillingMode' => 'EXTENDABLE_RETENTION_PRICING|FIXED_RETENTION_PRICING',
    'CreatedTimestamp' => <DateTime>,
    'EventDataStoreArn' => '<string>',
    'KmsKeyId' => '<string>',
    'MultiRegionEnabled' => true || false,
    'Name' => '<string>',
    'OrganizationEnabled' => true || false,
    'RetentionPeriod' => <integer>,
    'Status' => 'CREATED|ENABLED|PENDING_DELETION|STARTING_INGESTION|STOPPING_INGESTION|STOPPED_INGESTION',
    'TagsList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TerminationProtectionEnabled' => true || false,
    'UpdatedTimestamp' => <DateTime>,
]

Result Details

Errors

EventDataStoreAlreadyExistsException:

An event data store with that name already exists.

EventDataStoreMaxLimitExceededException:

Your account has used the maximum number of event data stores.

InvalidEventSelectorsException:

This exception is thrown when the PutEventSelectors operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.

You can:

• 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. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.

• Specify up to 500 values for all conditions in all advanced event selectors for a trail.

• Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is not valid.

InvalidParameterException:

The request includes a parameter that is not valid.

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.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

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.

InsufficientEncryptionPolicyException:

For the CreateTrail PutInsightSelectors, UpdateTrail, StartQuery, and StartImport operations, this exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.

For all other operations, this exception is thrown when the policy for the KMS key does not have sufficient permissions for the operation.

InvalidKmsKeyIdException:

This exception is thrown when the KMS key ARN is not valid.

KmsKeyNotFoundException:

This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.

KmsException:

This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.

CloudTrailAccessNotEnabledException:

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.

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.

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 Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

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.

OrganizationNotInAllFeaturesModeException:

This exception is thrown when 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.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

CreateTrail

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

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 Amazon SNS topic is not sufficient.

InsufficientEncryptionPolicyException:

For the CreateTrail PutInsightSelectors, UpdateTrail, StartQuery, and StartImport operations, this exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.

For all other operations, this exception is thrown when the policy for the KMS key does not have sufficient permissions for the operation.

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 not valid.

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 not valid.

• Not be in IP address format (for example, 192.168.5.4)

TrailNotProvidedException:

This exception is no longer in use.

TagsLimitExceededException:

The number of tags per trail, event data store, dashboard, or channel has exceeded the permitted amount. Currently, the limit is 50.

InvalidParameterCombinationException:

This exception is thrown when the combination of parameters provided is not valid.

InvalidParameterException:

The request includes a parameter that is not valid.

KmsKeyNotFoundException:

This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.

KmsKeyDisabledException:

This exception is no longer in use.

KmsException:

This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.

InvalidCloudWatchLogsLogGroupArnException:

This exception is thrown when the provided CloudWatch Logs 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.

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.

UnsupportedOperationException:

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

OperationNotPermittedException:

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

CloudTrailAccessNotEnabledException:

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.

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.

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 Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

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.

OrganizationNotInAllFeaturesModeException:

This exception is thrown when 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.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

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.

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.

ThrottlingException:

This exception is thrown when the request rate exceeds the limit.

DeleteChannel

$result = $client->deleteChannel([/* ... */]);
$promise = $client->deleteChannelAsync([/* ... */]);

Deletes a channel.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ChannelARNInvalidException:

This exception is thrown when the specified value of ChannelARN is not valid.

ChannelNotFoundException:

This exception is thrown when CloudTrail cannot find the specified channel.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

DeleteDashboard

$result = $client->deleteDashboard([/* ... */]);
$promise = $client->deleteDashboardAsync([/* ... */]);

Deletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

ResourceNotFoundException:

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

UnsupportedOperationException:

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

DeleteEventDataStore

$result = $client->deleteEventDataStore([/* ... */]);
$promise = $client->deleteEventDataStoreAsync([/* ... */]);

Disables the event data store specified by EventDataStore, which accepts an event data store ARN. After you run DeleteEventDataStore, the event data store enters a PENDING_DELETION state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled must be set to False on the event data store and the FederationStatus must be DISABLED. You cannot delete an event data store if TerminationProtectionEnabled is True or the FederationStatus is ENABLED.

After you run DeleteEventDataStore on an event data store, you cannot run ListQueries, DescribeQuery, or GetQueryResults on queries that are using an event data store in a PENDING_DELETION state. An event data store in the PENDING_DELETION state does not incur costs.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

EventDataStoreTerminationProtectedException:

The event data store cannot be deleted because termination protection is enabled for it.

EventDataStoreHasOngoingImportException:

This exception is thrown when you try to update or delete an event data store that currently has an import in progress.

InactiveEventDataStoreException:

The event data store is inactive.

InvalidParameterException:

The request includes a parameter that is not valid.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

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 Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

ChannelExistsForEDSException:

This exception is thrown when the specified event data store cannot yet be deleted because it is in use by a channel.

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.

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.

EventDataStoreFederationEnabledException:

You cannot delete the event data store because Lake query federation is enabled. To delete the event data store, run the DisableFederation operation to disable Lake query federation on the event data store.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceARNNotValidException:

This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

ResourceNotFoundException:

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

ResourcePolicyNotFoundException:

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

ResourceTypeNotSupportedException:

This exception is thrown when the specified resource type is not supported by CloudTrail.

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.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

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

Result Syntax

[]

Result Details

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 not valid.

• Not be in IP address format (for example, 192.168.5.4)

CloudTrailARNInvalidException:

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

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.

ThrottlingException:

This exception is thrown when the request rate exceeds the limit.

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.

UnsupportedOperationException:

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

OperationNotPermittedException:

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

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 Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

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.

DeregisterOrganizationDelegatedAdmin

$result = $client->deregisterOrganizationDelegatedAdmin([/* ... */]);
$promise = $client->deregisterOrganizationDelegatedAdminAsync([/* ... */]);

Removes CloudTrail delegated administrator permissions from a member account in an organization.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccountNotFoundException:

This exception is thrown when the specified account is not found or not part of an organization.

AccountNotRegisteredException:

This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.

CloudTrailAccessNotEnabledException:

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.

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.

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.

InvalidParameterException:

The request includes a parameter that is not valid.

NotOrganizationManagementAccountException:

This exception is thrown when the account making the request is not the organization's management account.

OrganizationNotInAllFeaturesModeException:

This exception is thrown when 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.

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.

UnsupportedOperationException:

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

OperationNotPermittedException:

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

DescribeQuery

$result = $client->describeQuery([/* ... */]);
$promise = $client->describeQueryAsync([/* ... */]);

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.

You must specify either QueryId or QueryAlias. Specifying the QueryAlias parameter returns information about the last query run for the alias. You can provide RefreshId along with QueryAlias to view the query results of a dashboard query for the specified RefreshId.

Parameter Syntax

$result = $client->describeQuery([
    'EventDataStore' => '<string>',
    'EventDataStoreOwnerAccountId' => '<string>',
    'QueryAlias' => '<string>',
    'QueryId' => '<string>',
    'RefreshId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DeliveryS3Uri' => '<string>',
    'DeliveryStatus' => 'SUCCESS|FAILED|FAILED_SIGNING_FILE|PENDING|RESOURCE_NOT_FOUND|ACCESS_DENIED|ACCESS_DENIED_SIGNING_FILE|CANCELLED|UNKNOWN',
    'ErrorMessage' => '<string>',
    'EventDataStoreOwnerAccountId' => '<string>',
    'Prompt' => '<string>',
    'QueryId' => '<string>',
    'QueryStatistics' => [
        'BytesScanned' => <integer>,
        'CreationTime' => <DateTime>,
        'EventsMatched' => <integer>,
        'EventsScanned' => <integer>,
        'ExecutionTimeInMillis' => <integer>,
    ],
    'QueryStatus' => 'QUEUED|RUNNING|FINISHED|FAILED|CANCELLED|TIMED_OUT',
    'QueryString' => '<string>',
]

Result Details

Errors

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

InactiveEventDataStoreException:

The event data store is inactive.

InvalidParameterException:

The request includes a parameter that is not valid.

QueryIdNotFoundException:

The query ID does not exist or does not map to a query.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

DescribeTrails

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

Retrieves settings for one or more trails associated with the current Region for your account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

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 not valid.

• Not be in IP address format (for example, 192.168.5.4)

CloudTrailARNInvalidException:

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

DisableFederation

$result = $client->disableFederation([/* ... */]);
$promise = $client->disableFederationAsync([/* ... */]);

Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables the integration with Glue, Lake Formation, and Amazon Athena. After disabling Lake query federation, you can no longer query your event data in Amazon Athena.

No CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'EventDataStoreArn' => '<string>',
    'FederationStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED',
]

Result Details

Errors

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

InvalidParameterException:

The request includes a parameter that is not valid.

InactiveEventDataStoreException:

The event data store is inactive.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

CloudTrailAccessNotEnabledException:

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.

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.

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 Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

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.

OrganizationNotInAllFeaturesModeException:

This exception is thrown when 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.

ConcurrentModificationException:

You are trying to update a resource when another request is in progress. Allow sufficient wait time for the previous request to complete, then retry your request.

AccessDeniedException:

You do not have sufficient access to perform this action.

EnableFederation

$result = $client->enableFederation([/* ... */]);
$promise = $client->enableFederationAsync([/* ... */]);

Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue Data Catalog and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query.

When you enable Lake query federation, CloudTrail creates a managed database named aws:cloudtrail (if the database doesn't already exist) and a managed federated table in the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in Lake Formation, the service responsible for allowing fine-grained access control of the federated resources in the Glue Data Catalog.

For more information about Lake query federation, see Federate an event data store.

Parameter Syntax

$result = $client->enableFederation([
    'EventDataStore' => '<string>', // REQUIRED
    'FederationRoleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventDataStoreArn' => '<string>',
    'FederationRoleArn' => '<string>',
    'FederationStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED',
]

Result Details

Errors

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

InvalidParameterException:

The request includes a parameter that is not valid.

InactiveEventDataStoreException:

The event data store is inactive.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

CloudTrailAccessNotEnabledException:

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.

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.

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 Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

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.

OrganizationNotInAllFeaturesModeException:

This exception is thrown when 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.

ConcurrentModificationException:

You are trying to update a resource when another request is in progress. Allow sufficient wait time for the previous request to complete, then retry your request.

AccessDeniedException:

You do not have sufficient access to perform this action.

EventDataStoreFederationEnabledException:

You cannot delete the event data store because Lake query federation is enabled. To delete the event data store, run the DisableFederation operation to disable Lake query federation on the event data store.

GenerateQuery

$result = $client->generateQuery([/* ... */]);
$promise = $client->generateQueryAsync([/* ... */]);

Generates a query from a natural language prompt. This operation uses generative artificial intelligence (generative AI) to produce a ready-to-use SQL query from the prompt.

The prompt can be a question or a statement about the event data in your event data store. For example, you can enter prompts like "What are my top errors in the past month?" and “Give me a list of users that used SNS.”

The prompt must be in English. For information about limitations, permissions, and supported Regions, see Create CloudTrail Lake queries from natural language prompts in the CloudTrail user guide.

Parameter Syntax

$result = $client->generateQuery([
    'EventDataStores' => ['<string>', ...], // REQUIRED
    'Prompt' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventDataStoreOwnerAccountId' => '<string>',
    'QueryAlias' => '<string>',
    'QueryStatement' => '<string>',
]

Result Details

Errors

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

InactiveEventDataStoreException:

The event data store is inactive.

InvalidParameterException:

The request includes a parameter that is not valid.

GenerateResponseException:

This exception is thrown when a valid query could not be generated for the provided prompt.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

GetChannel

$result = $client->getChannel([/* ... */]);
$promise = $client->getChannelAsync([/* ... */]);

Returns information about a specific channel.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'Destinations' => [
        [
            'Location' => '<string>',
            'Type' => 'EVENT_DATA_STORE|AWS_SERVICE',
        ],
        // ...
    ],
    'IngestionStatus' => [
        'LatestIngestionAttemptEventID' => '<string>',
        'LatestIngestionAttemptTime' => <DateTime>,
        'LatestIngestionErrorCode' => '<string>',
        'LatestIngestionSuccessEventID' => '<string>',
        'LatestIngestionSuccessTime' => <DateTime>,
    ],
    'Name' => '<string>',
    'Source' => '<string>',
    'SourceConfig' => [
        'AdvancedEventSelectors' => [
            [
                'FieldSelectors' => [
                    [
                        'EndsWith' => ['<string>', ...],
                        'Equals' => ['<string>', ...],
                        'Field' => '<string>',
                        'NotEndsWith' => ['<string>', ...],
                        'NotEquals' => ['<string>', ...],
                        'NotStartsWith' => ['<string>', ...],
                        'StartsWith' => ['<string>', ...],
                    ],
                    // ...
                ],
                'Name' => '<string>',
            ],
            // ...
        ],
        'ApplyToAllRegions' => true || false,
    ],
]

Result Details

Errors

ChannelARNInvalidException:

This exception is thrown when the specified value of ChannelARN is not valid.

ChannelNotFoundException:

This exception is thrown when CloudTrail cannot find the specified channel.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

GetDashboard

$result = $client->getDashboard([/* ... */]);
$promise = $client->getDashboardAsync([/* ... */]);

Returns the specified dashboard.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedTimestamp' => <DateTime>,
    'DashboardArn' => '<string>',
    'LastRefreshFailureReason' => '<string>',
    'LastRefreshId' => '<string>',
    'RefreshSchedule' => [
        'Frequency' => [
            'Unit' => 'HOURS|DAYS',
            'Value' => <integer>,
        ],
        'Status' => 'ENABLED|DISABLED',
        'TimeOfDay' => '<string>',
    ],
    'Status' => 'CREATING|CREATED|UPDATING|UPDATED|DELETING',
    'TerminationProtectionEnabled' => true || false,
    'Type' => 'MANAGED|CUSTOM',
    'UpdatedTimestamp' => <DateTime>,
    'Widgets' => [
        [
            'QueryAlias' => '<string>',
            'QueryParameters' => ['<string>', ...],
            'QueryStatement' => '<string>',
            'ViewProperties' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

UnsupportedOperationException:

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

GetEventConfiguration

$result = $client->getEventConfiguration([/* ... */]);
$promise = $client->getEventConfigurationAsync([/* ... */]);

Retrieves the current event configuration settings for the specified event data store, including details about maximum event size and context key selectors configured for the event data store.

Parameter Syntax

$result = $client->getEventConfiguration([
    'EventDataStore' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ContextKeySelectors' => [
        [
            'Equals' => ['<string>', ...],
            'Type' => 'TagContext|RequestContext',
        ],
        // ...
    ],
    'EventDataStoreArn' => '<string>',
    'MaxEventSize' => 'Standard|Large',
]

Result Details

Errors

CloudTrailARNInvalidException:

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

UnsupportedOperationException:

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

OperationNotPermittedException:

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

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

InvalidEventDataStoreStatusException:

The event data store is not in a status that supports the operation.

InvalidParameterException:

The request includes a parameter that is not valid.

InvalidEventDataStoreCategoryException:

This exception is thrown when event categories of specified event data stores are not valid.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

InvalidParameterCombinationException:

This exception is thrown when the combination of parameters provided is not valid.

GetEventDataStore

$result = $client->getEventDataStore([/* ... */]);
$promise = $client->getEventDataStoreAsync([/* ... */]);

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AdvancedEventSelectors' => [
        [
            'FieldSelectors' => [
                [
                    'EndsWith' => ['<string>', ...],
                    'Equals' => ['<string>', ...],
                    'Field' => '<string>',
                    'NotEndsWith' => ['<string>', ...],
                    'NotEquals' => ['<string>', ...],
                    'NotStartsWith' => ['<string>', ...],
                    'StartsWith' => ['<string>', ...],
                ],
                // ...
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
    'BillingMode' => 'EXTENDABLE_RETENTION_PRICING|FIXED_RETENTION_PRICING',
    'CreatedTimestamp' => <DateTime>,
    'EventDataStoreArn' => '<string>',
    'FederationRoleArn' => '<string>',
    'FederationStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED',
    'KmsKeyId' => '<string>',
    'MultiRegionEnabled' => true || false,
    'Name' => '<string>',
    'OrganizationEnabled' => true || false,
    'PartitionKeys' => [
        [
            'Name' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'RetentionPeriod' => <integer>,
    'Status' => 'CREATED|ENABLED|PENDING_DELETION|STARTING_INGESTION|STOPPING_INGESTION|STOPPED_INGESTION',
    'TerminationProtectionEnabled' => true || false,
    'UpdatedTimestamp' => <DateTime>,
]

Result Details

Errors

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

InvalidParameterException:

The request includes a parameter that is not valid.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

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:

• If your event selector includes read-only events, write-only events, or all events. This applies to management events, data events, and network activity events.

• If your event selector includes management events.

• If your event selector includes network activity events, the event sources for which you are logging network activity events.

• If your event selector includes data events, the resources on which you are logging data events.

For more information about logging management, data, and network activity events, see the following topics in the CloudTrail User Guide:

• Logging management events

• Logging data events

• Logging network activity events

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AdvancedEventSelectors' => [
        [
            'FieldSelectors' => [
                [
                    'EndsWith' => ['<string>', ...],
                    'Equals' => ['<string>', ...],
                    'Field' => '<string>',
                    'NotEndsWith' => ['<string>', ...],
                    'NotEquals' => ['<string>', ...],
                    'NotStartsWith' => ['<string>', ...],
                    'StartsWith' => ['<string>', ...],
                ],
                // ...
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
    'EventSelectors' => [
        [
            'DataResources' => [
                [
                    'Type' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'ExcludeManagementEventSources' => ['<string>', ...],
            'IncludeManagementEvents' => true || false,
            'ReadWriteType' => 'ReadOnly|WriteOnly|All',
        ],
        // ...
    ],
    'TrailARN' => '<string>',
]

Result Details

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 not valid.

• Not be in IP address format (for example, 192.168.5.4)

CloudTrailARNInvalidException:

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

UnsupportedOperationException:

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

OperationNotPermittedException:

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

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

GetImport

$result = $client->getImport([/* ... */]);
$promise = $client->getImportAsync([/* ... */]);

Returns information about a specific import.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedTimestamp' => <DateTime>,
    'Destinations' => ['<string>', ...],
    'EndEventTime' => <DateTime>,
    'ImportId' => '<string>',
    'ImportSource' => [
        'S3' => [
            'S3BucketAccessRoleArn' => '<string>',
            'S3BucketRegion' => '<string>',
            'S3LocationUri' => '<string>',
        ],
    ],
    'ImportStatistics' => [
        'EventsCompleted' => <integer>,
        'FailedEntries' => <integer>,
        'FilesCompleted' => <integer>,
        'PrefixesCompleted' => <integer>,
        'PrefixesFound' => <integer>,
    ],
    'ImportStatus' => 'INITIALIZING|IN_PROGRESS|FAILED|STOPPED|COMPLETED',
    'StartEventTime' => <DateTime>,
    'UpdatedTimestamp' => <DateTime>,
]

Result Details

Errors

ImportNotFoundException:

The specified import was not found.

InvalidParameterException:

The request includes a parameter that is not valid.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

GetInsightSelectors

$result = $client->getInsightSelectors([/* ... */]);
$promise = $client->getInsightSelectorsAsync([/* ... */]);

Describes the settings for the Insights event selectors that you configured for your trail or event data store. GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail or event data store, and if it is, which Insights types are enabled. If you run GetInsightSelectors on a trail or event data store that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException

Specify either the EventDataStore parameter to get Insights event selectors for an event data store, or the TrailName parameter to the get Insights event selectors for a trail. You cannot specify these parameters together.

For more information, see Working with CloudTrail Insights in the CloudTrail User Guide.

Parameter Syntax

$result = $client->getInsightSelectors([
    'EventDataStore' => '<string>',
    'TrailName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventDataStoreArn' => '<string>',
    'InsightSelectors' => [
        [
            'InsightType' => 'ApiCallRateInsight|ApiErrorRateInsight',
        ],
        // ...
    ],
    'InsightsDestination' => '<string>',
    'TrailARN' => '<string>',
]

Result Details

Errors

InvalidParameterException:

The request includes a parameter that is not valid.

InvalidParameterCombinationException:

This exception is thrown when the combination of parameters provided is not valid.

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 not valid.

• Not be in IP address format (for example, 192.168.5.4)

CloudTrailARNInvalidException:

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

UnsupportedOperationException:

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

OperationNotPermittedException:

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

InsightNotEnabledException:

If you run GetInsightSelectors on a trail or event data store that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

ThrottlingException:

This exception is thrown when the request rate exceeds the limit.

GetQueryResults

$result = $client->getQueryResults([/* ... */]);
$promise = $client->getQueryResultsAsync([/* ... */]);

Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation.

Parameter Syntax

$result = $client->getQueryResults([
    'EventDataStore' => '<string>',
    'EventDataStoreOwnerAccountId' => '<string>',
    'MaxQueryResults' => <integer>,
    'NextToken' => '<string>',
    'QueryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ErrorMessage' => '<string>',
    'NextToken' => '<string>',
    'QueryResultRows' => [
        [
            ['<string>', ...],
            // ...
        ],
        // ...
    ],
    'QueryStatistics' => [
        'BytesScanned' => <integer>,
        'ResultsCount' => <integer>,
        'TotalResultsCount' => <integer>,
    ],
    'QueryStatus' => 'QUEUED|RUNNING|FINISHED|FAILED|CANCELLED|TIMED_OUT',
]

Result Details

Errors

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

InactiveEventDataStoreException:

The event data store is inactive.

InvalidMaxResultsException:

This exception is thrown if the limit specified is not valid.

InvalidNextTokenException:

A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.

InvalidParameterException:

The request includes a parameter that is not valid.

QueryIdNotFoundException:

The query ID does not exist or does not map to a query.

InsufficientEncryptionPolicyException:

For the CreateTrail PutInsightSelectors, UpdateTrail, StartQuery, and StartImport operations, this exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.

For all other operations, this exception is thrown when the policy for the KMS key does not have sufficient permissions for the operation.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Retrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DelegatedAdminResourcePolicy' => '<string>',
    'ResourceArn' => '<string>',
    'ResourcePolicy' => '<string>',
]

Result Details

Errors

ResourceARNNotValidException:

This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

ResourceNotFoundException:

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

ResourcePolicyNotFoundException:

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

ResourceTypeNotSupportedException:

This exception is thrown when the specified resource type is not supported by CloudTrail.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

GetTrail

$result = $client->getTrail([/* ... */]);
$promise = $client->getTrailAsync([/* ... */]);

Returns settings information for a specified trail.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

CloudTrailARNInvalidException:

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

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 not valid.

• 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

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

Errors

CloudTrailARNInvalidException:

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

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 not valid.

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

ListChannels

$result = $client->listChannels([/* ... */]);
$promise = $client->listChannelsAsync([/* ... */]);

Lists the channels in the current account, and their source names.

Parameter Syntax

$result = $client->listChannels([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Channels' => [
        [
            'ChannelArn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidNextTokenException:

A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

ListDashboards

$result = $client->listDashboards([/* ... */]);
$promise = $client->listDashboardsAsync([/* ... */]);

Returns information about all dashboards in the account, in the current Region.

Parameter Syntax

$result = $client->listDashboards([
    'MaxResults' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
    'Type' => 'MANAGED|CUSTOM',
]);

Parameter Details

Result Syntax

[
    'Dashboards' => [
        [
            'DashboardArn' => '<string>',
            'Type' => 'MANAGED|CUSTOM',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

UnsupportedOperationException:

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

ListEventDataStores

$result = $client->listEventDataStores([/* ... */]);
$promise = $client->listEventDataStoresAsync([/* ... */]);

Returns information about all event data stores in the account, in the current Region.

Parameter Syntax

$result = $client->listEventDataStores([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventDataStores' => [
        [
            'AdvancedEventSelectors' => [
                [
                    'FieldSelectors' => [
                        [
                            'EndsWith' => ['<string>', ...],
                            'Equals' => ['<string>', ...],
                            'Field' => '<string>',
                            'NotEndsWith' => ['<string>', ...],
                            'NotEquals' => ['<string>', ...],
                            'NotStartsWith' => ['<string>', ...],
                            'StartsWith' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'Name' => '<string>',
                ],
                // ...
            ],
            'CreatedTimestamp' => <DateTime>,
            'EventDataStoreArn' => '<string>',
            'MultiRegionEnabled' => true || false,
            'Name' => '<string>',
            'OrganizationEnabled' => true || false,
            'RetentionPeriod' => <integer>,
            'Status' => 'CREATED|ENABLED|PENDING_DELETION|STARTING_INGESTION|STOPPING_INGESTION|STOPPED_INGESTION',
            'TerminationProtectionEnabled' => true || false,
            'UpdatedTimestamp' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidMaxResultsException:

This exception is thrown if the limit specified is not valid.

InvalidNextTokenException:

A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

ListImportFailures

$result = $client->listImportFailures([/* ... */]);
$promise = $client->listImportFailuresAsync([/* ... */]);

Returns a list of failures for the specified import.

Parameter Syntax

$result = $client->listImportFailures([
    'ImportId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Failures' => [
        [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'Location' => '<string>',
            'Status' => 'FAILED|RETRY|SUCCEEDED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidNextTokenException:

A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

InvalidParameterException:

The request includes a parameter that is not valid.

ListImports

$result = $client->listImports([/* ... */]);
$promise = $client->listImportsAsync([/* ... */]);

Returns information on all imports, or a select set of imports by ImportStatus or Destination.

Parameter Syntax

$result = $client->listImports([
    'Destination' => '<string>',
    'ImportStatus' => 'INITIALIZING|IN_PROGRESS|FAILED|STOPPED|COMPLETED',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Imports' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'Destinations' => ['<string>', ...],
            'ImportId' => '<string>',
            'ImportStatus' => 'INITIALIZING|IN_PROGRESS|FAILED|STOPPED|COMPLETED',
            'UpdatedTimestamp' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

InvalidNextTokenException:

A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.

InvalidParameterException:

The request includes a parameter that is not valid.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

ListInsightsMetricData

$result = $client->listInsightsMetricData([/* ... */]);
$promise = $client->listInsightsMetricDataAsync([/* ... */]);

Returns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, EventName, and InsightType parameters.

If the InsightType is set to ApiErrorRateInsight, the request must also include the ErrorCode parameter.

The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive.

• Data points with a period of 60 seconds (1-minute) are available for 15 days.

• Data points with a period of 300 seconds (5-minute) are available for 63 days.

• Data points with a period of 3600 seconds (1 hour) are available for 90 days.

Access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action. To use this operation, you must have permissions to perform the cloudtrail:LookupEvents action.

Parameter Syntax

$result = $client->listInsightsMetricData([
    'DataType' => 'FillWithZeros|NonZeroData',
    'EndTime' => <integer || string || DateTime>,
    'ErrorCode' => '<string>',
    'EventName' => '<string>', // REQUIRED
    'EventSource' => '<string>', // REQUIRED
    'InsightType' => 'ApiCallRateInsight|ApiErrorRateInsight', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Period' => <integer>,
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'ErrorCode' => '<string>',
    'EventName' => '<string>',
    'EventSource' => '<string>',
    'InsightType' => 'ApiCallRateInsight|ApiErrorRateInsight',
    'NextToken' => '<string>',
    'Timestamps' => [<DateTime>, ...],
    'Values' => [<float>, ...],
]

Result Details

Errors

InvalidParameterException:

The request includes a parameter that is not valid.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidTimeRangeException:

Occurs if the timestamp values are not valid. 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.

ListQueries

$result = $client->listQueries([/* ... */]);
$promise = $client->listQueriesAsync([/* ... */]);

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

Parameter Syntax

$result = $client->listQueries([
    'EndTime' => <integer || string || DateTime>,
    'EventDataStore' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QueryStatus' => 'QUEUED|RUNNING|FINISHED|FAILED|CANCELLED|TIMED_OUT',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Queries' => [
        [
            'CreationTime' => <DateTime>,
            'QueryId' => '<string>',
            'QueryStatus' => 'QUEUED|RUNNING|FINISHED|FAILED|CANCELLED|TIMED_OUT',
        ],
        // ...
    ],
]

Result Details

Errors

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

InactiveEventDataStoreException:

The event data store is inactive.

InvalidDateRangeException:

A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.

InvalidMaxResultsException:

This exception is thrown if the limit specified is not valid.

InvalidNextTokenException:

A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.

InvalidParameterException:

The request includes a parameter that is not valid.

InvalidQueryStatusException:

The query status is not valid for the operation.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

ListTags

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

Lists the tags for the specified trails, event data stores, dashboards, or channels in the current Region.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

ChannelARNInvalidException:

This exception is thrown when the specified value of ChannelARN is not valid.

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 not valid.

• Not be in IP address format (for example, 192.168.5.4)

InactiveEventDataStoreException:

The event data store is inactive.

EventDataStoreNotFoundException:

The specified event data store was not found.

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.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

ListTrails

$result = $client->listTrails([/* ... */]);
$promise = $client->listTrailsAsync([/* ... */]);

Lists trails that are in the current account.

Parameter Syntax

$result = $client->listTrails([
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Trails' => [
        [
            'HomeRegion' => '<string>',
            'Name' => '<string>',
            'TrailARN' => '<string>',
        ],
        // ...
    ],
]

Result Details

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.

LookupEvents

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

Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days.

Lookup supports the following attributes for management events:

• Amazon Web Services access key

• Event ID

• Event name

• Event source

• Read only

• Resource name

• Resource type

• User name

Lookup supports the following attributes for Insights events:

• Event ID

• Event name

• Event source

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidLookupAttributesException:

Occurs when a lookup attribute is specified that is not valid.

InvalidTimeRangeException:

Occurs if the timestamp values are not valid. 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 not valid.

InvalidNextTokenException:

A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.

InvalidEventCategoryException:

Occurs if an event category that is not valid is specified as a value of EventCategory.

UnsupportedOperationException:

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

OperationNotPermittedException:

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

PutEventConfiguration

$result = $client->putEventConfiguration([/* ... */]);
$promise = $client->putEventConfigurationAsync([/* ... */]);

Updates the event configuration settings for the specified event data store. You can update the maximum event size and context key selectors.

Parameter Syntax

$result = $client->putEventConfiguration([
    'ContextKeySelectors' => [ // REQUIRED
        [
            'Equals' => ['<string>', ...], // REQUIRED
            'Type' => 'TagContext|RequestContext', // REQUIRED
        ],
        // ...
    ],
    'EventDataStore' => '<string>',
    'MaxEventSize' => 'Standard|Large', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContextKeySelectors' => [
        [
            'Equals' => ['<string>', ...],
            'Type' => 'TagContext|RequestContext',
        ],
        // ...
    ],
    'EventDataStoreArn' => '<string>',
    'MaxEventSize' => 'Standard|Large',
]

Result Details

Errors

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

EventDataStoreNotFoundException:

The specified event data store was not found.

InvalidEventDataStoreStatusException:

The event data store is not in a status that supports the operation.

InvalidEventDataStoreCategoryException:

This exception is thrown when event categories of specified event data stores are not valid.

InactiveEventDataStoreException:

The event data store is inactive.

UnsupportedOperationException:

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

OperationNotPermittedException:

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

ThrottlingException:

This exception is thrown when the request rate exceeds the limit.

InvalidParameterException:

The request includes a parameter that is not valid.

InvalidParameterCombinationException:

This exception is thrown when the combination of parameters provided is not valid.

CloudTrailARNInvalidException:

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

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.

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 Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

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.

InsufficientIAMAccessPermissionException:

The task can't be completed because you are signed in with an account that lacks permissions to view or create a service-linked role. Sign in with an account that has the required permissions and then try again.

PutEventSelectors

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

Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten.

You can use AdvancedEventSelectors to log management events, data events for all resource types, and network activity events.

You can use EventSelectors to log management events and data events for the following resource types:

• AWS::DynamoDB::Table

• AWS::Lambda::Function

• AWS::S3::Object

You can't use EventSelectors to log network activity events.

If you want your trail to log Insights events, be sure the event selector or advanced event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Working with CloudTrail Insights in the CloudTrail User Guide. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events or network activity events.

When an event occurs in your account, CloudTrail evaluates the event selectors or advanced 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

1. You create an event selector for a trail and specify that you want to log write-only events.

2. The EC2 GetConsoleOutput and RunInstances API operations occur in your account.

3. CloudTrail evaluates whether the events match your event selectors.

4. The RunInstances is a write-only event and it matches your event selector. The trail logs the event.

5. The GetConsoleOutput is a read-only event that 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 exception is thrown.

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

You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. For more information, see Logging management events, Logging data events, Logging network activity events, and Quotas in CloudTrail in the CloudTrail User Guide.

Parameter Syntax

$result = $client->putEventSelectors([
    'AdvancedEventSelectors' => [
        [
            'FieldSelectors' => [ // REQUIRED
                [
                    'EndsWith' => ['<string>', ...],
                    'Equals' => ['<string>', ...],
                    'Field' => '<string>', // REQUIRED
                    'NotEndsWith' => ['<string>', ...],
                    'NotEquals' => ['<string>', ...],
                    'NotStartsWith' => ['<string>', ...],
                    'StartsWith' => ['<string>', ...],
                ],
                // ...
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
    'EventSelectors' => [
        [
            'DataResources' => [
                [
                    'Type' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'ExcludeManagementEventSources' => ['<string>', ...],
            'IncludeManagementEvents' => true || false,
            'ReadWriteType' => 'ReadOnly|WriteOnly|All',
        ],
        // ...
    ],
    'TrailName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AdvancedEventSelectors' => [
        [
            'FieldSelectors' => [
                [
                    'EndsWith' => ['<string>', ...],
                    'Equals' => ['<string>', ...],
                    'Field' => '<string>',
                    'NotEndsWith' => ['<string>', ...],
                    'NotEquals' => ['<string>', ...],
                    'NotStartsWith' => ['<string>', ...],
                    'StartsWith' => ['<string>', ...],
                ],
                // ...
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
    'EventSelectors' => [
        [
            'DataResources' => [
                [
                    'Type' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'ExcludeManagementEventSources' => ['<string>', ...],
            'IncludeManagementEvents' => true || false,
            'ReadWriteType' => 'ReadOnly|WriteOnly|All',
        ],
        // ...
    ],
    'TrailARN' => '<string>',
]

Result Details

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 not valid.

• Not be in IP address format (for example, 192.168.5.4)

CloudTrailARNInvalidException:

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

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 a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.

You can:

• 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. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.

• Specify up to 500 values for all conditions in all advanced event selectors for a trail.

• Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is not valid.

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.

ThrottlingException:

This exception is thrown when the request rate exceeds the limit.

UnsupportedOperationException:

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

OperationNotPermittedException:

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

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 Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

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.

PutInsightSelectors

$result = $client->putInsightSelectors([/* ... */]);
$promise = $client->putInsightSelectorsAsync([/* ... */]);

Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types are ApiErrorRateInsight and ApiCallRateInsight.

To enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source event data store (EventDataStore) and the destination event data store (InsightsDestination). The source event data store logs management events and enables Insights. The destination event data store logs Insights events based upon the management event activity of the source event data store. The source and destination event data stores must belong to the same Amazon Web Services account.

To log Insights events for a trail, you must specify the name (TrailName) of the CloudTrail trail for which you want to change or add Insights selectors.

To log CloudTrail Insights events on API call volume, the trail or event data store must log write management events. To log CloudTrail Insights events on API error rate, the trail or event data store must log read or write management events. You can call GetEventSelectors on a trail to check whether the trail logs management events. You can call GetEventDataStore on an event data store to check whether the event data store logs management events.

For more information, see Working with CloudTrail Insights in the CloudTrail User Guide.

Parameter Syntax

$result = $client->putInsightSelectors([
    'EventDataStore' => '<string>',
    'InsightSelectors' => [ // REQUIRED
        [
            'InsightType' => 'ApiCallRateInsight|ApiErrorRateInsight',
        ],
        // ...
    ],
    'InsightsDestination' => '<string>',
    'TrailName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventDataStoreArn' => '<string>',
    'InsightSelectors' => [
        [
            'InsightType' => 'ApiCallRateInsight|ApiErrorRateInsight',
        ],
        // ...
    ],
    'InsightsDestination' => '<string>',
    'TrailARN' => '<string>',
]

Result Details

Errors

InvalidParameterException:

The request includes a parameter that is not valid.

InvalidParameterCombinationException:

This exception is thrown when the combination of parameters provided is not valid.

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 not valid.

• Not be in IP address format (for example, 192.168.5.4)

CloudTrailARNInvalidException:

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

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.

InvalidInsightSelectorsException:

For PutInsightSelectors, this exception is thrown when the formatting or syntax of the InsightSelectors JSON statement is not valid, or the specified InsightType in the InsightSelectors statement is not valid. Valid values for InsightType are ApiCallRateInsight and ApiErrorRateInsight. To enable Insights on an event data store, the destination event data store specified by the InsightsDestination parameter must log Insights events and the source event data store specified by the EventDataStore parameter must log management events.

For UpdateEventDataStore, this exception is thrown if Insights are enabled on the event data store and the updated advanced event selectors are not compatible with the configured InsightSelectors. If the InsightSelectors includes an InsightType of ApiCallRateInsight, the source event data store must log write management events. If the InsightSelectors includes an InsightType of ApiErrorRateInsight, the source event data store must log management events.

InsufficientS3BucketPolicyException:

This exception is thrown when the policy on the S3 bucket is not sufficient.

InsufficientEncryptionPolicyException:

For the CreateTrail PutInsightSelectors, UpdateTrail, StartQuery, and StartImport operations, this exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.

For all other operations, this exception is thrown when the policy for the KMS key does not have sufficient permissions for the operation.

S3BucketDoesNotExistException:

This exception is thrown when the specified S3 bucket does not exist.

KmsException:

This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.

UnsupportedOperationException:

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

OperationNotPermittedException:

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

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 Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

ThrottlingException:

This exception is thrown when the request rate exceeds the limit.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.

Parameter Syntax

$result = $client->putResourcePolicy([
    'ResourceArn' => '<string>', // REQUIRED
    'ResourcePolicy' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DelegatedAdminResourcePolicy' => '<string>',
    'ResourceArn' => '<string>',
    'ResourcePolicy' => '<string>',
]

Result Details

Errors

ResourceARNNotValidException:

This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

ResourcePolicyNotValidException:

This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is not valid.

ResourceNotFoundException:

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

ResourceTypeNotSupportedException:

This exception is thrown when the specified resource type is not supported by CloudTrail.

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.

OperationNotPermittedException:

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

UnsupportedOperationException:

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

RegisterOrganizationDelegatedAdmin

$result = $client->registerOrganizationDelegatedAdmin([/* ... */]);
$promise = $client->registerOrganizationDelegatedAdminAsync([/* ... */]);

Registers an organization’s member account as the CloudTrail delegated administrator.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccountRegisteredException:

This exception is thrown when the account is already registered as the CloudTrail delegated administrator.

AccountNotFoundException:

This exception is thrown when the specified account is not found or not part of an organization.

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.

InvalidParameterException:

The request includes a parameter that is not valid.

CannotDelegateManagementAccountException:

This exception is thrown when the management account of an organization is registered as the CloudTrail delegated administrator.

CloudTrailAccessNotEnabledException:

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.

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.

DelegatedAdminAccountLimitExceededException:

This exception is thrown when the maximum number of CloudTrail delegated administrators is reached.

NotOrganizationManagementAccountException:

This exception is thrown when the account making the request is not the organization's management account.

OrganizationNotInAllFeaturesModeException:

This exception is thrown when 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.

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.

UnsupportedOperationException:

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

OperationNotPermittedException:

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

InsufficientIAMAccessPermissionException:

The task can't be completed because you are signed in with an account that lacks permissions to view or create a service-linked role. Sign in with an account that has the required permissions and then try again.

RemoveTags

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

Removes the specified tags from a trail, event data store, dashboard, or channel.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

EventDataStoreARNInvalidException:

The specified event data store ARN is not valid or does not map to an event data store in your account.

ChannelARNInvalidException:

This exception is thrown when the specified value of ChannelARN is not valid.

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 not valid.

• Not be in IP address format (for example, 192.168.5.4)

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.

InactiveEventDataStoreException:

The event data store is inactive.

EventDataStoreNotFoundException:

The specified event data store was not found.

ChannelNotFoundException:

This exception is thrown when CloudTrail cannot find the specified channel.

UnsupportedOperationException:

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

OperationNotPermittedException:

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

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 Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

NoManagementAccountSLRExistsException:

This exception is thrown when the management account does not have a service-linked role.

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.