Interface AWSCloudTrailAsync

  • All Superinterfaces:
    AWSCloudTrail
    All Known Implementing Classes:
    AbstractAWSCloudTrailAsync, AWSCloudTrailAsyncClient

    public interface AWSCloudTrailAsync
    extends AWSCloudTrail
    Interface for accessing CloudTrail asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

    AWS CloudTrail

    This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

    CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.

    As an alternative to the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

    See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.

    • Method Detail

      • addTagsAsync

        Future<AddTagsResult> addTagsAsync​(AddTagsRequest addTagsRequest)

        Adds one or more tags to a trail, up to a limit of 10. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region).

        Parameters:
        addTagsRequest - Specifies the tags to add to a trail.
        Returns:
        A Java Future containing the result of the AddTags operation returned by the service.
      • addTagsAsync

        Future<AddTagsResult> addTagsAsync​(AddTagsRequest addTagsRequest,
                                           AsyncHandler<AddTagsRequest,​AddTagsResult> asyncHandler)

        Adds one or more tags to a trail, up to a limit of 10. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region).

        Parameters:
        addTagsRequest - Specifies the tags to add to a trail.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the AddTags operation returned by the service.
      • createTrailAsync

        Future<CreateTrailResult> createTrailAsync​(CreateTrailRequest createTrailRequest)

        Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.

        Parameters:
        createTrailRequest - Specifies the settings for each trail.
        Returns:
        A Java Future containing the result of the CreateTrail operation returned by the service.
      • createTrailAsync

        Future<CreateTrailResult> createTrailAsync​(CreateTrailRequest createTrailRequest,
                                                   AsyncHandler<CreateTrailRequest,​CreateTrailResult> asyncHandler)

        Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.

        Parameters:
        createTrailRequest - Specifies the settings for each trail.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the CreateTrail operation returned by the service.
      • deleteTrailAsync

        Future<DeleteTrailResult> deleteTrailAsync​(DeleteTrailRequest deleteTrailRequest)

        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.

        Parameters:
        deleteTrailRequest - The request that specifies the name of a trail to delete.
        Returns:
        A Java Future containing the result of the DeleteTrail operation returned by the service.
      • deleteTrailAsync

        Future<DeleteTrailResult> deleteTrailAsync​(DeleteTrailRequest deleteTrailRequest,
                                                   AsyncHandler<DeleteTrailRequest,​DeleteTrailResult> asyncHandler)

        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.

        Parameters:
        deleteTrailRequest - The request that specifies the name of a trail to delete.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DeleteTrail operation returned by the service.
      • describeTrailsAsync

        Future<DescribeTrailsResult> describeTrailsAsync​(DescribeTrailsRequest describeTrailsRequest)

        Retrieves settings for the trail associated with the current region for your account.

        Parameters:
        describeTrailsRequest - Returns information about the trail.
        Returns:
        A Java Future containing the result of the DescribeTrails operation returned by the service.
      • describeTrailsAsync

        Future<DescribeTrailsResult> describeTrailsAsync​(DescribeTrailsRequest describeTrailsRequest,
                                                         AsyncHandler<DescribeTrailsRequest,​DescribeTrailsResult> asyncHandler)

        Retrieves settings for the trail associated with the current region for your account.

        Parameters:
        describeTrailsRequest - Returns information about the trail.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DescribeTrails operation returned by the service.
      • getTrailStatusAsync

        Future<GetTrailStatusResult> getTrailStatusAsync​(GetTrailStatusRequest getTrailStatusRequest)

        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.

        Parameters:
        getTrailStatusRequest - The name of a trail about which you want the current status.
        Returns:
        A Java Future containing the result of the GetTrailStatus operation returned by the service.
      • getTrailStatusAsync

        Future<GetTrailStatusResult> getTrailStatusAsync​(GetTrailStatusRequest getTrailStatusRequest,
                                                         AsyncHandler<GetTrailStatusRequest,​GetTrailStatusResult> asyncHandler)

        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.

        Parameters:
        getTrailStatusRequest - The name of a trail about which you want the current status.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the GetTrailStatus operation returned by the service.
      • listPublicKeysAsync

        Future<ListPublicKeysResult> listPublicKeysAsync​(ListPublicKeysRequest listPublicKeysRequest)

        Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

        CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.

        Parameters:
        listPublicKeysRequest - Requests the public keys for a specified time range.
        Returns:
        A Java Future containing the result of the ListPublicKeys operation returned by the service.
      • listPublicKeysAsync

        Future<ListPublicKeysResult> listPublicKeysAsync​(ListPublicKeysRequest listPublicKeysRequest,
                                                         AsyncHandler<ListPublicKeysRequest,​ListPublicKeysResult> asyncHandler)

        Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

        CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.

        Parameters:
        listPublicKeysRequest - Requests the public keys for a specified time range.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListPublicKeys operation returned by the service.
      • listTagsAsync

        Future<ListTagsResult> listTagsAsync​(ListTagsRequest listTagsRequest)

        Lists the tags for the trail in the current region.

        Parameters:
        listTagsRequest - Specifies a list of trail tags to return.
        Returns:
        A Java Future containing the result of the ListTags operation returned by the service.
      • listTagsAsync

        Future<ListTagsResult> listTagsAsync​(ListTagsRequest listTagsRequest,
                                             AsyncHandler<ListTagsRequest,​ListTagsResult> asyncHandler)

        Lists the tags for the trail in the current region.

        Parameters:
        listTagsRequest - Specifies a list of trail tags to return.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListTags operation returned by the service.
      • lookupEventsAsync

        Future<LookupEventsResult> lookupEventsAsync​(LookupEventsRequest lookupEventsRequest)

        Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

        The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

        Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

        Parameters:
        lookupEventsRequest - Contains a request for LookupEvents.
        Returns:
        A Java Future containing the result of the LookupEvents operation returned by the service.
      • lookupEventsAsync

        Future<LookupEventsResult> lookupEventsAsync​(LookupEventsRequest lookupEventsRequest,
                                                     AsyncHandler<LookupEventsRequest,​LookupEventsResult> asyncHandler)

        Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

        The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

        Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

        Parameters:
        lookupEventsRequest - Contains a request for LookupEvents.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the LookupEvents operation returned by the service.
      • removeTagsAsync

        Future<RemoveTagsResult> removeTagsAsync​(RemoveTagsRequest removeTagsRequest)

        Removes the specified tags from a trail.

        Parameters:
        removeTagsRequest - Specifies the tags to remove from a trail.
        Returns:
        A Java Future containing the result of the RemoveTags operation returned by the service.
      • removeTagsAsync

        Future<RemoveTagsResult> removeTagsAsync​(RemoveTagsRequest removeTagsRequest,
                                                 AsyncHandler<RemoveTagsRequest,​RemoveTagsResult> asyncHandler)

        Removes the specified tags from a trail.

        Parameters:
        removeTagsRequest - Specifies the tags to remove from a trail.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the RemoveTags operation returned by the service.
      • startLoggingAsync

        Future<StartLoggingResult> startLoggingAsync​(StartLoggingRequest startLoggingRequest)

        Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

        Parameters:
        startLoggingRequest - The request to CloudTrail to start logging AWS API calls for an account.
        Returns:
        A Java Future containing the result of the StartLogging operation returned by the service.
      • startLoggingAsync

        Future<StartLoggingResult> startLoggingAsync​(StartLoggingRequest startLoggingRequest,
                                                     AsyncHandler<StartLoggingRequest,​StartLoggingResult> asyncHandler)

        Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

        Parameters:
        startLoggingRequest - The request to CloudTrail to start logging AWS API calls for an account.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the StartLogging operation returned by the service.
      • stopLoggingAsync

        Future<StopLoggingResult> stopLoggingAsync​(StopLoggingRequest stopLoggingRequest)

        Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

        Parameters:
        stopLoggingRequest - Passes the request to CloudTrail to stop logging AWS API calls for the specified account.
        Returns:
        A Java Future containing the result of the StopLogging operation returned by the service.
      • stopLoggingAsync

        Future<StopLoggingResult> stopLoggingAsync​(StopLoggingRequest stopLoggingRequest,
                                                   AsyncHandler<StopLoggingRequest,​StopLoggingResult> asyncHandler)

        Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

        Parameters:
        stopLoggingRequest - Passes the request to CloudTrail to stop logging AWS API calls for the specified account.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the StopLogging operation returned by the service.
      • updateTrailAsync

        Future<UpdateTrailResult> updateTrailAsync​(UpdateTrailRequest updateTrailRequest)

        Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

        Parameters:
        updateTrailRequest - Specifies settings to update for the trail.
        Returns:
        A Java Future containing the result of the UpdateTrail operation returned by the service.
      • updateTrailAsync

        Future<UpdateTrailResult> updateTrailAsync​(UpdateTrailRequest updateTrailRequest,
                                                   AsyncHandler<UpdateTrailRequest,​UpdateTrailResult> asyncHandler)

        Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

        Parameters:
        updateTrailRequest - Specifies settings to update for the trail.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the UpdateTrail operation returned by the service.