/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.cloudtrail; import org.w3c.dom.*; import java.net.*; import java.util.*; import javax.annotation.Generated; import org.apache.commons.logging.*; import com.amazonaws.*; import com.amazonaws.annotation.SdkInternalApi; import com.amazonaws.auth.*; import com.amazonaws.handlers.*; import com.amazonaws.http.*; import com.amazonaws.internal.*; import com.amazonaws.internal.auth.*; import com.amazonaws.metrics.*; import com.amazonaws.regions.*; import com.amazonaws.transform.*; import com.amazonaws.util.*; import com.amazonaws.protocol.json.*; import com.amazonaws.util.AWSRequestMetrics.Field; import com.amazonaws.annotation.ThreadSafe; import com.amazonaws.client.AwsSyncClientParams; import com.amazonaws.client.builder.AdvancedConfig; import com.amazonaws.services.cloudtrail.AWSCloudTrailClientBuilder; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.cloudtrail.model.*; import com.amazonaws.services.cloudtrail.model.transform.*; /** * Client for accessing CloudTrail. All service calls made using this client are blocking, and will not return until the * service call completes. *
*
* 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 Amazon Web Services API calls for your Amazon Web Services account and * delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time * of the Amazon Web Services 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 Amazon Web Services SDKs, which consist of libraries and sample * code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide * programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, * and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to * download and install them, see Tools to Build on Amazon Web Services. *
** See the CloudTrail * User Guide for information about the data that is included with each Amazon Web Services API call listed in the * log files. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSCloudTrailClient extends AmazonWebServiceClient implements AWSCloudTrail { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSCloudTrail.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "cloudtrail"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("EventDataStoreMaxLimitExceededException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.EventDataStoreMaxLimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("EventDataStoreTerminationProtectedException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.EventDataStoreTerminationProtectedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourcePolicyNotValidException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ResourcePolicyNotValidExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidKmsKeyIdException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidKmsKeyIdExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidCloudWatchLogsLogGroupArnException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidCloudWatchLogsLogGroupArnExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidEventDataStoreCategoryException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidEventDataStoreCategoryExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidSourceException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidSourceExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("EventDataStoreAlreadyExistsException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.EventDataStoreAlreadyExistsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("NotOrganizationMasterAccountException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.NotOrganizationMasterAccountExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidLookupAttributesException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidLookupAttributesExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("CloudTrailInvalidClientTokenIdException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.CloudTrailInvalidClientTokenIdExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("OrganizationsNotInUseException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.OrganizationsNotInUseExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidNextTokenException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidNextTokenExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidEventSelectorsException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidEventSelectorsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ChannelARNInvalidException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ChannelARNInvalidExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("UnsupportedOperationException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.UnsupportedOperationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidEventDataStoreStatusException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidEventDataStoreStatusExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccountNotRegisteredException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.AccountNotRegisteredExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("CloudTrailAccessNotEnabledException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.CloudTrailAccessNotEnabledExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidTrailNameException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidTrailNameExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidImportSourceException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidImportSourceExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InsufficientEncryptionPolicyException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InsufficientEncryptionPolicyExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourcePolicyNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ResourcePolicyNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("DelegatedAdminAccountLimitExceededException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.DelegatedAdminAccountLimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidS3PrefixException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidS3PrefixExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InsufficientSnsTopicPolicyException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InsufficientSnsTopicPolicyExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidHomeRegionException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidHomeRegionExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InsufficientDependencyServiceAccessPermissionException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InsufficientDependencyServiceAccessPermissionExceptionUnmarshaller .getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ChannelAlreadyExistsException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ChannelAlreadyExistsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidParameterException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidParameterExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("EventDataStoreARNInvalidException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.EventDataStoreARNInvalidExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("QueryIdNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.QueryIdNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InactiveEventDataStoreException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InactiveEventDataStoreExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("TrailNotProvidedException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.TrailNotProvidedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidQueryStatusException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidQueryStatusExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidEventCategoryException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidEventCategoryExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("KmsException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.KmsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("OrganizationNotInAllFeaturesModeException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.OrganizationNotInAllFeaturesModeExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("S3BucketDoesNotExistException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.S3BucketDoesNotExistExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("NoManagementAccountSLRExistsException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.NoManagementAccountSLRExistsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("CannotDelegateManagementAccountException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.CannotDelegateManagementAccountExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("TagsLimitExceededException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.TagsLimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidSnsTopicNameException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidSnsTopicNameExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("KmsKeyNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.KmsKeyNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccountRegisteredException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.AccountRegisteredExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("OperationNotPermittedException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.OperationNotPermittedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ChannelExistsForEDSException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ChannelExistsForEDSExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccountHasOngoingImportException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.AccountHasOngoingImportExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceTypeNotSupportedException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ResourceTypeNotSupportedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("KmsKeyDisabledException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.KmsKeyDisabledExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidTokenException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidTokenExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("CloudTrailARNInvalidException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.CloudTrailARNInvalidExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ConflictException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ConflictExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidCloudWatchLogsRoleArnException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidCloudWatchLogsRoleArnExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidQueryStatementException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidQueryStatementExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceARNNotValidException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ResourceARNNotValidExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidTimeRangeException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidTimeRangeExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ImportNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ImportNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccountNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.AccountNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidParameterCombinationException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidParameterCombinationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidMaxResultsException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidMaxResultsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidS3BucketNameException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidS3BucketNameExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("CloudWatchLogsDeliveryUnavailableException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.CloudWatchLogsDeliveryUnavailableExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InactiveQueryException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InactiveQueryExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ChannelMaxLimitExceededException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ChannelMaxLimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("EventDataStoreNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.EventDataStoreNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidTagParameterException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidTagParameterExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("TrailNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.TrailNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("MaximumNumberOfTrailsExceededException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.MaximumNumberOfTrailsExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("EventDataStoreHasOngoingImportException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.EventDataStoreHasOngoingImportExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidInsightSelectorsException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidInsightSelectorsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidDateRangeException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InvalidDateRangeExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("NotOrganizationManagementAccountException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.NotOrganizationManagementAccountExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ChannelNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.ChannelNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("MaxConcurrentQueriesException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.MaxConcurrentQueriesExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InsufficientS3BucketPolicyException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InsufficientS3BucketPolicyExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("TrailAlreadyExistsException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.TrailAlreadyExistsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InsightNotEnabledException").withExceptionUnmarshaller( com.amazonaws.services.cloudtrail.model.transform.InsightNotEnabledExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.cloudtrail.model.AWSCloudTrailException.class)); /** * Constructs a new client to invoke service methods on CloudTrail. A credentials provider chain will be used that * searches for credentials in this order: ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @see DefaultAWSCredentialsProviderChain * @deprecated use {@link AWSCloudTrailClientBuilder#defaultClient()} */ @Deprecated public AWSCloudTrailClient() { this(DefaultAWSCredentialsProviderChain.getInstance(), configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on CloudTrail. A credentials provider chain will be used that * searches for credentials in this order: *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientConfiguration * The client configuration options controlling how this client connects to CloudTrail (ex: proxy settings, * retry counts, etc.). * * @see DefaultAWSCredentialsProviderChain * @deprecated use {@link AWSCloudTrailClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSCloudTrailClient(ClientConfiguration clientConfiguration) { this(DefaultAWSCredentialsProviderChain.getInstance(), clientConfiguration); } /** * Constructs a new client to invoke service methods on CloudTrail using the specified AWS account credentials. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentials * The AWS credentials (access key ID and secret key) to use when authenticating with AWS services. * @deprecated use {@link AWSCloudTrailClientBuilder#withCredentials(AWSCredentialsProvider)} for example: * {@code AWSCloudTrailClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();} */ @Deprecated public AWSCloudTrailClient(AWSCredentials awsCredentials) { this(awsCredentials, configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on CloudTrail using the specified AWS account credentials and * client configuration options. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentials * The AWS credentials (access key ID and secret key) to use when authenticating with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to CloudTrail (ex: proxy settings, * retry counts, etc.). * @deprecated use {@link AWSCloudTrailClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSCloudTrailClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSCloudTrailClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) { super(clientConfiguration); this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials); this.advancedConfig = AdvancedConfig.EMPTY; init(); } /** * Constructs a new client to invoke service methods on CloudTrail using the specified AWS account credentials * provider. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @deprecated use {@link AWSCloudTrailClientBuilder#withCredentials(AWSCredentialsProvider)} */ @Deprecated public AWSCloudTrailClient(AWSCredentialsProvider awsCredentialsProvider) { this(awsCredentialsProvider, configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on CloudTrail using the specified AWS account credentials * provider and client configuration options. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to CloudTrail (ex: proxy settings, * retry counts, etc.). * @deprecated use {@link AWSCloudTrailClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSCloudTrailClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSCloudTrailClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) { this(awsCredentialsProvider, clientConfiguration, null); } /** * Constructs a new client to invoke service methods on CloudTrail using the specified AWS account credentials * provider, client configuration options, and request metric collector. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to CloudTrail (ex: proxy settings, * retry counts, etc.). * @param requestMetricCollector * optional request metric collector * @deprecated use {@link AWSCloudTrailClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSCloudTrailClientBuilder#withClientConfiguration(ClientConfiguration)} and * {@link AWSCloudTrailClientBuilder#withMetricsCollector(RequestMetricCollector)} */ @Deprecated public AWSCloudTrailClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) { super(clientConfiguration, requestMetricCollector); this.awsCredentialsProvider = awsCredentialsProvider; this.advancedConfig = AdvancedConfig.EMPTY; init(); } public static AWSCloudTrailClientBuilder builder() { return AWSCloudTrailClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on CloudTrail using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSCloudTrailClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on CloudTrail using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSCloudTrailClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("cloudtrail.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/cloudtrail/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/cloudtrail/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* Adds one or more tags to a trail, event data store, or channel, up to a limit of 50. Overwrites an existing tag's * value when a new value is specified for an existing tag key. Tag key names must be unique; you cannot have two * keys with the same name but different values. If you specify a key without a value, the tag will be created with * the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web * Services Regions only from the Region in which the trail or event data store was created (also known as its home * Region). *
* * @param addTagsRequest * Specifies the tags to add to a trail, event data store, or channel. * @return Result of the AddTags operation returned by the service. * @throws ResourceNotFoundException * This exception is thrown when the specified resource is not found. * @throws CloudTrailARNInvalidException * This exception is thrown when an operation is called with a trail ARN that is not valid. The following is * the format of a trail ARN. *
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws EventDataStoreARNInvalidException
* The specified event data store ARN is not valid or does not map to an event data store in your account.
* @throws ChannelARNInvalidException
* This exception is thrown when the specified value of ChannelARN
is not valid.
* @throws ResourceTypeNotSupportedException
* This exception is thrown when the specified resource type is not supported by CloudTrail.
* @throws TagsLimitExceededException
* The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently,
* the limit is 50.
* @throws InvalidTrailNameException
* This exception is thrown when the provided trail name is not valid. Trail names must meet the following
* requirements:
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
*
* Cancels a query if the query is not in a terminated state, such as CANCELLED
, FAILED
,
* TIMED_OUT
, or FINISHED
. You must specify an ARN value for EventDataStore
.
* The ID of the query that you want to cancel is also required. When you run CancelQuery
, the query
* status might show as CANCELLED
even if the operation is not yet finished.
*
FINISHED
, FAILED
,
* TIMED_OUT
, or CANCELLED
state.
* @throws InvalidParameterException
* The request includes a parameter that is not valid.
* @throws QueryIdNotFoundException
* The query ID does not exist or does not map to a query.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @throws NoManagementAccountSLRExistsException
* This exception is thrown when the management account does not have a service-linked role.
* @throws ConflictException
* This exception is thrown when the specified resource is not ready for an operation. This can occur when
* you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
* because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
* then try the operation again.
* @sample AWSCloudTrail.CancelQuery
* @see AWS API
* Documentation
*/
@Override
public CancelQueryResult cancelQuery(CancelQueryRequest request) {
request = beforeClientExecution(request);
return executeCancelQuery(request);
}
@SdkInternalApi
final CancelQueryResult executeCancelQuery(CancelQueryRequest cancelQueryRequest) {
ExecutionContext executionContext = createExecutionContext(cancelQueryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, * a CloudTrail Lake event data store can log events from the partner or source that you specify. *
* * @param createChannelRequest * @return Result of the CreateChannel operation returned by the service. * @throws ChannelMaxLimitExceededException * This exception is thrown when the maximum number of channels limit is exceeded. * @throws InvalidSourceException * This exception is thrown when the specified value ofSource
is not valid.
* @throws ChannelAlreadyExistsException
* This exception is thrown when the provided channel already exists.
* @throws EventDataStoreARNInvalidException
* The specified event data store ARN is not valid or does not map to an event data store in your account.
* @throws EventDataStoreNotFoundException
* The specified event data store was not found.
* @throws InvalidEventDataStoreCategoryException
* This exception is thrown when event categories of specified event data stores are not valid.
* @throws InactiveEventDataStoreException
* The event data store is inactive.
* @throws InvalidParameterException
* The request includes a parameter that is not valid.
* @throws 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.
* @throws TagsLimitExceededException
* The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently,
* the limit is 50.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @sample AWSCloudTrail.CreateChannel
* @see AWS API
* Documentation
*/
@Override
public CreateChannelResult createChannel(CreateChannelRequest request) {
request = beforeClientExecution(request);
return executeCreateChannel(request);
}
@SdkInternalApi
final CreateChannelResult executeCreateChannel(CreateChannelRequest createChannelRequest) {
ExecutionContext executionContext = createExecutionContext(createChannelRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* Creates a new event data store. *
* * @param createEventDataStoreRequest * @return Result of the CreateEventDataStore operation returned by the service. * @throws EventDataStoreAlreadyExistsException * An event data store with that name already exists. * @throws EventDataStoreMaxLimitExceededException * Your account has used the maximum number of event data stores. * @throws InvalidEventSelectorsException * This exception is thrown when thePutEventSelectors
operation is called with a number of
* event selectors, advanced event selectors, or data resources that is not valid. The combination of event
* selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event
* selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in
* all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources
* can be distributed across event selectors, but the overall total cannot exceed 250.
* * You can: *
** Specify a valid number of event selectors (1 to 5) for a trail. *
** Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of * resources on an individual event selector is configurable up to 250. However, this upper limit is allowed * only if the total number of data resources does not exceed 250 across all event selectors for a trail. *
** Specify up to 500 values for all conditions in all advanced event selectors for a trail. *
*
* Specify a valid value for a parameter. For example, specifying the ReadWriteType
parameter
* with a value of read-only
is not valid.
*
* Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. *
* * @param createTrailRequest * Specifies the settings for each trail. * @return Result of the CreateTrail operation returned by the service. * @throws MaximumNumberOfTrailsExceededException * This exception is thrown when the maximum number of trails is reached. * @throws TrailAlreadyExistsException * This exception is thrown when the specified trail already exists. * @throws S3BucketDoesNotExistException * This exception is thrown when the specified S3 bucket does not exist. * @throws InsufficientS3BucketPolicyException * This exception is thrown when the policy on the S3 bucket is not sufficient. * @throws InsufficientSnsTopicPolicyException * This exception is thrown when the policy on the Amazon SNS topic is not sufficient. * @throws InsufficientEncryptionPolicyException * This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions * for the operation. * @throws InvalidS3BucketNameException * This exception is thrown when the provided S3 bucket name is not valid. * @throws InvalidS3PrefixException * This exception is thrown when the provided S3 prefix is not valid. * @throws InvalidSnsTopicNameException * This exception is thrown when the provided SNS topic name is not valid. * @throws InvalidKmsKeyIdException * This exception is thrown when the KMS key ARN is not valid. * @throws InvalidTrailNameException * This exception is thrown when the provided trail name is not valid. Trail names must meet the following * requirements: ** Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
*InvalidClientTokenId
error code. This
* can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is
* in a suspended Amazon Web Services account.
* @throws ConflictException
* This exception is thrown when the specified resource is not ready for an operation. This can occur when
* you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
* because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
* then try the operation again.
* @sample AWSCloudTrail.CreateTrail
* @see AWS API
* Documentation
*/
@Override
public CreateTrailResult createTrail(CreateTrailRequest request) {
request = beforeClientExecution(request);
return executeCreateTrail(request);
}
@SdkInternalApi
final CreateTrailResult executeCreateTrail(CreateTrailRequest createTrailRequest) {
ExecutionContext executionContext = createExecutionContext(createTrailRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* Deletes a channel. *
* * @param deleteChannelRequest * @return Result of the DeleteChannel operation returned by the service. * @throws ChannelARNInvalidException * This exception is thrown when the specified value ofChannelARN
is not valid.
* @throws ChannelNotFoundException
* This exception is thrown when CloudTrail cannot find the specified channel.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @sample AWSCloudTrail.DeleteChannel
* @see AWS API
* Documentation
*/
@Override
public DeleteChannelResult deleteChannel(DeleteChannelRequest request) {
request = beforeClientExecution(request);
return executeDeleteChannel(request);
}
@SdkInternalApi
final DeleteChannelResult executeDeleteChannel(DeleteChannelRequest deleteChannelRequest) {
ExecutionContext executionContext = createExecutionContext(deleteChannelRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Disables the event data store specified by EventDataStore
, which accepts an event data store ARN.
* After you run DeleteEventDataStore
, the event data store enters a PENDING_DELETION
* state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled
* must be set to False
on the event data store; this operation cannot work if
* TerminationProtectionEnabled
is True
.
*
* After you run DeleteEventDataStore
on an event data store, you cannot run ListQueries
,
* DescribeQuery
, or GetQueryResults
on queries that are using an event data store in a
* PENDING_DELETION
state. An event data store in the PENDING_DELETION
state does not
* incur costs.
*
* Deletes the resource-based policy attached to the CloudTrail channel. *
* * @param deleteResourcePolicyRequest * @return Result of the DeleteResourcePolicy operation returned by the service. * @throws ResourceARNNotValidException * This exception is thrown when the provided resource does not exist, or the ARN format of the resource is * not valid. The following is the valid format for a resource ARN: *arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel
.
* @throws ResourceNotFoundException
* This exception is thrown when the specified resource is not found.
* @throws ResourcePolicyNotFoundException
* This exception is thrown when the specified resource policy is not found.
* @throws ResourceTypeNotSupportedException
* This exception is thrown when the specified resource type is not supported by CloudTrail.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @sample AWSCloudTrail.DeleteResourcePolicy
* @see AWS API Documentation
*/
@Override
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request) {
request = beforeClientExecution(request);
return executeDeleteResourcePolicy(request);
}
@SdkInternalApi
final DeleteResourcePolicyResult executeDeleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) {
ExecutionContext executionContext = createExecutionContext(deleteResourcePolicyRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* 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.
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
*
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* Removes CloudTrail delegated administrator permissions from a member account in an organization.
*
* Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched,
* and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and
* the delivery status.
*
* You must specify either a
* Retrieves settings for one or more trails associated with the current Region for your account.
*
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws ConflictException
* This exception is thrown when the specified resource is not ready for an operation. This can occur when
* you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
* because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
* then try the operation again.
* @throws 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.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws NotOrganizationMasterAccountException
* This exception is thrown when the Amazon Web Services account making the request to create or update an
* organization trail or event data store is not the management account for an organization in
* Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an
* event data store.
* @throws NoManagementAccountSLRExistsException
* This exception is thrown when the management account does not have a service-linked role.
* @throws InsufficientDependencyServiceAccessPermissionException
* This exception is thrown when the IAM identity that is used to create the organization resource lacks one
* or more required permissions for creating an organization resource in a required service.
* @sample AWSCloudTrail.DeleteTrail
* @see AWS API
* Documentation
*/
@Override
public DeleteTrailResult deleteTrail(DeleteTrailRequest request) {
request = beforeClientExecution(request);
return executeDeleteTrail(request);
}
@SdkInternalApi
final DeleteTrailResult executeDeleteTrail(DeleteTrailRequest deleteTrailRequest) {
ExecutionContext executionContext = createExecutionContext(deleteTrailRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
RequestQueryID
or a QueryAlias
. Specifying the
* QueryAlias
parameter returns information about the last query run for the alias.
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
** Returns information about a specific channel. *
* * @param getChannelRequest * @return Result of the GetChannel operation returned by the service. * @throws ChannelARNInvalidException * This exception is thrown when the specified value ofChannelARN
is not valid.
* @throws ChannelNotFoundException
* This exception is thrown when CloudTrail cannot find the specified channel.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @sample AWSCloudTrail.GetChannel
* @see AWS API
* Documentation
*/
@Override
public GetChannelResult getChannel(GetChannelRequest request) {
request = beforeClientExecution(request);
return executeGetChannel(request);
}
@SdkInternalApi
final GetChannelResult executeGetChannel(GetChannelRequest getChannelRequest) {
ExecutionContext executionContext = createExecutionContext(getChannelRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* Returns information about an event data store specified as either an ARN or the ID portion of the ARN. *
* * @param getEventDataStoreRequest * @return Result of the GetEventDataStore operation returned by the service. * @throws EventDataStoreARNInvalidException * The specified event data store ARN is not valid or does not map to an event data store in your account. * @throws EventDataStoreNotFoundException * The specified event data store was not found. * @throws InvalidParameterException * The request includes a parameter that is not valid. * @throws OperationNotPermittedException * This exception is thrown when the requested operation is not permitted. * @throws UnsupportedOperationException * This exception is thrown when the requested operation is not supported. * @throws NoManagementAccountSLRExistsException * This exception is thrown when the management account does not have a service-linked role. * @sample AWSCloudTrail.GetEventDataStore * @see AWS * API Documentation */ @Override public GetEventDataStoreResult getEventDataStore(GetEventDataStoreRequest request) { request = beforeClientExecution(request); return executeGetEventDataStore(request); } @SdkInternalApi final GetEventDataStoreResult executeGetEventDataStore(GetEventDataStoreRequest getEventDataStoreRequest) { ExecutionContext executionContext = createExecutionContext(getEventDataStoreRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 resources on which you are logging data events. *
** For more information about logging management and data events, see the following topics in the CloudTrail User * Guide: *
** Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
*
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* Returns information about a specific import.
*
* Describes the settings for the Insights event selectors that you configured for your trail.
*
* For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.
*
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws NoManagementAccountSLRExistsException
* This exception is thrown when the management account does not have a service-linked role.
* @sample AWSCloudTrail.GetEventSelectors
* @see AWS
* API Documentation
*/
@Override
public GetEventSelectorsResult getEventSelectors(GetEventSelectorsRequest request) {
request = beforeClientExecution(request);
return executeGetEventSelectors(request);
}
@SdkInternalApi
final GetEventSelectorsResult executeGetEventSelectors(GetEventSelectorsRequest getEventSelectorsRequest) {
ExecutionContext executionContext = createExecutionContext(getEventSelectorsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
RequestGetInsightSelectors
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
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
*
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* Gets event data results of a query. You must specify the
* Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
*
* Returns settings information for a specified trail.
*
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws InsightNotEnabledException
* If you run GetInsightSelectors
on a trail that does not have Insights events enabled, the
* operation throws the exception InsightNotEnabledException
.
* @throws NoManagementAccountSLRExistsException
* This exception is thrown when the management account does not have a service-linked role.
* @sample AWSCloudTrail.GetInsightSelectors
* @see AWS
* API Documentation
*/
@Override
public GetInsightSelectorsResult getInsightSelectors(GetInsightSelectorsRequest request) {
request = beforeClientExecution(request);
return executeGetInsightSelectors(request);
}
@SdkInternalApi
final GetInsightSelectorsResult executeGetInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest) {
ExecutionContext executionContext = createExecutionContext(getInsightSelectorsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
RequestQueryID
value returned by the
* StartQuery
operation.
* arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel
.
* @throws ResourceNotFoundException
* This exception is thrown when the specified resource is not found.
* @throws ResourcePolicyNotFoundException
* This exception is thrown when the specified resource policy is not found.
* @throws ResourceTypeNotSupportedException
* This exception is thrown when the specified resource type is not supported by CloudTrail.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @sample AWSCloudTrail.GetResourcePolicy
* @see AWS
* API Documentation
*/
@Override
public GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request) {
request = beforeClientExecution(request);
return executeGetResourcePolicy(request);
}
@SdkInternalApi
final GetResourcePolicyResult executeGetResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) {
ExecutionContext executionContext = createExecutionContext(getResourcePolicyRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws TrailNotFoundException
* This exception is thrown when the trail with the given name is not found.
* @throws InvalidTrailNameException
* This exception is thrown when the provided trail name is not valid. Trail names must meet the following
* requirements:
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
** 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. *
* * @param getTrailStatusRequest * The name of a trail about which you want the current status. * @return Result of the GetTrailStatus operation returned by the service. * @throws CloudTrailARNInvalidException * This exception is thrown when an operation is called with a trail ARN that is not valid. The following is * the format of a trail ARN. *
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws TrailNotFoundException
* This exception is thrown when the trail with the given name is not found.
* @throws InvalidTrailNameException
* This exception is thrown when the provided trail name is not valid. Trail names must meet the following
* requirements:
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
** Lists the channels in the current account, and their source names. *
* * @param listChannelsRequest * @return Result of the ListChannels operation returned by the service. * @throws InvalidNextTokenException * A token that is not valid, or a token that was previously used in a request with different parameters. * This exception is thrown if the token is not valid. * @throws OperationNotPermittedException * This exception is thrown when the requested operation is not permitted. * @throws UnsupportedOperationException * This exception is thrown when the requested operation is not supported. * @sample AWSCloudTrail.ListChannels * @see AWS API * Documentation */ @Override public ListChannelsResult listChannels(ListChannelsRequest request) { request = beforeClientExecution(request); return executeListChannels(request); } @SdkInternalApi final ListChannelsResult executeListChannels(ListChannelsRequest listChannelsRequest) { ExecutionContext executionContext = createExecutionContext(listChannelsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns information about all event data stores in the account, in the current Region. *
* * @param listEventDataStoresRequest * @return Result of the ListEventDataStores operation returned by the service. * @throws InvalidMaxResultsException * This exception is thrown if the limit specified is not valid. * @throws InvalidNextTokenException * A token that is not valid, or a token that was previously used in a request with different parameters. * This exception is thrown if the token is not valid. * @throws OperationNotPermittedException * This exception is thrown when the requested operation is not permitted. * @throws UnsupportedOperationException * This exception is thrown when the requested operation is not supported. * @throws NoManagementAccountSLRExistsException * This exception is thrown when the management account does not have a service-linked role. * @sample AWSCloudTrail.ListEventDataStores * @see AWS * API Documentation */ @Override public ListEventDataStoresResult listEventDataStores(ListEventDataStoresRequest request) { request = beforeClientExecution(request); return executeListEventDataStores(request); } @SdkInternalApi final ListEventDataStoresResult executeListEventDataStores(ListEventDataStoresRequest listEventDataStoresRequest) { ExecutionContext executionContext = createExecutionContext(listEventDataStoresRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns a list of failures for the specified import. *
* * @param listImportFailuresRequest * @return Result of the ListImportFailures operation returned by the service. * @throws InvalidNextTokenException * A token that is not valid, or a token that was previously used in a request with different parameters. * This exception is thrown if the token is not valid. * @throws OperationNotPermittedException * This exception is thrown when the requested operation is not permitted. * @throws UnsupportedOperationException * This exception is thrown when the requested operation is not supported. * @sample AWSCloudTrail.ListImportFailures * @see AWS * API Documentation */ @Override public ListImportFailuresResult listImportFailures(ListImportFailuresRequest request) { request = beforeClientExecution(request); return executeListImportFailures(request); } @SdkInternalApi final ListImportFailuresResult executeListImportFailures(ListImportFailuresRequest listImportFailuresRequest) { ExecutionContext executionContext = createExecutionContext(listImportFailuresRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Returns information on all imports, or a select set of imports by ImportStatus
or
* Destination
.
*
* 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 and public key pairs per Region. Each digest file is signed with a private key * unique to its Region. When you validate a digest file from a specific Region, you must look in the same Region * for its corresponding public key. *
*
* Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for
* EventDataStore
. Optionally, to shorten the list of results, you can specify a time range, formatted
* as timestamps, by adding StartTime
and EndTime
parameters, and a
* QueryStatus
value. Valid values for QueryStatus
include QUEUED
,
* RUNNING
, FINISHED
, FAILED
, TIMED_OUT
, or
* CANCELLED
.
*
* Lists the tags for the specified trails, event data stores, or channels in the current Region. *
* * @param listTagsRequest * Specifies a list of tags to return. * @return Result of the ListTags operation returned by the service. * @throws ResourceNotFoundException * This exception is thrown when the specified resource is not found. * @throws CloudTrailARNInvalidException * This exception is thrown when an operation is called with a trail ARN that is not valid. The following is * the format of a trail ARN. *
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws EventDataStoreARNInvalidException
* The specified event data store ARN is not valid or does not map to an event data store in your account.
* @throws ChannelARNInvalidException
* This exception is thrown when the specified value of ChannelARN
is not valid.
* @throws ResourceTypeNotSupportedException
* This exception is thrown when the specified resource type is not supported by CloudTrail.
* @throws InvalidTrailNameException
* This exception is thrown when the provided trail name is not valid. Trail names must meet the following
* requirements:
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
** Lists trails that are in the current account. *
* * @param listTrailsRequest * @return Result of the ListTrails operation returned by the service. * @throws UnsupportedOperationException * This exception is thrown when the requested operation is not supported. * @throws OperationNotPermittedException * This exception is thrown when the requested operation is not permitted. * @sample AWSCloudTrail.ListTrails * @see AWS API * Documentation */ @Override public ListTrailsResult listTrails(ListTrailsRequest request) { request = beforeClientExecution(request); return executeListTrails(request); } @SdkInternalApi final ListTrailsResult executeListTrails(ListTrailsRequest listTrailsRequest) { ExecutionContext executionContext = createExecutionContext(listTrailsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region * within the last 90 days. Lookup supports the following attributes for management events: *
** Amazon Web Services access key *
** Event ID *
** Event name *
** Event source *
** Read only *
** Resource name *
** Resource type *
** User name *
** Lookup supports the following attributes for Insights events: *
** Event ID *
** Event name *
** Event source *
** All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The * response includes a token that you can use to get the next page of results. *
** The rate of lookup requests is limited to two per second, per account, per Region. If this limit is exceeded, a * throttling error occurs. *
*EventCategory
.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @sample AWSCloudTrail.LookupEvents
* @see AWS API
* Documentation
*/
@Override
public LookupEventsResult lookupEvents(LookupEventsRequest request) {
request = beforeClientExecution(request);
return executeLookupEvents(request);
}
@SdkInternalApi
final LookupEventsResult executeLookupEvents(LookupEventsRequest lookupEventsRequest) {
ExecutionContext executionContext = createExecutionContext(lookupEventsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* 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. If you want your trail to log Insights * events, be sure the event selector enables logging of the Insights event types you want configured for your * trail. For more information about logging Insights events, see Logging Insights events for trails in the CloudTrail User Guide. By default, trails created without * specific event selectors are configured to log all read and write management events, and no data events. *
** 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 management events, Logging data events, and Quotas in * CloudTrail in the 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 in the CloudTrail User Guide.
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
*
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws 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.
* @throws InvalidEventSelectorsException
* This exception is thrown when the PutEventSelectors
operation is called with a number of
* event selectors, advanced event selectors, or data resources that is not valid. The combination of event
* selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event
* selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in
* all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources
* can be distributed across event selectors, but the overall total cannot exceed 250.
*
* You can: *
** Specify a valid number of event selectors (1 to 5) for a trail. *
** Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of * resources on an individual event selector is configurable up to 250. However, this upper limit is allowed * only if the total number of data resources does not exceed 250 across all event selectors for a trail. *
** Specify up to 500 values for all conditions in all advanced event selectors for a trail. *
*
* Specify a valid value for a parameter. For example, specifying the ReadWriteType
parameter
* with a value of read-only
is not valid.
*
* 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. The valid Insights event types in this release are ApiErrorRateInsight
* and ApiCallRateInsight
.
*
* To log CloudTrail Insights events on API call volume, the trail must log write
management events. To
* log CloudTrail Insights events on API error rate, the trail must log read
or write
* management events. You can call GetEventSelectors
on a trail to check whether the trail logs
* management events.
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
*
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event
* source outside of Amazon Web Services. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
*
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws 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.
* @throws 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.
* @throws InsufficientS3BucketPolicyException
* This exception is thrown when the policy on the S3 bucket is not sufficient.
* @throws InsufficientEncryptionPolicyException
* This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions
* for the operation.
* @throws S3BucketDoesNotExistException
* This exception is thrown when the specified S3 bucket does not exist.
* @throws KmsException
* This exception is thrown when there is an issue with the specified KMS key and the trail or event data
* store can't be updated.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws NotOrganizationMasterAccountException
* This exception is thrown when the Amazon Web Services account making the request to create or update an
* organization trail or event data store is not the management account for an organization in
* Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an
* event data store.
* @throws NoManagementAccountSLRExistsException
* This exception is thrown when the management account does not have a service-linked role.
* @sample AWSCloudTrail.PutInsightSelectors
* @see AWS
* API Documentation
*/
@Override
public PutInsightSelectorsResult putInsightSelectors(PutInsightSelectorsRequest request) {
request = beforeClientExecution(request);
return executePutInsightSelectors(request);
}
@SdkInternalApi
final PutInsightSelectorsResult executePutInsightSelectors(PutInsightSelectorsRequest putInsightSelectorsRequest) {
ExecutionContext executionContext = createExecutionContext(putInsightSelectorsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Requestarn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel
.
* @throws ResourcePolicyNotValidException
* This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is
* not valid.
* The following are requirements for the resource policy: *
** Contains only one action: cloudtrail-data:PutAuditEvents *
** Contains at least one statement. The policy can have a maximum of 20 statements. *
** Each statement contains at least one principal. A statement can have a maximum of 50 principals. *
** Registers an organization’s member account as the CloudTrail delegated administrator. *
* * @param registerOrganizationDelegatedAdminRequest * Specifies an organization member account ID as a CloudTrail delegated administrator. * @return Result of the RegisterOrganizationDelegatedAdmin operation returned by the service. * @throws AccountRegisteredException * This exception is thrown when the account is already registered as the CloudTrail delegated * administrator. * @throws AccountNotFoundException * This exception is thrown when the specified account is not found or not part of an organization. * @throws InsufficientDependencyServiceAccessPermissionException * This exception is thrown when the IAM identity that is used to create the organization resource lacks one * or more required permissions for creating an organization resource in a required service. * @throws InvalidParameterException * The request includes a parameter that is not valid. * @throws CannotDelegateManagementAccountException * This exception is thrown when the management account of an organization is registered as the CloudTrail * delegated administrator. * @throws CloudTrailAccessNotEnabledException * This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. * For more information, see Enabling * Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization. * @throws ConflictException * This exception is thrown when the specified resource is not ready for an operation. This can occur when * you try to run an operation on a resource before CloudTrail has time to fully load the resource, or * because another operation is modifying the resource. If this exception occurs, wait a few minutes, and * then try the operation again. * @throws DelegatedAdminAccountLimitExceededException * This exception is thrown when the maximum number of CloudTrail delegated administrators is reached. * @throws NotOrganizationManagementAccountException * This exception is thrown when the account making the request is not the organization's management * account. * @throws OrganizationNotInAllFeaturesModeException * This exception is thrown when Organizations is not configured to support all features. All features must * be enabled in Organizations to support creating an organization trail or event data store. * @throws OrganizationsNotInUseException * This exception is thrown when the request is made from an Amazon Web Services account that is not a * member of an organization. To make this request, sign in using the credentials of an account that belongs * to an organization. * @throws UnsupportedOperationException * This exception is thrown when the requested operation is not supported. * @throws OperationNotPermittedException * This exception is thrown when the requested operation is not permitted. * @sample AWSCloudTrail.RegisterOrganizationDelegatedAdmin * @see AWS API Documentation */ @Override public RegisterOrganizationDelegatedAdminResult registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest request) { request = beforeClientExecution(request); return executeRegisterOrganizationDelegatedAdmin(request); } @SdkInternalApi final RegisterOrganizationDelegatedAdminResult executeRegisterOrganizationDelegatedAdmin( RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest) { ExecutionContext executionContext = createExecutionContext(registerOrganizationDelegatedAdminRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Removes the specified tags from a trail, event data store, or channel. *
* * @param removeTagsRequest * Specifies the tags to remove from a trail, event data store, or channel. * @return Result of the RemoveTags operation returned by the service. * @throws ResourceNotFoundException * This exception is thrown when the specified resource is not found. * @throws CloudTrailARNInvalidException * This exception is thrown when an operation is called with a trail ARN that is not valid. The following is * the format of a trail ARN. *
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws EventDataStoreARNInvalidException
* The specified event data store ARN is not valid or does not map to an event data store in your account.
* @throws ChannelARNInvalidException
* This exception is thrown when the specified value of ChannelARN
is not valid.
* @throws ResourceTypeNotSupportedException
* This exception is thrown when the specified resource type is not supported by CloudTrail.
* @throws InvalidTrailNameException
* This exception is thrown when the provided trail name is not valid. Trail names must meet the following
* requirements:
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
*
* Restores a deleted event data store specified by EventDataStore
, which accepts an event data store
* ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring
* an event data store can take several minutes, depending on the size of the event data store.
*
* Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
* ARN. To start ingestion, the event data store Status
must be STOPPED_INGESTION
and the
* eventCategory
must be Management
, Data
, or ConfigurationItem
.
*
* Starts an import of logged trail events from a source S3 bucket to a destination event data store. By default,
* CloudTrail only imports events contained in the S3 bucket's CloudTrail
prefix and the prefixes
* inside the CloudTrail
prefix, and does not check prefixes for other Amazon Web Services services. If
* you want to import CloudTrail events contained in another prefix, you must include the prefix in the
* S3LocationUri
. For more considerations about importing trail events, see Considerations.
*
* When you start a new import, the Destinations
and ImportSource
parameters are required.
* Before starting a new import, disable any access control lists (ACLs) attached to the source S3 bucket. For more
* information about disabling ACLs, see Controlling ownership of
* objects and disabling ACLs for your bucket.
*
* When you retry an import, the ImportID
parameter is required.
*
* If the destination event data store is for an organization, you must use the management account to import trail * events. You cannot use the delegated administrator account for the organization. *
** Starts the recording of Amazon Web Services 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. *
* * @param startLoggingRequest * The request to CloudTrail to start logging Amazon Web Services API calls for an account. * @return Result of the StartLogging operation returned by the service. * @throws CloudTrailARNInvalidException * This exception is thrown when an operation is called with a trail ARN that is not valid. The following is * the format of a trail ARN. *
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws ConflictException
* This exception is thrown when the specified resource is not ready for an operation. This can occur when
* you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
* because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
* then try the operation again.
* @throws TrailNotFoundException
* This exception is thrown when the trail with the given name is not found.
* @throws InvalidTrailNameException
* This exception is thrown when the provided trail name is not valid. Trail names must meet the following
* requirements:
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
*
* Starts a CloudTrail Lake query. Use the QueryStatement
parameter to provide your SQL query, enclosed
* in single quotation marks. Use the optional DeliveryS3Uri
parameter to deliver the query results to
* an S3 bucket.
*
* StartQuery
requires you specify either the QueryStatement
parameter, or a
* QueryAlias
and any QueryParameters
. In the current release, the QueryAlias
* and QueryParameters
parameters are used only for the queries that populate the CloudTrail Lake
* dashboards.
*
* Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
* ARN. To stop ingestion, the event data store Status
must be ENABLED
and the
* eventCategory
must be Management
, Data
, or ConfigurationItem
.
*
* Stops a specified import. *
* * @param stopImportRequest * @return Result of the StopImport operation returned by the service. * @throws ImportNotFoundException * The specified import was not found. * @throws InvalidParameterException * The request includes a parameter that is not valid. * @throws OperationNotPermittedException * This exception is thrown when the requested operation is not permitted. * @throws UnsupportedOperationException * This exception is thrown when the requested operation is not supported. * @sample AWSCloudTrail.StopImport * @see AWS API * Documentation */ @Override public StopImportResult stopImport(StopImportRequest request) { request = beforeClientExecution(request); return executeStopImport(request); } @SdkInternalApi final StopImportResult executeStopImport(StopImportRequest stopImportRequest) { ExecutionContext executionContext = createExecutionContext(stopImportRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Suspends the recording of Amazon Web Services 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.
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
*
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* Updates a channel specified by a required channel ARN or UUID.
*
* Updates an event data store. The required
* For event data stores for CloudTrail events,
* For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
*
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws ConflictException
* This exception is thrown when the specified resource is not ready for an operation. This can occur when
* you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
* because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
* then try the operation again.
* @throws 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.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws NotOrganizationMasterAccountException
* This exception is thrown when the Amazon Web Services account making the request to create or update an
* organization trail or event data store is not the management account for an organization in
* Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an
* event data store.
* @throws NoManagementAccountSLRExistsException
* This exception is thrown when the management account does not have a service-linked role.
* @throws InsufficientDependencyServiceAccessPermissionException
* This exception is thrown when the IAM identity that is used to create the organization resource lacks one
* or more required permissions for creating an organization resource in a required service.
* @sample AWSCloudTrail.StopLogging
* @see AWS API
* Documentation
*/
@Override
public StopLoggingResult stopLogging(StopLoggingRequest request) {
request = beforeClientExecution(request);
return executeStopLogging(request);
}
@SdkInternalApi
final StopLoggingResult executeStopLogging(StopLoggingRequest stopLoggingRequest) {
ExecutionContext executionContext = createExecutionContext(stopLoggingRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
RequestChannelARN
is not valid.
* @throws ChannelNotFoundException
* This exception is thrown when CloudTrail cannot find the specified channel.
* @throws ChannelAlreadyExistsException
* This exception is thrown when the provided channel already exists.
* @throws EventDataStoreARNInvalidException
* The specified event data store ARN is not valid or does not map to an event data store in your account.
* @throws EventDataStoreNotFoundException
* The specified event data store was not found.
* @throws InvalidEventDataStoreCategoryException
* This exception is thrown when event categories of specified event data stores are not valid.
* @throws InactiveEventDataStoreException
* The event data store is inactive.
* @throws InvalidParameterException
* The request includes a parameter that is not valid.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @sample AWSCloudTrail.UpdateChannel
* @see AWS API
* Documentation
*/
@Override
public UpdateChannelResult updateChannel(UpdateChannelRequest request) {
request = beforeClientExecution(request);
return executeUpdateChannel(request);
}
@SdkInternalApi
final UpdateChannelResult executeUpdateChannel(UpdateChannelRequest updateChannelRequest) {
ExecutionContext executionContext = createExecutionContext(updateChannelRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
RequestEventDataStore
value is an ARN or the ID portion of the
* ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws
* an error. RetentionPeriod
is in days, and valid values are integers between 90 and 2557. By default,
* TerminationProtection
is enabled.
* AdvancedEventSelectors
includes or excludes management
* and data events in your event data store. For more information about AdvancedEventSelectors
, see
* AdvancedEventSelectors.
* AdvancedEventSelectors
includes events of that type in your event data store.
* PutEventSelectors
operation is called with a number of
* event selectors, advanced event selectors, or data resources that is not valid. The combination of event
* selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event
* selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in
* all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources
* can be distributed across event selectors, but the overall total cannot exceed 250.
* You can: *
** Specify a valid number of event selectors (1 to 5) for a trail. *
** Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of * resources on an individual event selector is configurable up to 250. However, this upper limit is allowed * only if the total number of data resources does not exceed 250 across all event selectors for a trail. *
** Specify up to 500 values for all conditions in all advanced event selectors for a trail. *
*
* Specify a valid value for a parameter. For example, specifying the ReadWriteType
parameter
* with a value of read-only
is not valid.
*
* Updates trail settings that control what events you are logging, and how to handle 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.
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) *
** Start with a letter or number, and end with a letter or number *
** Be between 3 and 128 characters *
*
* Have no adjacent periods, underscores or dashes. Names like my-_namespace
and
* my--namespace
are not valid.
*
* Not be in IP address format (for example, 192.168.5.4) *
*PutEventSelectors
operation is called with a number of
* event selectors, advanced event selectors, or data resources that is not valid. The combination of event
* selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event
* selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in
* all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources
* can be distributed across event selectors, but the overall total cannot exceed 250.
* * You can: *
** Specify a valid number of event selectors (1 to 5) for a trail. *
** Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of * resources on an individual event selector is configurable up to 250. However, this upper limit is allowed * only if the total number of data resources does not exceed 250 across all event selectors for a trail. *
** Specify up to 500 values for all conditions in all advanced event selectors for a trail. *
*
* Specify a valid value for a parameter. For example, specifying the ReadWriteType
parameter
* with a value of read-only
is not valid.
*
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
*
* This exception is also thrown when you call AddTags
or RemoveTags
on a trail,
* event data store, or channel with a resource ARN that is not valid.
*
* The following is the format of an event data store ARN:
* arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
*
* The following is the format of a channel ARN:
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private
* arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
* @throws ConflictException
* This exception is thrown when the specified resource is not ready for an operation. This can occur when
* you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
* because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
* then try the operation again.
* @throws InvalidParameterCombinationException
* This exception is thrown when the combination of parameters provided is not valid.
* @throws 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.
* @throws KmsKeyNotFoundException
* This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in
* the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not
* in the same Region.
* @throws KmsKeyDisabledException
* This exception is no longer in use.
* @throws KmsException
* This exception is thrown when there is an issue with the specified KMS key and the trail or event data
* store can't be updated.
* @throws InvalidCloudWatchLogsLogGroupArnException
* This exception is thrown when the provided CloudWatch Logs log group is not valid.
* @throws InvalidCloudWatchLogsRoleArnException
* This exception is thrown when the provided role is not valid.
* @throws CloudWatchLogsDeliveryUnavailableException
* Cannot set a CloudWatch Logs delivery for this Region.
* @throws UnsupportedOperationException
* This exception is thrown when the requested operation is not supported.
* @throws OperationNotPermittedException
* This exception is thrown when the requested operation is not permitted.
* @throws CloudTrailAccessNotEnabledException
* This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations.
* For more information, see Enabling
* Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
* @throws InsufficientDependencyServiceAccessPermissionException
* This exception is thrown when the IAM identity that is used to create the organization resource lacks one
* or more required permissions for creating an organization resource in a required service.
* @throws OrganizationsNotInUseException
* This exception is thrown when the request is made from an Amazon Web Services account that is not a
* member of an organization. To make this request, sign in using the credentials of an account that belongs
* to an organization.
* @throws NotOrganizationMasterAccountException
* This exception is thrown when the Amazon Web Services account making the request to create or update an
* organization trail or event data store is not the management account for an organization in
* Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an
* event data store.
* @throws OrganizationNotInAllFeaturesModeException
* This exception is thrown when Organizations is not configured to support all features. All features must
* be enabled in Organizations to support creating an organization trail or event data store.
* @throws NoManagementAccountSLRExistsException
* This exception is thrown when the management account does not have a service-linked role.
* @throws CloudTrailInvalidClientTokenIdException
* This exception is thrown when a call results in the InvalidClientTokenId
error code. This
* can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is
* in a suspended Amazon Web Services account.
* @throws InvalidParameterException
* The request includes a parameter that is not valid.
* @sample AWSCloudTrail.UpdateTrail
* @see AWS API
* Documentation
*/
@Override
public UpdateTrailResult updateTrail(UpdateTrailRequest request) {
request = beforeClientExecution(request);
return executeUpdateTrail(request);
}
@SdkInternalApi
final UpdateTrailResult executeUpdateTrail(UpdateTrailRequest updateTrailRequest) {
ExecutionContext executionContext = createExecutionContext(updateTrailRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request