@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_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
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 one or more trails associated with the current region for your account.
|
default DescribeTrailsResponse |
describeTrails(Consumer<DescribeTrailsRequest.Builder> describeTrailsRequest)
Retrieves settings for one or more trails associated with the current region for your account.
|
default DescribeTrailsResponse |
describeTrails(DescribeTrailsRequest describeTrailsRequest)
Retrieves settings for one or more trails 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 GetInsightSelectorsResponse |
getInsightSelectors(Consumer<GetInsightSelectorsRequest.Builder> getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
|
default GetInsightSelectorsResponse |
getInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
|
default GetTrailResponse |
getTrail(Consumer<GetTrailRequest.Builder> getTrailRequest)
Returns settings information for a specified trail.
|
default GetTrailResponse |
getTrail(GetTrailRequest getTrailRequest)
Returns settings information for a specified 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 ListPublicKeysIterable |
listPublicKeysPaginator()
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListPublicKeysIterable |
listPublicKeysPaginator(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListPublicKeysIterable |
listPublicKeysPaginator(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 ListTagsIterable |
listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists the tags for the trail in the current region.
|
default ListTagsIterable |
listTagsPaginator(ListTagsRequest listTagsRequest)
Lists the tags for the trail in the current region.
|
default ListTrailsResponse |
listTrails(Consumer<ListTrailsRequest.Builder> listTrailsRequest)
Lists trails that are in the current account.
|
default ListTrailsResponse |
listTrails(ListTrailsRequest listTrailsRequest)
Lists trails that are in the current account.
|
default ListTrailsIterable |
listTrailsPaginator(Consumer<ListTrailsRequest.Builder> listTrailsRequest)
Lists trails that are in the current account.
|
default ListTrailsIterable |
listTrailsPaginator(ListTrailsRequest listTrailsRequest)
Lists trails that are in the current account.
|
default LookupEventsResponse |
lookupEvents()
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsResponse |
lookupEvents(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsResponse |
lookupEvents(LookupEventsRequest lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsIterable |
lookupEventsPaginator()
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsIterable |
lookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsIterable |
lookupEventsPaginator(LookupEventsRequest lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default PutEventSelectorsResponse |
putEventSelectors(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest)
Configures an event selector or advanced event selectors for your trail.
|
default PutEventSelectorsResponse |
putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest)
Configures an event selector or advanced event selectors for your trail.
|
default PutInsightSelectorsResponse |
putInsightSelectors(Consumer<PutInsightSelectorsRequest.Builder> putInsightSelectorsRequest)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail.
|
default PutInsightSelectorsResponse |
putInsightSelectors(PutInsightSelectorsRequest putInsightSelectorsRequest)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing 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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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, NotOrganizationMasterAccountException, AwsServiceException, SdkClientException, CloudTrailException
Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all AWS Regions only from the Region in which the trail was created (also known as 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-2: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 specified tag key or values are not valid. It can also occur if there
are duplicate tags or too many tags on the resource.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, ResourceTypeNotSupportedException, TagsLimitExceededException, InvalidTrailNameException, InvalidTagParameterException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, AwsServiceException, SdkClientException, CloudTrailException
Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all AWS Regions only from the Region in which the trail was created (also known as 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-2: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 specified tag key or values are not valid. It can also occur if there
are duplicate tags or too many tags on the resource.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault CreateTrailResponse createTrail(CreateTrailRequest createTrailRequest) throws MaximumNumberOfTrailsExceededException, TrailAlreadyExistsException, S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, InvalidParameterCombinationException, KmsKeyNotFoundException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, InvalidTagParameterException, UnsupportedOperationException, OperationNotPermittedException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, NotOrganizationMasterAccountException, OrganizationsNotInUseException, OrganizationNotInAllFeaturesModeException, CloudTrailInvalidClientTokenIdException, AwsServiceException, SdkClientException, CloudTrailException
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
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 no longer in use.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, when the S3 bucket and the KMS key are not in
the same region, or when the KMS key associated with the SNS topic either does not exist or is not in the
same region.KmsException - This exception is thrown when there is an issue with the specified KMS key and the trail 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.InvalidTagParameterException - This exception is thrown when the specified tag key or values are not valid. It can also occur if there
are duplicate tags or too many tags on the resource.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between AWS CloudTrail and AWS
Organizations. For more information, see Enabling
Trusted Access with Other AWS Services and Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.OrganizationsNotInUseException - This exception is thrown when the request is made from an AWS account that is not a member of an
organization. To make this request, sign in using the credentials of an account that belongs to an
organization.OrganizationNotInAllFeaturesModeException - This exception is thrown when AWS Organizations is not configured to support all features. All features
must be enabled in AWS Organization to support creating an organization trail. For more information, see
Prepare For Creating a Trail For Your Organization.CloudTrailInvalidClientTokenIdException - This exception is thrown when a call results in the InvalidClientTokenId error code. This
can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is
in a suspended AWS account.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.AwsServiceExceptiondefault CreateTrailResponse createTrail(Consumer<CreateTrailRequest.Builder> createTrailRequest) throws MaximumNumberOfTrailsExceededException, TrailAlreadyExistsException, S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, InvalidParameterCombinationException, KmsKeyNotFoundException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, InvalidTagParameterException, UnsupportedOperationException, OperationNotPermittedException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, NotOrganizationMasterAccountException, OrganizationsNotInUseException, OrganizationNotInAllFeaturesModeException, CloudTrailInvalidClientTokenIdException, AwsServiceException, SdkClientException, CloudTrailException
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
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 no longer in use.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, when the S3 bucket and the KMS key are not in
the same region, or when the KMS key associated with the SNS topic either does not exist or is not in the
same region.KmsException - This exception is thrown when there is an issue with the specified KMS key and the trail 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.InvalidTagParameterException - This exception is thrown when the specified tag key or values are not valid. It can also occur if there
are duplicate tags or too many tags on the resource.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between AWS CloudTrail and AWS
Organizations. For more information, see Enabling
Trusted Access with Other AWS Services and Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.OrganizationsNotInUseException - This exception is thrown when the request is made from an AWS account that is not a member of an
organization. To make this request, sign in using the credentials of an account that belongs to an
organization.OrganizationNotInAllFeaturesModeException - This exception is thrown when AWS Organizations is not configured to support all features. All features
must be enabled in AWS Organization to support creating an organization trail. For more information, see
Prepare For Creating a Trail For Your Organization.CloudTrailInvalidClientTokenIdException - This exception is thrown when a call results in the InvalidClientTokenId error code. This
can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is
in a suspended AWS account.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.AwsServiceExceptiondefault DeleteTrailResponse deleteTrail(DeleteTrailRequest deleteTrailRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, InsufficientDependencyServiceAccessPermissionException, ConflictException, 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.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a trail before CloudTrail has time to fully load the trail. If this
exception occurs, wait a few minutes, and then try the operation again.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.AwsServiceExceptiondefault DeleteTrailResponse deleteTrail(Consumer<DeleteTrailRequest.Builder> deleteTrailRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, InsufficientDependencyServiceAccessPermissionException, ConflictException, 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.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a trail before CloudTrail has time to fully load the trail. If this
exception occurs, wait a few minutes, and then try the operation again.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.AwsServiceExceptiondefault DescribeTrailsResponse describeTrails() throws UnsupportedOperationException, OperationNotPermittedException, InvalidTrailNameException, AwsServiceException, SdkClientException, CloudTrailException
Retrieves settings for one or more trails 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.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.AwsServiceExceptiondescribeTrails(DescribeTrailsRequest),
AWS API
Documentationdefault DescribeTrailsResponse describeTrails(DescribeTrailsRequest describeTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, InvalidTrailNameException, AwsServiceException, SdkClientException, CloudTrailException
Retrieves settings for one or more trails 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.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.AwsServiceExceptiondefault DescribeTrailsResponse describeTrails(Consumer<DescribeTrailsRequest.Builder> describeTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, InvalidTrailNameException, AwsServiceException, SdkClientException, CloudTrailException
Retrieves settings for one or more trails 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.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.AwsServiceExceptiondefault 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:
If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events.
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.AwsServiceExceptiondefault 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:
If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events.
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.AwsServiceExceptiondefault GetInsightSelectorsResponse getInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, InsightNotEnabledException, AwsServiceException, SdkClientException, CloudTrailException
Describes the settings for the Insights event selectors that you configured for your trail.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it
is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException
For more information, see Logging CloudTrail Insights Events for Trails in the AWS CloudTrail User Guide.
getInsightSelectorsRequest - 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.InsightNotEnabledException - If you run GetInsightSelectors on a trail that does not have Insights events enabled, the
operation throws the exception InsightNotEnabledException.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.AwsServiceExceptiondefault GetInsightSelectorsResponse getInsightSelectors(Consumer<GetInsightSelectorsRequest.Builder> getInsightSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, InsightNotEnabledException, AwsServiceException, SdkClientException, CloudTrailException
Describes the settings for the Insights event selectors that you configured for your trail.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it
is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException
For more information, see Logging CloudTrail Insights Events for Trails in the AWS CloudTrail User Guide.
This is a convenience which creates an instance of the GetInsightSelectorsRequest.Builder avoiding the
need to create one manually via GetInsightSelectorsRequest.builder()
getInsightSelectorsRequest - A Consumer that will call methods on GetInsightSelectorsRequest.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.InsightNotEnabledException - If you run GetInsightSelectors on a trail that does not have Insights events enabled, the
operation throws the exception InsightNotEnabledException.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.AwsServiceExceptiondefault GetTrailResponse getTrail(GetTrailRequest getTrailRequest) throws TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Returns settings information for a specified trail.
getTrailRequest - 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.AwsServiceExceptiondefault GetTrailResponse getTrail(Consumer<GetTrailRequest.Builder> getTrailRequest) throws TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Returns settings information for a specified trail.
This is a convenience which creates an instance of the GetTrailRequest.Builder avoiding the need to
create one manually via GetTrailRequest.builder()
getTrailRequest - A Consumer that will call methods on GetTrailRequest.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.AwsServiceExceptiondefault GetTrailStatusResponse getTrailStatus(GetTrailStatusRequest getTrailStatusRequest) throws TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, 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)
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.AwsServiceExceptiondefault GetTrailStatusResponse getTrailStatus(Consumer<GetTrailStatusRequest.Builder> getTrailStatusRequest) throws TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, 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)
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.AwsServiceExceptiondefault 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.AwsServiceExceptionlistPublicKeys(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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault ListPublicKeysIterable listPublicKeysPaginator() 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 variant of
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) 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.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client
.listPublicKeysPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.
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.AwsServiceExceptionlistPublicKeysPaginator(ListPublicKeysRequest),
AWS API
Documentationdefault ListPublicKeysIterable listPublicKeysPaginator(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.
This is a variant of
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) 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.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client
.listPublicKeysPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.
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.AwsServiceExceptiondefault ListPublicKeysIterable listPublicKeysPaginator(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 variant of
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) 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.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client
.listPublicKeysPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.
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.AwsServiceExceptiondefault 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-2: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.AwsServiceExceptiondefault 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-2: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.AwsServiceExceptiondefault ListTagsIterable listTagsPaginator(ListTagsRequest 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 variant of listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest)
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.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest) operation.
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-2: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.AwsServiceExceptiondefault ListTagsIterable listTagsPaginator(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 variant of listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest)
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.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest) operation.
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-2: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.AwsServiceExceptiondefault ListTrailsResponse listTrails(ListTrailsRequest listTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Lists trails that are in the current account.
listTrailsRequest - 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.AwsServiceExceptiondefault ListTrailsResponse listTrails(Consumer<ListTrailsRequest.Builder> listTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Lists trails that are in the current account.
This is a convenience which creates an instance of the ListTrailsRequest.Builder avoiding the need to
create one manually via ListTrailsRequest.builder()
listTrailsRequest - A Consumer that will call methods on ListTrailsRequest.Builder to create a request.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.AwsServiceExceptiondefault ListTrailsIterable listTrailsPaginator(ListTrailsRequest listTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Lists trails that are in the current account.
This is a variant of listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest)
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.ListTrailsIterable responses = client.listTrailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListTrailsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest) operation.
listTrailsRequest - 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.AwsServiceExceptiondefault ListTrailsIterable listTrailsPaginator(Consumer<ListTrailsRequest.Builder> listTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Lists trails that are in the current account.
This is a variant of listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest)
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.ListTrailsIterable responses = client.listTrailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListTrailsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest) operation.
This is a convenience which creates an instance of the ListTrailsRequest.Builder avoiding the need to
create one manually via ListTrailsRequest.builder()
listTrailsRequest - A Consumer that will call methods on ListTrailsRequest.Builder to create a request.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.AwsServiceExceptiondefault LookupEventsResponse lookupEvents() throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:
AWS access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
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.InvalidEventCategoryException - Occurs if an event category that is not valid is specified as a value of EventCategory.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.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.AwsServiceExceptionlookupEvents(LookupEventsRequest),
AWS API
Documentationdefault LookupEventsResponse lookupEvents(LookupEventsRequest lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:
AWS access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
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.InvalidEventCategoryException - Occurs if an event category that is not valid is specified as a value of EventCategory.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.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.AwsServiceExceptiondefault LookupEventsResponse lookupEvents(Consumer<LookupEventsRequest.Builder> lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:
AWS access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
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.InvalidEventCategoryException - Occurs if an event category that is not valid is specified as a value of EventCategory.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.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.AwsServiceExceptiondefault LookupEventsIterable lookupEventsPaginator() throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:
AWS access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.InvalidEventCategoryException - Occurs if an event category that is not valid is specified as a value of EventCategory.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.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.AwsServiceExceptionlookupEventsPaginator(LookupEventsRequest),
AWS API
Documentationdefault LookupEventsIterable lookupEventsPaginator(LookupEventsRequest lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:
AWS access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.InvalidEventCategoryException - Occurs if an event category that is not valid is specified as a value of EventCategory.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.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.AwsServiceExceptiondefault LookupEventsIterable lookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:
AWS access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.InvalidEventCategoryException - Occurs if an event category that is not valid is specified as a value of EventCategory.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.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.AwsServiceExceptiondefault PutEventSelectorsResponse putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, InvalidEventSelectorsException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
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 that doesn't match your event selector. The trail doesn't
log the event.
The PutEventSelectors operation must be called from the region in which the trail was created;
otherwise, an InvalidHomeRegionException exception is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging data and management events for trails and Quotas in AWS CloudTrail in the AWS CloudTrail User Guide.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500
values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or
EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any
existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging
data 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 a number of
event selectors, advanced event selectors, or data resources that is not valid. The combination of event
selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event
selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in
all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources
can be distributed across event selectors, but the overall total cannot exceed 250.
You can:
Specify a valid number of event selectors (1 to 5) for a trail.
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter
with a value of read-only is 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.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault PutEventSelectorsResponse putEventSelectors(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, InvalidEventSelectorsException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
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 that doesn't match your event selector. The trail doesn't
log the event.
The PutEventSelectors operation must be called from the region in which the trail was created;
otherwise, an InvalidHomeRegionException exception is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging data and management events for trails and Quotas in AWS CloudTrail in the AWS CloudTrail User Guide.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500
values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or
EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any
existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging
data 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 a number of
event selectors, advanced event selectors, or data resources that is not valid. The combination of event
selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event
selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in
all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources
can be distributed across event selectors, but the overall total cannot exceed 250.
You can:
Specify a valid number of event selectors (1 to 5) for a trail.
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter
with a value of read-only is 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.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault PutInsightSelectorsResponse putInsightSelectors(PutInsightSelectorsRequest putInsightSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, InvalidInsightSelectorsException, InsufficientS3BucketPolicyException, InsufficientEncryptionPolicyException, S3BucketDoesNotExistException, KmsException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, AwsServiceException, SdkClientException, CloudTrailException
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an
empty list of insight types. In this release, only ApiCallRateInsight is supported as an Insights
selector.
putInsightSelectorsRequest - 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.InvalidInsightSelectorsException - The formatting or syntax of the InsightSelectors JSON statement in your
PutInsightSelectors or GetInsightSelectors request is not valid, or the
specified insight type in the InsightSelectors statement is not a valid insight type.InsufficientS3BucketPolicyException - This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.S3BucketDoesNotExistException - This exception is thrown when the specified S3 bucket does not exist.KmsException - This exception is thrown when there is an issue with the specified KMS key and the trail can’t be
updated.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault PutInsightSelectorsResponse putInsightSelectors(Consumer<PutInsightSelectorsRequest.Builder> putInsightSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, InvalidInsightSelectorsException, InsufficientS3BucketPolicyException, InsufficientEncryptionPolicyException, S3BucketDoesNotExistException, KmsException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, AwsServiceException, SdkClientException, CloudTrailException
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an
empty list of insight types. In this release, only ApiCallRateInsight is supported as an Insights
selector.
This is a convenience which creates an instance of the PutInsightSelectorsRequest.Builder avoiding the
need to create one manually via PutInsightSelectorsRequest.builder()
putInsightSelectorsRequest - A Consumer that will call methods on PutInsightSelectorsRequest.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.InvalidInsightSelectorsException - The formatting or syntax of the InsightSelectors JSON statement in your
PutInsightSelectors or GetInsightSelectors request is not valid, or the
specified insight type in the InsightSelectors statement is not a valid insight type.InsufficientS3BucketPolicyException - This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.S3BucketDoesNotExistException - This exception is thrown when the specified S3 bucket does not exist.KmsException - This exception is thrown when there is an issue with the specified KMS key and the trail can’t be
updated.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InvalidTagParameterException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, 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-2: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 specified tag key or values are not valid. It can also occur if there
are duplicate tags or too many tags on the resource.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InvalidTagParameterException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, 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-2: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 specified tag key or values are not valid. It can also occur if there
are duplicate tags or too many tags on the resource.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault StartLoggingResponse startLogging(StartLoggingRequest startLoggingRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, InsufficientDependencyServiceAccessPermissionException, 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.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault StartLoggingResponse startLogging(Consumer<StartLoggingRequest.Builder> startLoggingRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, InsufficientDependencyServiceAccessPermissionException, 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.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault StopLoggingResponse stopLogging(StopLoggingRequest stopLoggingRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, InsufficientDependencyServiceAccessPermissionException, 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.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault StopLoggingResponse stopLogging(Consumer<StopLoggingRequest.Builder> stopLoggingRequest) throws TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, InsufficientDependencyServiceAccessPermissionException, 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.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.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.AwsServiceExceptiondefault UpdateTrailResponse updateTrail(UpdateTrailRequest updateTrailRequest) throws S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, TrailNotFoundException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, InvalidEventSelectorsException, InvalidParameterCombinationException, InvalidHomeRegionException, KmsKeyNotFoundException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, UnsupportedOperationException, OperationNotPermittedException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, OrganizationsNotInUseException, NotOrganizationMasterAccountException, OrganizationNotInAllFeaturesModeException, CloudTrailInvalidClientTokenIdException, 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 no longer in use.InvalidEventSelectorsException - This exception is thrown when the PutEventSelectors operation is called with a number of
event selectors, advanced event selectors, or data resources that is not valid. The combination of event
selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event
selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in
all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources
can be distributed across event selectors, but the overall total cannot exceed 250.
You can:
Specify a valid number of event selectors (1 to 5) for a trail.
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter
with a value of read-only is invalid.
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, when the S3 bucket and the KMS key are not in
the same region, or when the KMS key associated with the SNS topic either does not exist or is not in the
same region.KmsException - This exception is thrown when there is an issue with the specified KMS key and the trail 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.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between AWS CloudTrail and AWS
Organizations. For more information, see Enabling
Trusted Access with Other AWS Services and Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.OrganizationsNotInUseException - This exception is thrown when the request is made from an AWS account that is not a member of an
organization. To make this request, sign in using the credentials of an account that belongs to an
organization.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.OrganizationNotInAllFeaturesModeException - This exception is thrown when AWS Organizations is not configured to support all features. All features
must be enabled in AWS Organization to support creating an organization trail. For more information, see
Prepare For Creating a Trail For Your Organization.CloudTrailInvalidClientTokenIdException - This exception is thrown when a call results in the InvalidClientTokenId error code. This
can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is
in a suspended AWS account.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.AwsServiceExceptiondefault UpdateTrailResponse updateTrail(Consumer<UpdateTrailRequest.Builder> updateTrailRequest) throws S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, TrailNotFoundException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, InvalidEventSelectorsException, InvalidParameterCombinationException, InvalidHomeRegionException, KmsKeyNotFoundException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, UnsupportedOperationException, OperationNotPermittedException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, OrganizationsNotInUseException, NotOrganizationMasterAccountException, OrganizationNotInAllFeaturesModeException, CloudTrailInvalidClientTokenIdException, 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 no longer in use.InvalidEventSelectorsException - This exception is thrown when the PutEventSelectors operation is called with a number of
event selectors, advanced event selectors, or data resources that is not valid. The combination of event
selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event
selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in
all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources
can be distributed across event selectors, but the overall total cannot exceed 250.
You can:
Specify a valid number of event selectors (1 to 5) for a trail.
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter
with a value of read-only is invalid.
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, when the S3 bucket and the KMS key are not in
the same region, or when the KMS key associated with the SNS topic either does not exist or is not in the
same region.KmsException - This exception is thrown when there is an issue with the specified KMS key and the trail 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.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between AWS CloudTrail and AWS
Organizations. For more information, see Enabling
Trusted Access with Other AWS Services and Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.OrganizationsNotInUseException - This exception is thrown when the request is made from an AWS account that is not a member of an
organization. To make this request, sign in using the credentials of an account that belongs to an
organization.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.OrganizationNotInAllFeaturesModeException - This exception is thrown when AWS Organizations is not configured to support all features. All features
must be enabled in AWS Organization to support creating an organization trail. For more information, see
Prepare For Creating a Trail For Your Organization.CloudTrailInvalidClientTokenIdException - This exception is thrown when a call results in the InvalidClientTokenId error code. This
can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is
in a suspended AWS account.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()