# Packages
Package cloudtrailiface provides an interface to enable mocking the AWS CloudTrail service client for testing your code.
# Functions
BillingMode_Values returns all elements of the BillingMode enum.
DeliveryStatus_Values returns all elements of the DeliveryStatus enum.
DestinationType_Values returns all elements of the DestinationType enum.
EventCategory_Values returns all elements of the EventCategory enum.
EventDataStoreStatus_Values returns all elements of the EventDataStoreStatus enum.
FederationStatus_Values returns all elements of the FederationStatus enum.
ImportFailureStatus_Values returns all elements of the ImportFailureStatus enum.
ImportStatus_Values returns all elements of the ImportStatus enum.
InsightsMetricDataType_Values returns all elements of the InsightsMetricDataType enum.
InsightType_Values returns all elements of the InsightType enum.
LookupAttributeKey_Values returns all elements of the LookupAttributeKey enum.
New creates a new instance of the CloudTrail client with a session.
QueryStatus_Values returns all elements of the QueryStatus enum.
ReadWriteType_Values returns all elements of the ReadWriteType enum.
# Constants
BillingModeExtendableRetentionPricing is a BillingMode enum value.
BillingModeFixedRetentionPricing is a BillingMode enum value.
DeliveryStatusAccessDenied is a DeliveryStatus enum value.
DeliveryStatusAccessDeniedSigningFile is a DeliveryStatus enum value.
DeliveryStatusCancelled is a DeliveryStatus enum value.
DeliveryStatusFailed is a DeliveryStatus enum value.
DeliveryStatusFailedSigningFile is a DeliveryStatus enum value.
DeliveryStatusPending is a DeliveryStatus enum value.
DeliveryStatusResourceNotFound is a DeliveryStatus enum value.
DeliveryStatusSuccess is a DeliveryStatus enum value.
DeliveryStatusUnknown is a DeliveryStatus enum value.
DestinationTypeAwsService is a DestinationType enum value.
DestinationTypeEventDataStore is a DestinationType enum value.
ID to lookup a service endpoint with.
ErrCodeAccessDeniedException for service response error code "AccessDeniedException".
ErrCodeAccessNotEnabledException for service response error code "CloudTrailAccessNotEnabledException".
ErrCodeAccountHasOngoingImportException for service response error code "AccountHasOngoingImportException".
ErrCodeAccountNotFoundException for service response error code "AccountNotFoundException".
ErrCodeAccountNotRegisteredException for service response error code "AccountNotRegisteredException".
ErrCodeAccountRegisteredException for service response error code "AccountRegisteredException".
ErrCodeARNInvalidException for service response error code "CloudTrailARNInvalidException".
ErrCodeCannotDelegateManagementAccountException for service response error code "CannotDelegateManagementAccountException".
ErrCodeChannelAlreadyExistsException for service response error code "ChannelAlreadyExistsException".
ErrCodeChannelARNInvalidException for service response error code "ChannelARNInvalidException".
ErrCodeChannelExistsForEDSException for service response error code "ChannelExistsForEDSException".
ErrCodeChannelMaxLimitExceededException for service response error code "ChannelMaxLimitExceededException".
ErrCodeChannelNotFoundException for service response error code "ChannelNotFoundException".
ErrCodeCloudTrailInvalidClientTokenIdException for service response error code "CloudTrailInvalidClientTokenIdException".
ErrCodeCloudWatchLogsDeliveryUnavailableException for service response error code "CloudWatchLogsDeliveryUnavailableException".
ErrCodeConcurrentModificationException for service response error code "ConcurrentModificationException".
ErrCodeConflictException for service response error code "ConflictException".
ErrCodeDelegatedAdminAccountLimitExceededException for service response error code "DelegatedAdminAccountLimitExceededException".
ErrCodeEventDataStoreAlreadyExistsException for service response error code "EventDataStoreAlreadyExistsException".
ErrCodeEventDataStoreARNInvalidException for service response error code "EventDataStoreARNInvalidException".
ErrCodeEventDataStoreFederationEnabledException for service response error code "EventDataStoreFederationEnabledException".
ErrCodeEventDataStoreHasOngoingImportException for service response error code "EventDataStoreHasOngoingImportException".
ErrCodeEventDataStoreMaxLimitExceededException for service response error code "EventDataStoreMaxLimitExceededException".
ErrCodeEventDataStoreNotFoundException for service response error code "EventDataStoreNotFoundException".
ErrCodeEventDataStoreTerminationProtectedException for service response error code "EventDataStoreTerminationProtectedException".
ErrCodeImportNotFoundException for service response error code "ImportNotFoundException".
ErrCodeInactiveEventDataStoreException for service response error code "InactiveEventDataStoreException".
ErrCodeInactiveQueryException for service response error code "InactiveQueryException".
ErrCodeInsightNotEnabledException for service response error code "InsightNotEnabledException".
ErrCodeInsufficientDependencyServiceAccessPermissionException for service response error code "InsufficientDependencyServiceAccessPermissionException".
ErrCodeInsufficientEncryptionPolicyException for service response error code "InsufficientEncryptionPolicyException".
ErrCodeInsufficientS3BucketPolicyException for service response error code "InsufficientS3BucketPolicyException".
ErrCodeInsufficientSnsTopicPolicyException for service response error code "InsufficientSnsTopicPolicyException".
ErrCodeInvalidCloudWatchLogsLogGroupArnException for service response error code "InvalidCloudWatchLogsLogGroupArnException".
ErrCodeInvalidCloudWatchLogsRoleArnException for service response error code "InvalidCloudWatchLogsRoleArnException".
ErrCodeInvalidDateRangeException for service response error code "InvalidDateRangeException".
ErrCodeInvalidEventCategoryException for service response error code "InvalidEventCategoryException".
ErrCodeInvalidEventDataStoreCategoryException for service response error code "InvalidEventDataStoreCategoryException".
ErrCodeInvalidEventDataStoreStatusException for service response error code "InvalidEventDataStoreStatusException".
ErrCodeInvalidEventSelectorsException for service response error code "InvalidEventSelectorsException".
ErrCodeInvalidHomeRegionException for service response error code "InvalidHomeRegionException".
ErrCodeInvalidImportSourceException for service response error code "InvalidImportSourceException".
ErrCodeInvalidInsightSelectorsException for service response error code "InvalidInsightSelectorsException".
ErrCodeInvalidKmsKeyIdException for service response error code "InvalidKmsKeyIdException".
ErrCodeInvalidLookupAttributesException for service response error code "InvalidLookupAttributesException".
ErrCodeInvalidMaxResultsException for service response error code "InvalidMaxResultsException".
ErrCodeInvalidNextTokenException for service response error code "InvalidNextTokenException".
ErrCodeInvalidParameterCombinationException for service response error code "InvalidParameterCombinationException".
ErrCodeInvalidParameterException for service response error code "InvalidParameterException".
ErrCodeInvalidQueryStatementException for service response error code "InvalidQueryStatementException".
ErrCodeInvalidQueryStatusException for service response error code "InvalidQueryStatusException".
ErrCodeInvalidS3BucketNameException for service response error code "InvalidS3BucketNameException".
ErrCodeInvalidS3PrefixException for service response error code "InvalidS3PrefixException".
ErrCodeInvalidSnsTopicNameException for service response error code "InvalidSnsTopicNameException".
ErrCodeInvalidSourceException for service response error code "InvalidSourceException".
ErrCodeInvalidTagParameterException for service response error code "InvalidTagParameterException".
ErrCodeInvalidTimeRangeException for service response error code "InvalidTimeRangeException".
ErrCodeInvalidTokenException for service response error code "InvalidTokenException".
ErrCodeInvalidTrailNameException for service response error code "InvalidTrailNameException".
ErrCodeKmsException for service response error code "KmsException".
ErrCodeKmsKeyDisabledException for service response error code "KmsKeyDisabledException".
ErrCodeKmsKeyNotFoundException for service response error code "KmsKeyNotFoundException".
ErrCodeMaxConcurrentQueriesException for service response error code "MaxConcurrentQueriesException".
ErrCodeMaximumNumberOfTrailsExceededException for service response error code "MaximumNumberOfTrailsExceededException".
ErrCodeNoManagementAccountSLRExistsException for service response error code "NoManagementAccountSLRExistsException".
ErrCodeNotOrganizationManagementAccountException for service response error code "NotOrganizationManagementAccountException".
ErrCodeNotOrganizationMasterAccountException for service response error code "NotOrganizationMasterAccountException".
ErrCodeOperationNotPermittedException for service response error code "OperationNotPermittedException".
ErrCodeOrganizationNotInAllFeaturesModeException for service response error code "OrganizationNotInAllFeaturesModeException".
ErrCodeOrganizationsNotInUseException for service response error code "OrganizationsNotInUseException".
ErrCodeQueryIdNotFoundException for service response error code "QueryIdNotFoundException".
ErrCodeResourceARNNotValidException for service response error code "ResourceARNNotValidException".
ErrCodeResourceNotFoundException for service response error code "ResourceNotFoundException".
ErrCodeResourcePolicyNotFoundException for service response error code "ResourcePolicyNotFoundException".
ErrCodeResourcePolicyNotValidException for service response error code "ResourcePolicyNotValidException".
ErrCodeResourceTypeNotSupportedException for service response error code "ResourceTypeNotSupportedException".
ErrCodeS3BucketDoesNotExistException for service response error code "S3BucketDoesNotExistException".
ErrCodeTagsLimitExceededException for service response error code "TagsLimitExceededException".
ErrCodeThrottlingException for service response error code "ThrottlingException".
ErrCodeTrailAlreadyExistsException for service response error code "TrailAlreadyExistsException".
ErrCodeTrailNotFoundException for service response error code "TrailNotFoundException".
ErrCodeTrailNotProvidedException for service response error code "TrailNotProvidedException".
ErrCodeUnsupportedOperationException for service response error code "UnsupportedOperationException".
EventCategoryInsight is a EventCategory enum value.
EventDataStoreStatusCreated is a EventDataStoreStatus enum value.
EventDataStoreStatusEnabled is a EventDataStoreStatus enum value.
EventDataStoreStatusPendingDeletion is a EventDataStoreStatus enum value.
EventDataStoreStatusStartingIngestion is a EventDataStoreStatus enum value.
EventDataStoreStatusStoppedIngestion is a EventDataStoreStatus enum value.
EventDataStoreStatusStoppingIngestion is a EventDataStoreStatus enum value.
FederationStatusDisabled is a FederationStatus enum value.
FederationStatusDisabling is a FederationStatus enum value.
FederationStatusEnabled is a FederationStatus enum value.
FederationStatusEnabling is a FederationStatus enum value.
ImportFailureStatusFailed is a ImportFailureStatus enum value.
ImportFailureStatusRetry is a ImportFailureStatus enum value.
ImportFailureStatusSucceeded is a ImportFailureStatus enum value.
ImportStatusCompleted is a ImportStatus enum value.
ImportStatusFailed is a ImportStatus enum value.
ImportStatusInitializing is a ImportStatus enum value.
ImportStatusInProgress is a ImportStatus enum value.
ImportStatusStopped is a ImportStatus enum value.
InsightsMetricDataTypeFillWithZeros is a InsightsMetricDataType enum value.
InsightsMetricDataTypeNonZeroData is a InsightsMetricDataType enum value.
InsightTypeApiCallRateInsight is a InsightType enum value.
InsightTypeApiErrorRateInsight is a InsightType enum value.
LookupAttributeKeyAccessKeyId is a LookupAttributeKey enum value.
LookupAttributeKeyEventId is a LookupAttributeKey enum value.
LookupAttributeKeyEventName is a LookupAttributeKey enum value.
LookupAttributeKeyEventSource is a LookupAttributeKey enum value.
LookupAttributeKeyReadOnly is a LookupAttributeKey enum value.
LookupAttributeKeyResourceName is a LookupAttributeKey enum value.
LookupAttributeKeyResourceType is a LookupAttributeKey enum value.
LookupAttributeKeyUsername is a LookupAttributeKey enum value.
QueryStatusCancelled is a QueryStatus enum value.
QueryStatusFailed is a QueryStatus enum value.
QueryStatusFinished is a QueryStatus enum value.
QueryStatusQueued is a QueryStatus enum value.
QueryStatusRunning is a QueryStatus enum value.
QueryStatusTimedOut is a QueryStatus enum value.
ReadWriteTypeAll is a ReadWriteType enum value.
ReadWriteTypeReadOnly is a ReadWriteType enum value.
ReadWriteTypeWriteOnly is a ReadWriteType enum value.
ServiceID is a unique identifier of a specific service.
Name of service.
# Structs
You do not have sufficient access to perform this action.
This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations.
This exception is thrown when you start a new import and a previous import is still in progress.
This exception is thrown when the specified account is not found or not part of an organization.
This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.
This exception is thrown when the account is already registered as the CloudTrail delegated administrator.
Specifies the tags to add to a trail, event data store, or channel.
Returns the objects or data if successful.
Advanced event selectors let you create fine-grained selectors for CloudTrail management and data events.
A single selector statement in an advanced event selector.
This exception is thrown when an operation is called with an ARN that is not valid.
This exception is thrown when the management account of an organization is registered as the CloudTrail delegated administrator.
Contains information about a returned CloudTrail channel.
This exception is thrown when the provided channel already exists.
This exception is thrown when the specified value of ChannelARN is not valid.
This exception is thrown when the specified event data store cannot yet be deleted because it is in use by a channel.
This exception is thrown when the maximum number of channels limit is exceeded.
This exception is thrown when CloudTrail cannot find the specified channel.
CloudTrail provides the API operation methods for making requests to AWS CloudTrail.
This exception is thrown when a call results in the InvalidClientTokenId error code.
Cannot set a CloudWatch Logs delivery for this Region.
You are trying to update a resource when another request is in progress.
This exception is thrown when the specified resource is not ready for an operation.
Specifies the settings for each trail.
Returns the objects or data listed below if successful.
Data events provide information about the resource operations performed on or within a resource itself.
This exception is thrown when the maximum number of CloudTrail delegated administrators is reached.
The request that specifies the name of a trail to delete.
Returns the objects or data listed below if successful.
Removes CloudTrail delegated administrator permissions from a specified member account in an organization that is currently designated as a delegated administrator.
Returns the following response if successful.
Returns information about the trail.
Returns the objects or data listed below if successful.
Contains information about the destination receiving events.
Contains information about an event that was returned by a lookup request.
A storage lake of event data against which you can run complex SQL-based queries.
An event data store with that name already exists.
The specified event data store ARN is not valid or does not map to an event data store in your account.
You cannot delete the event data store because Lake query federation is enabled.
This exception is thrown when you try to update or delete an event data store that currently has an import in progress.
Your account has used the maximum number of event data stores.
The specified event data store was not found.
The event data store cannot be deleted because termination protection is enabled for it.
Use event selectors to further specify the management and data event settings for your trail.
The name of a trail about which you want the current status.
Returns the objects or data listed below if successful.
Provides information about an import failure.
The specified import was not found.
Contains information about an import that was returned by a lookup request.
The import source.
Provides statistics for the specified ImportID.
The event data store is inactive.
The specified query cannot be canceled because it is in the FINISHED, FAILED, TIMED_OUT, or CANCELLED state.
A table showing information about the most recent successful and failed attempts to ingest events.
If you run GetInsightSelectors on a trail or event data store that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException.
A JSON string that contains a list of Insights types that are logged on a trail or event data store.
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.
This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
This exception is thrown when the policy on the S3 bucket is not sufficient.
This exception is thrown when the policy on the Amazon SNS topic is not sufficient.
This exception is thrown when the provided CloudWatch Logs log group is not valid.
This exception is thrown when the provided role is not valid.
A date range for the query was specified that is not valid.
Occurs if an event category that is not valid is specified as a value of EventCategory.
This exception is thrown when event categories of specified event data stores are not valid.
The event data store is not in a status that supports the operation.
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.
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.
This exception is thrown when the provided source S3 bucket is not valid for import.
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.
This exception is thrown when the KMS key ARN is not valid.
Occurs when a lookup attribute is specified that is not valid.
This exception is thrown if the limit specified is not valid.
A token that is not valid, or a token that was previously used in a request with different parameters.
This exception is thrown when the combination of parameters provided is not valid.
The request includes a parameter that is not valid.
The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords.
The query status is not valid for the operation.
This exception is thrown when the provided S3 bucket name is not valid.
This exception is thrown when the provided S3 prefix is not valid.
This exception is thrown when the provided SNS topic name is not valid.
This exception is thrown when the specified value of Source is not valid.
This exception is thrown when the specified tag key or values are not valid.
Occurs if the timestamp values are not valid.
Reserved for future use.
This exception is thrown when the provided trail name is not valid.
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.
This exception is no longer in use.
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.
Requests the public keys for a specified time range.
Returns the objects or data listed below if successful.
Specifies a list of tags to return.
Returns the objects or data listed below if successful.
Specifies an attribute and value that filter the events returned.
Contains a request for LookupEvents.
Contains a response to a LookupEvents action.
You are already running the maximum number of concurrent queries.
This exception is thrown when the maximum number of trails is reached.
This exception is thrown when the management account does not have a service-linked role.
This exception is thrown when the account making the request is not the organization's management account.
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.
This exception is thrown when the requested operation is not permitted.
This exception is thrown when Organizations is not configured to support all features.
This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization.
Contains information about a partition key for an event data store.
Contains information about a returned public key.
A SQL string of criteria about events that you want to collect in an event data store.
The query ID does not exist or does not map to a query.
Metadata about a query, such as the number of results.
Gets metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.
Specifies an organization member account ID as a CloudTrail delegated administrator.
Returns the following response if successful.
Specifies the tags to remove from a trail, event data store, or channel.
Returns the objects or data listed below if successful.
Specifies the type and name of a resource referenced by an event.
This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.
This exception is thrown when the specified resource is not found.
This exception is thrown when the specified resource policy is not found.
This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is not valid.
A resource tag.
This exception is thrown when the specified resource type is not supported by CloudTrail.
This exception is thrown when the specified S3 bucket does not exist.
The settings for the source S3 bucket.
Contains configuration information about the channel.
The request to CloudTrail to start logging Amazon Web Services API calls for an account.
Returns the objects or data listed below if successful.
Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.
Returns the objects or data listed below if successful.
A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, or channel.
The number of tags per trail, event data store, or channel has exceeded the permitted amount.
This exception is thrown when the request rate exceeds the limit.
The settings for a trail.
This exception is thrown when the specified trail already exists.
Information about a CloudTrail trail, including the trail's name, home Region, and Amazon Resource Name (ARN).
This exception is thrown when the trail with the given name is not found.
This exception is no longer in use.
This exception is thrown when the requested operation is not supported.
Specifies settings to update for the trail.
Returns the objects or data listed below if successful.