@Generated(value="software.amazon.awssdk:codegen") public interface CloudTrailClient extends SdkClient
builder()
method.
This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.
As an alternative to the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.
See the AWS CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AddTagsResponse |
addTags(AddTagsRequest addTagsRequest)
Adds one or more tags to a trail, up to a limit of 50.
|
default AddTagsResponse |
addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
Adds one or more tags to a trail, up to a limit of 50.
|
static CloudTrailClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudTrailClient . |
static CloudTrailClient |
create()
Create a
CloudTrailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateTrailResponse |
createTrail(Consumer<CreateTrailRequest.Builder> createTrailRequest)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
default CreateTrailResponse |
createTrail(CreateTrailRequest createTrailRequest)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
default DeleteTrailResponse |
deleteTrail(Consumer<DeleteTrailRequest.Builder> deleteTrailRequest)
Deletes a trail.
|
default DeleteTrailResponse |
deleteTrail(DeleteTrailRequest deleteTrailRequest)
Deletes a trail.
|
default DescribeTrailsResponse |
describeTrails()
Retrieves settings for the trail associated with the current region for your account.
|
default DescribeTrailsResponse |
describeTrails(Consumer<DescribeTrailsRequest.Builder> describeTrailsRequest)
Retrieves settings for the trail associated with the current region for your account.
|
default DescribeTrailsResponse |
describeTrails(DescribeTrailsRequest describeTrailsRequest)
Retrieves settings for the trail associated with the current region for your account.
|
default GetEventSelectorsResponse |
getEventSelectors(Consumer<GetEventSelectorsRequest.Builder> getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail.
|
default GetEventSelectorsResponse |
getEventSelectors(GetEventSelectorsRequest getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail.
|
default GetTrailStatusResponse |
getTrailStatus(Consumer<GetTrailStatusRequest.Builder> getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail.
|
default GetTrailStatusResponse |
getTrailStatus(GetTrailStatusRequest getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail.
|
default ListPublicKeysResponse |
listPublicKeys()
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListPublicKeysResponse |
listPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListPublicKeysResponse |
listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListTagsResponse |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists the tags for the trail in the current region.
|
default ListTagsResponse |
listTags(ListTagsRequest listTagsRequest)
Lists the tags for the trail in the current region.
|
default LookupEventsResponse |
lookupEvents()
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account.
|
default LookupEventsResponse |
lookupEvents(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account.
|
default LookupEventsResponse |
lookupEvents(LookupEventsRequest lookupEventsRequest)
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account.
|
default LookupEventsIterable |
lookupEventsPaginator()
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account.
|
default LookupEventsIterable |
lookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account.
|
default LookupEventsIterable |
lookupEventsPaginator(LookupEventsRequest lookupEventsRequest)
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account.
|
default PutEventSelectorsResponse |
putEventSelectors(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest)
Configures an event selector for your trail.
|
default PutEventSelectorsResponse |
putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest)
Configures an event selector for your trail.
|
default RemoveTagsResponse |
removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
Removes the specified tags from a trail.
|
default RemoveTagsResponse |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from a trail.
|
static ServiceMetadata |
serviceMetadata() |
default StartLoggingResponse |
startLogging(Consumer<StartLoggingRequest.Builder> startLoggingRequest)
Starts the recording of AWS API calls and log file delivery for a trail.
|
default StartLoggingResponse |
startLogging(StartLoggingRequest startLoggingRequest)
Starts the recording of AWS API calls and log file delivery for a trail.
|
default StopLoggingResponse |
stopLogging(Consumer<StopLoggingRequest.Builder> stopLoggingRequest)
Suspends the recording of AWS API calls and log file delivery for the specified trail.
|
default StopLoggingResponse |
stopLogging(StopLoggingRequest stopLoggingRequest)
Suspends the recording of AWS API calls and log file delivery for the specified trail.
|
default UpdateTrailResponse |
updateTrail(Consumer<UpdateTrailRequest.Builder> updateTrailRequest)
Updates the settings that specify delivery of log files.
|
default UpdateTrailResponse |
updateTrail(UpdateTrailRequest updateTrailRequest)
Updates the settings that specify delivery of log files.
|
serviceName
close
static final String SERVICE_NAME
static CloudTrailClient create()
CloudTrailClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CloudTrailClientBuilder builder()
CloudTrailClient
.default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, ResourceTypeNotSupportedException, TagsLimitExceededException, InvalidTrailNameException, InvalidTagParameterException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region).
addTagsRequest
- Specifies the tags to add to a trail.ResourceNotFoundException
- This exception is thrown when the specified resource is not found.CloudTrailArnInvalidException
- This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN
is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
ResourceTypeNotSupportedException
- This exception is thrown when the specified resource type is not supported by CloudTrail.TagsLimitExceededException
- The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidTagParameterException
- This exception is thrown when the key or value specified for the tag does not match the regular
expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$
.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, ResourceTypeNotSupportedException, TagsLimitExceededException, InvalidTrailNameException, InvalidTagParameterException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region).
This is a convenience which creates an instance of the AddTagsRequest.Builder
avoiding the need to create
one manually via AddTagsRequest.builder()
addTagsRequest
- A Consumer
that will call methods on AddTagsRequest.Builder
to create a request. Specifies
the tags to add to a trail.ResourceNotFoundException
- This exception is thrown when the specified resource is not found.CloudTrailArnInvalidException
- This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN
is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
ResourceTypeNotSupportedException
- This exception is thrown when the specified resource type is not supported by CloudTrail.TagsLimitExceededException
- The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidTagParameterException
- This exception is thrown when the key or value specified for the tag does not match the regular
expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$
.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateTrailResponse createTrail(CreateTrailRequest createTrailRequest) throws MaximumNumberOfTrailsExceededException, TrailAlreadyExistsException, S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, InvalidParameterCombinationException, KmsKeyNotFoundException, KmsKeyDisabledException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.
createTrailRequest
- Specifies the settings for each trail.MaximumNumberOfTrailsExceededException
- This exception is thrown when the maximum number of trails is reached.TrailAlreadyExistsException
- This exception is thrown when the specified trail already exists.S3BucketDoesNotExistException
- This exception is thrown when the specified S3 bucket does not exist.InsufficientS3BucketPolicyException
- This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientSnsTopicPolicyException
- This exception is thrown when the policy on the SNS topic is not sufficient.InsufficientEncryptionPolicyException
- This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.InvalidS3BucketNameException
- This exception is thrown when the provided S3 bucket name is not valid.InvalidS3PrefixException
- This exception is thrown when the provided S3 prefix is not valid.InvalidSnsTopicNameException
- This exception is thrown when the provided SNS topic name is not valid.InvalidKmsKeyIdException
- This exception is thrown when the KMS key ARN is invalid.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
TrailNotProvidedException
- This exception is deprecated.InvalidParameterCombinationException
- This exception is thrown when the combination of parameters provided is not valid.KmsKeyNotFoundException
- This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not
in the same region.KmsKeyDisabledException
- This exception is deprecated.KmsException
- This exception is thrown when there is an issue with the specified KMS key and the trail can’t be
updated.InvalidCloudWatchLogsLogGroupArnException
- This exception is thrown when the provided CloudWatch log group is not valid.InvalidCloudWatchLogsRoleArnException
- This exception is thrown when the provided role is not valid.CloudWatchLogsDeliveryUnavailableException
- Cannot set a CloudWatch Logs delivery for this region.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateTrailResponse createTrail(Consumer<CreateTrailRequest.Builder> createTrailRequest) throws MaximumNumberOfTrailsExceededException, TrailAlreadyExistsException, S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, InvalidParameterCombinationException, KmsKeyNotFoundException, KmsKeyDisabledException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.
This is a convenience which creates an instance of the CreateTrailRequest.Builder
avoiding the need to
create one manually via CreateTrailRequest.builder()
createTrailRequest
- A Consumer
that will call methods on CreateTrailRequest.Builder
to create a request.
Specifies the settings for each trail.MaximumNumberOfTrailsExceededException
- This exception is thrown when the maximum number of trails is reached.TrailAlreadyExistsException
- This exception is thrown when the specified trail already exists.S3BucketDoesNotExistException
- This exception is thrown when the specified S3 bucket does not exist.InsufficientS3BucketPolicyException
- This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientSnsTopicPolicyException
- This exception is thrown when the policy on the SNS topic is not sufficient.InsufficientEncryptionPolicyException
- This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.InvalidS3BucketNameException
- This exception is thrown when the provided S3 bucket name is not valid.InvalidS3PrefixException
- This exception is thrown when the provided S3 prefix is not valid.InvalidSnsTopicNameException
- This exception is thrown when the provided SNS topic name is not valid.InvalidKmsKeyIdException
- This exception is thrown when the KMS key ARN is invalid.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
TrailNotProvidedException
- This exception is deprecated.InvalidParameterCombinationException
- This exception is thrown when the combination of parameters provided is not valid.KmsKeyNotFoundException
- This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not
in the same region.KmsKeyDisabledException
- This exception is deprecated.KmsException
- This exception is thrown when there is an issue with the specified KMS key and the trail can’t be
updated.InvalidCloudWatchLogsLogGroupArnException
- This exception is thrown when the provided CloudWatch log group is not valid.InvalidCloudWatchLogsRoleArnException
- This exception is thrown when the provided role is not valid.CloudWatchLogsDeliveryUnavailableException
- Cannot set a CloudWatch Logs delivery for this region.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTrailResponse deleteTrail(DeleteTrailRequest deleteTrailRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, AwsServiceException, SdkClientException, CloudTrailException
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.
deleteTrailRequest
- The request that specifies the name of a trail to delete.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException
- This exception is thrown when an operation is called on a trail from a region other than the region in
which the trail was created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTrailResponse deleteTrail(Consumer<DeleteTrailRequest.Builder> deleteTrailRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the DeleteTrailRequest.Builder
avoiding the need to
create one manually via DeleteTrailRequest.builder()
deleteTrailRequest
- A Consumer
that will call methods on DeleteTrailRequest.Builder
to create a request. The
request that specifies the name of a trail to delete.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException
- This exception is thrown when an operation is called on a trail from a region other than the region in
which the trail was created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrailsResponse describeTrails() throws UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Retrieves settings for the trail associated with the current region for your account.
UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeTrails(DescribeTrailsRequest)
,
AWS API
Documentationdefault DescribeTrailsResponse describeTrails(DescribeTrailsRequest describeTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Retrieves settings for the trail associated with the current region for your account.
describeTrailsRequest
- Returns information about the trail.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrailsResponse describeTrails(Consumer<DescribeTrailsRequest.Builder> describeTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Retrieves settings for the trail associated with the current region for your account.
This is a convenience which creates an instance of the DescribeTrailsRequest.Builder
avoiding the need to
create one manually via DescribeTrailsRequest.builder()
describeTrailsRequest
- A Consumer
that will call methods on DescribeTrailsRequest.Builder
to create a request.
Returns information about the trail.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetEventSelectorsResponse getEventSelectors(GetEventSelectorsRequest getEventSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
The S3 objects that you are logging for data events.
If your event selector includes management events.
If your event selector includes read-only events, write-only events, or all.
For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
getEventSelectorsRequest
- TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetEventSelectorsResponse getEventSelectors(Consumer<GetEventSelectorsRequest.Builder> getEventSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
The S3 objects that you are logging for data events.
If your event selector includes management events.
If your event selector includes read-only events, write-only events, or all.
For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
This is a convenience which creates an instance of the GetEventSelectorsRequest.Builder
avoiding the need
to create one manually via GetEventSelectorsRequest.builder()
getEventSelectorsRequest
- A Consumer
that will call methods on GetEventSelectorsRequest.Builder
to create a request.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTrailStatusResponse getTrailStatus(GetTrailStatusRequest getTrailStatusRequest) throws TrailNotFoundException, InvalidTrailNameException, AwsServiceException, SdkClientException, CloudTrailException
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.
getTrailStatusRequest
- The name of a trail about which you want the current status.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTrailStatusResponse getTrailStatus(Consumer<GetTrailStatusRequest.Builder> getTrailStatusRequest) throws TrailNotFoundException, InvalidTrailNameException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the GetTrailStatusRequest.Builder
avoiding the need to
create one manually via GetTrailStatusRequest.builder()
getTrailStatusRequest
- A Consumer
that will call methods on GetTrailStatusRequest.Builder
to create a request.
The name of a trail about which you want the current status.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPublicKeysResponse listPublicKeys() throws InvalidTimeRangeException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailException
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.
InvalidTimeRangeException
- Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time
range is outside the range of possible values.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.InvalidTokenException
- Reserved for future use.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listPublicKeys(ListPublicKeysRequest)
,
AWS API
Documentationdefault ListPublicKeysResponse listPublicKeys(ListPublicKeysRequest listPublicKeysRequest) throws InvalidTimeRangeException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailException
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.
listPublicKeysRequest
- Requests the public keys for a specified time range.InvalidTimeRangeException
- Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time
range is outside the range of possible values.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.InvalidTokenException
- Reserved for future use.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPublicKeysResponse listPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest) throws InvalidTimeRangeException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailException
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.
This is a convenience which creates an instance of the ListPublicKeysRequest.Builder
avoiding the need to
create one manually via ListPublicKeysRequest.builder()
listPublicKeysRequest
- A Consumer
that will call methods on ListPublicKeysRequest.Builder
to create a request.
Requests the public keys for a specified time range.InvalidTimeRangeException
- Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time
range is outside the range of possible values.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.InvalidTokenException
- Reserved for future use.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailException
Lists the tags for the trail in the current region.
listTagsRequest
- Specifies a list of trail tags to return.ResourceNotFoundException
- This exception is thrown when the specified resource is not found.CloudTrailArnInvalidException
- This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN
is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
ResourceTypeNotSupportedException
- This exception is thrown when the specified resource type is not supported by CloudTrail.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.InvalidTokenException
- Reserved for future use.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailException
Lists the tags for the trail in the current region.
This is a convenience which creates an instance of the ListTagsRequest.Builder
avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest
- A Consumer
that will call methods on ListTagsRequest.Builder
to create a request.
Specifies a list of trail tags to return.ResourceNotFoundException
- This exception is thrown when the specified resource is not found.CloudTrailArnInvalidException
- This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN
is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
ResourceTypeNotSupportedException
- This exception is thrown when the specified resource type is not supported by CloudTrail.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.InvalidTokenException
- Reserved for future use.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default LookupEventsResponse lookupEvents() throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudTrailException
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:
Event ID
Event name
Event source
Resource name
Resource type
User name
All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.
Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.
InvalidLookupAttributesException
- Occurs when an invalid lookup attribute is specified.InvalidTimeRangeException
- Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time
range is outside the range of possible values.InvalidMaxResultsException
- This exception is thrown if the limit specified is invalid.InvalidNextTokenException
- Invalid token or token that was previously used in a request with different parameters. This exception is
thrown if the token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
lookupEvents(LookupEventsRequest)
,
AWS API
Documentationdefault LookupEventsResponse lookupEvents(LookupEventsRequest lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudTrailException
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:
Event ID
Event name
Event source
Resource name
Resource type
User name
All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.
Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.
lookupEventsRequest
- Contains a request for LookupEvents.InvalidLookupAttributesException
- Occurs when an invalid lookup attribute is specified.InvalidTimeRangeException
- Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time
range is outside the range of possible values.InvalidMaxResultsException
- This exception is thrown if the limit specified is invalid.InvalidNextTokenException
- Invalid token or token that was previously used in a request with different parameters. This exception is
thrown if the token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default LookupEventsResponse lookupEvents(Consumer<LookupEventsRequest.Builder> lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudTrailException
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:
Event ID
Event name
Event source
Resource name
Resource type
User name
All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.
Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.
This is a convenience which creates an instance of the LookupEventsRequest.Builder
avoiding the need to
create one manually via LookupEventsRequest.builder()
lookupEventsRequest
- A Consumer
that will call methods on LookupEventsRequest.Builder
to create a request.
Contains a request for LookupEvents.InvalidLookupAttributesException
- Occurs when an invalid lookup attribute is specified.InvalidTimeRangeException
- Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time
range is outside the range of possible values.InvalidMaxResultsException
- This exception is thrown if the limit specified is invalid.InvalidNextTokenException
- Invalid token or token that was previously used in a request with different parameters. This exception is
thrown if the token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default LookupEventsIterable lookupEventsPaginator() throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudTrailException
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:
Event ID
Event name
Event source
Resource name
Resource type
User name
All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.
Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.
This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request); for (software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation.
InvalidLookupAttributesException
- Occurs when an invalid lookup attribute is specified.InvalidTimeRangeException
- Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time
range is outside the range of possible values.InvalidMaxResultsException
- This exception is thrown if the limit specified is invalid.InvalidNextTokenException
- Invalid token or token that was previously used in a request with different parameters. This exception is
thrown if the token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
lookupEventsPaginator(LookupEventsRequest)
,
AWS API
Documentationdefault LookupEventsIterable lookupEventsPaginator(LookupEventsRequest lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudTrailException
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:
Event ID
Event name
Event source
Resource name
Resource type
User name
All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.
Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.
This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request); for (software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation.
lookupEventsRequest
- Contains a request for LookupEvents.InvalidLookupAttributesException
- Occurs when an invalid lookup attribute is specified.InvalidTimeRangeException
- Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time
range is outside the range of possible values.InvalidMaxResultsException
- This exception is thrown if the limit specified is invalid.InvalidNextTokenException
- Invalid token or token that was previously used in a request with different parameters. This exception is
thrown if the token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default LookupEventsIterable lookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudTrailException
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:
Event ID
Event name
Event source
Resource name
Resource type
User name
All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.
Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.
This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request); for (software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation.
This is a convenience which creates an instance of the LookupEventsRequest.Builder
avoiding the need to
create one manually via LookupEventsRequest.builder()
lookupEventsRequest
- A Consumer
that will call methods on LookupEventsRequest.Builder
to create a request.
Contains a request for LookupEvents.InvalidLookupAttributesException
- Occurs when an invalid lookup attribute is specified.InvalidTimeRangeException
- Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time
range is outside the range of possible values.InvalidMaxResultsException
- This exception is thrown if the limit specified is invalid.InvalidNextTokenException
- Invalid token or token that was previously used in a request with different parameters. This exception is
thrown if the token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutEventSelectorsResponse putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, InvalidEventSelectorsException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Configures an event selector for your trail. Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
You create an event selector for a trail and specify that you want write-only events.
The EC2 GetConsoleOutput
and RunInstances
API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances
is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput
is a read-only event but it doesn't match your event selector. The trail
doesn't log the event.
The PutEventSelectors
operation must be called from the region in which the trail was created;
otherwise, an InvalidHomeRegionException
is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
putEventSelectorsRequest
- TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException
- This exception is thrown when an operation is called on a trail from a region other than the region in
which the trail was created.InvalidEventSelectorsException
- This exception is thrown when the PutEventSelectors
operation is called with an invalid
number of event selectors, data resources, or an invalid value for a parameter:
Specify a valid number of event selectors (1 to 5) for a trail.
Specify a valid number of data resources (1 to 250) for an event selector.
Specify a valid value for a parameter. For example, specifying the ReadWriteType
parameter
with a value of read-only
is invalid.
UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutEventSelectorsResponse putEventSelectors(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, InvalidEventSelectorsException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Configures an event selector for your trail. Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
You create an event selector for a trail and specify that you want write-only events.
The EC2 GetConsoleOutput
and RunInstances
API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances
is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput
is a read-only event but it doesn't match your event selector. The trail
doesn't log the event.
The PutEventSelectors
operation must be called from the region in which the trail was created;
otherwise, an InvalidHomeRegionException
is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
This is a convenience which creates an instance of the PutEventSelectorsRequest.Builder
avoiding the need
to create one manually via PutEventSelectorsRequest.builder()
putEventSelectorsRequest
- A Consumer
that will call methods on PutEventSelectorsRequest.Builder
to create a request.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException
- This exception is thrown when an operation is called on a trail from a region other than the region in
which the trail was created.InvalidEventSelectorsException
- This exception is thrown when the PutEventSelectors
operation is called with an invalid
number of event selectors, data resources, or an invalid value for a parameter:
Specify a valid number of event selectors (1 to 5) for a trail.
Specify a valid number of data resources (1 to 250) for an event selector.
Specify a valid value for a parameter. For example, specifying the ReadWriteType
parameter
with a value of read-only
is invalid.
UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InvalidTagParameterException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Removes the specified tags from a trail.
removeTagsRequest
- Specifies the tags to remove from a trail.ResourceNotFoundException
- This exception is thrown when the specified resource is not found.CloudTrailArnInvalidException
- This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN
is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
ResourceTypeNotSupportedException
- This exception is thrown when the specified resource type is not supported by CloudTrail.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidTagParameterException
- This exception is thrown when the key or value specified for the tag does not match the regular
expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$
.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InvalidTagParameterException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Removes the specified tags from a trail.
This is a convenience which creates an instance of the RemoveTagsRequest.Builder
avoiding the need to
create one manually via RemoveTagsRequest.builder()
removeTagsRequest
- A Consumer
that will call methods on RemoveTagsRequest.Builder
to create a request.
Specifies the tags to remove from a trail.ResourceNotFoundException
- This exception is thrown when the specified resource is not found.CloudTrailArnInvalidException
- This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN
is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
ResourceTypeNotSupportedException
- This exception is thrown when the specified resource type is not supported by CloudTrail.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidTagParameterException
- This exception is thrown when the key or value specified for the tag does not match the regular
expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$
.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartLoggingResponse startLogging(StartLoggingRequest startLoggingRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, AwsServiceException, SdkClientException, CloudTrailException
Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
startLoggingRequest
- The request to CloudTrail to start logging AWS API calls for an account.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException
- This exception is thrown when an operation is called on a trail from a region other than the region in
which the trail was created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartLoggingResponse startLogging(Consumer<StartLoggingRequest.Builder> startLoggingRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, AwsServiceException, SdkClientException, CloudTrailException
Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
This is a convenience which creates an instance of the StartLoggingRequest.Builder
avoiding the need to
create one manually via StartLoggingRequest.builder()
startLoggingRequest
- A Consumer
that will call methods on StartLoggingRequest.Builder
to create a request. The
request to CloudTrail to start logging AWS API calls for an account.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException
- This exception is thrown when an operation is called on a trail from a region other than the region in
which the trail was created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopLoggingResponse stopLogging(StopLoggingRequest stopLoggingRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, AwsServiceException, SdkClientException, CloudTrailException
Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances,
there is no need to use this action. You can update a trail without stopping it first. This action is the only
way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which
the trail was created, or an InvalidHomeRegionException
will occur. This operation cannot be called
on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.
stopLoggingRequest
- Passes the request to CloudTrail to stop logging AWS API calls for the specified account.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException
- This exception is thrown when an operation is called on a trail from a region other than the region in
which the trail was created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopLoggingResponse stopLogging(Consumer<StopLoggingRequest.Builder> stopLoggingRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, AwsServiceException, SdkClientException, CloudTrailException
Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances,
there is no need to use this action. You can update a trail without stopping it first. This action is the only
way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which
the trail was created, or an InvalidHomeRegionException
will occur. This operation cannot be called
on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.
This is a convenience which creates an instance of the StopLoggingRequest.Builder
avoiding the need to
create one manually via StopLoggingRequest.builder()
stopLoggingRequest
- A Consumer
that will call methods on StopLoggingRequest.Builder
to create a request.
Passes the request to CloudTrail to stop logging AWS API calls for the specified account.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
InvalidHomeRegionException
- This exception is thrown when an operation is called on a trail from a region other than the region in
which the trail was created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateTrailResponse updateTrail(UpdateTrailRequest updateTrailRequest) throws S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, TrailNotFoundException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, InvalidParameterCombinationException, InvalidHomeRegionException, KmsKeyNotFoundException, KmsKeyDisabledException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the
CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has
previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail
must be called from the region in which the trail was created; otherwise, an
InvalidHomeRegionException
is thrown.
updateTrailRequest
- Specifies settings to update for the trail.S3BucketDoesNotExistException
- This exception is thrown when the specified S3 bucket does not exist.InsufficientS3BucketPolicyException
- This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientSnsTopicPolicyException
- This exception is thrown when the policy on the SNS topic is not sufficient.InsufficientEncryptionPolicyException
- This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidS3BucketNameException
- This exception is thrown when the provided S3 bucket name is not valid.InvalidS3PrefixException
- This exception is thrown when the provided S3 prefix is not valid.InvalidSnsTopicNameException
- This exception is thrown when the provided SNS topic name is not valid.InvalidKmsKeyIdException
- This exception is thrown when the KMS key ARN is invalid.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
TrailNotProvidedException
- This exception is deprecated.InvalidParameterCombinationException
- This exception is thrown when the combination of parameters provided is not valid.InvalidHomeRegionException
- This exception is thrown when an operation is called on a trail from a region other than the region in
which the trail was created.KmsKeyNotFoundException
- This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not
in the same region.KmsKeyDisabledException
- This exception is deprecated.KmsException
- This exception is thrown when there is an issue with the specified KMS key and the trail can’t be
updated.InvalidCloudWatchLogsLogGroupArnException
- This exception is thrown when the provided CloudWatch log group is not valid.InvalidCloudWatchLogsRoleArnException
- This exception is thrown when the provided role is not valid.CloudWatchLogsDeliveryUnavailableException
- Cannot set a CloudWatch Logs delivery for this region.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateTrailResponse updateTrail(Consumer<UpdateTrailRequest.Builder> updateTrailRequest) throws S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, TrailNotFoundException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, InvalidParameterCombinationException, InvalidHomeRegionException, KmsKeyNotFoundException, KmsKeyDisabledException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the
CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has
previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail
must be called from the region in which the trail was created; otherwise, an
InvalidHomeRegionException
is thrown.
This is a convenience which creates an instance of the UpdateTrailRequest.Builder
avoiding the need to
create one manually via UpdateTrailRequest.builder()
updateTrailRequest
- A Consumer
that will call methods on UpdateTrailRequest.Builder
to create a request.
Specifies settings to update for the trail.S3BucketDoesNotExistException
- This exception is thrown when the specified S3 bucket does not exist.InsufficientS3BucketPolicyException
- This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientSnsTopicPolicyException
- This exception is thrown when the policy on the SNS topic is not sufficient.InsufficientEncryptionPolicyException
- This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.TrailNotFoundException
- This exception is thrown when the trail with the given name is not found.InvalidS3BucketNameException
- This exception is thrown when the provided S3 bucket name is not valid.InvalidS3PrefixException
- This exception is thrown when the provided S3 prefix is not valid.InvalidSnsTopicNameException
- This exception is thrown when the provided SNS topic name is not valid.InvalidKmsKeyIdException
- This exception is thrown when the KMS key ARN is invalid.InvalidTrailNameException
- This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
my--namespace
are invalid.
Not be in IP address format (for example, 192.168.5.4)
TrailNotProvidedException
- This exception is deprecated.InvalidParameterCombinationException
- This exception is thrown when the combination of parameters provided is not valid.InvalidHomeRegionException
- This exception is thrown when an operation is called on a trail from a region other than the region in
which the trail was created.KmsKeyNotFoundException
- This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not
in the same region.KmsKeyDisabledException
- This exception is deprecated.KmsException
- This exception is thrown when there is an issue with the specified KMS key and the trail can’t be
updated.InvalidCloudWatchLogsLogGroupArnException
- This exception is thrown when the provided CloudWatch log group is not valid.InvalidCloudWatchLogsRoleArnException
- This exception is thrown when the provided role is not valid.CloudWatchLogsDeliveryUnavailableException
- Cannot set a CloudWatch Logs delivery for this region.UnsupportedOperationException
- This exception is thrown when the requested operation is not supported.OperationNotPermittedException
- This exception is thrown when the requested operation is not permitted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.