Interface AWSLogsAsync

  • All Superinterfaces:
    AWSLogs
    All Known Implementing Classes:
    AbstractAWSLogsAsync, AWSLogsAsyncClient

    public interface AWSLogsAsync
    extends AWSLogs
    Interface for accessing Amazon CloudWatch Logs 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.

    Amazon CloudWatch Logs API Reference

    You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon Elastic Compute Cloud (Amazon EC2) instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK.

    You can use CloudWatch Logs to:

    • Monitor Logs from Amazon EC2 Instances in Real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify.

    • Monitor Amazon CloudTrail Logged Events: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.

    • Archive Log Data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

    • Method Detail

      • cancelExportTaskAsync

        Future<CancelExportTaskResult> cancelExportTaskAsync​(CancelExportTaskRequest cancelExportTaskRequest)

        Cancels an export task if it is in PENDING or RUNNING state.

        Parameters:
        cancelExportTaskRequest -
        Returns:
        A Java Future containing the result of the CancelExportTask operation returned by the service.
      • cancelExportTaskAsync

        Future<CancelExportTaskResult> cancelExportTaskAsync​(CancelExportTaskRequest cancelExportTaskRequest,
                                                             AsyncHandler<CancelExportTaskRequest,​CancelExportTaskResult> asyncHandler)

        Cancels an export task if it is in PENDING or RUNNING state.

        Parameters:
        cancelExportTaskRequest -
        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 CancelExportTask operation returned by the service.
      • createExportTaskAsync

        Future<CreateExportTaskResult> createExportTaskAsync​(CreateExportTaskRequest createExportTaskRequest)

        Creates an ExportTask which allows you to efficiently export data from a Log Group to your Amazon S3 bucket.

        This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, DescribeExportTasks can be used to get the status of an export task. You can only have one active ( RUNNING or PENDING) export task at a time, per account.

        You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects.

        Parameters:
        createExportTaskRequest -
        Returns:
        A Java Future containing the result of the CreateExportTask operation returned by the service.
      • createExportTaskAsync

        Future<CreateExportTaskResult> createExportTaskAsync​(CreateExportTaskRequest createExportTaskRequest,
                                                             AsyncHandler<CreateExportTaskRequest,​CreateExportTaskResult> asyncHandler)

        Creates an ExportTask which allows you to efficiently export data from a Log Group to your Amazon S3 bucket.

        This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, DescribeExportTasks can be used to get the status of an export task. You can only have one active ( RUNNING or PENDING) export task at a time, per account.

        You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects.

        Parameters:
        createExportTaskRequest -
        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 CreateExportTask operation returned by the service.
      • createLogGroupAsync

        Future<CreateLogGroupResult> createLogGroupAsync​(CreateLogGroupRequest createLogGroupRequest)

        Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.

        You must use the following guidelines when naming a log group:

        • Log group names can be between 1 and 512 characters long.
        • Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

        Parameters:
        createLogGroupRequest -
        Returns:
        A Java Future containing the result of the CreateLogGroup operation returned by the service.
      • createLogGroupAsync

        Future<CreateLogGroupResult> createLogGroupAsync​(CreateLogGroupRequest createLogGroupRequest,
                                                         AsyncHandler<CreateLogGroupRequest,​CreateLogGroupResult> asyncHandler)

        Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.

        You must use the following guidelines when naming a log group:

        • Log group names can be between 1 and 512 characters long.
        • Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

        Parameters:
        createLogGroupRequest -
        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 CreateLogGroup operation returned by the service.
      • createLogStreamAsync

        Future<CreateLogStreamResult> createLogStreamAsync​(CreateLogStreamRequest createLogStreamRequest)

        Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.

        You must use the following guidelines when naming a log stream:

        • Log stream names can be between 1 and 512 characters long.
        • The ':' colon character is not allowed.

        Parameters:
        createLogStreamRequest -
        Returns:
        A Java Future containing the result of the CreateLogStream operation returned by the service.
      • createLogStreamAsync

        Future<CreateLogStreamResult> createLogStreamAsync​(CreateLogStreamRequest createLogStreamRequest,
                                                           AsyncHandler<CreateLogStreamRequest,​CreateLogStreamResult> asyncHandler)

        Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.

        You must use the following guidelines when naming a log stream:

        • Log stream names can be between 1 and 512 characters long.
        • The ':' colon character is not allowed.

        Parameters:
        createLogStreamRequest -
        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 CreateLogStream operation returned by the service.
      • deleteDestinationAsync

        Future<DeleteDestinationResult> deleteDestinationAsync​(DeleteDestinationRequest deleteDestinationRequest)

        Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination.

        Parameters:
        deleteDestinationRequest -
        Returns:
        A Java Future containing the result of the DeleteDestination operation returned by the service.
      • deleteDestinationAsync

        Future<DeleteDestinationResult> deleteDestinationAsync​(DeleteDestinationRequest deleteDestinationRequest,
                                                               AsyncHandler<DeleteDestinationRequest,​DeleteDestinationResult> asyncHandler)

        Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination.

        Parameters:
        deleteDestinationRequest -
        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 DeleteDestination operation returned by the service.
      • deleteLogGroupAsync

        Future<DeleteLogGroupResult> deleteLogGroupAsync​(DeleteLogGroupRequest deleteLogGroupRequest)

        Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.

        Parameters:
        deleteLogGroupRequest -
        Returns:
        A Java Future containing the result of the DeleteLogGroup operation returned by the service.
      • deleteLogGroupAsync

        Future<DeleteLogGroupResult> deleteLogGroupAsync​(DeleteLogGroupRequest deleteLogGroupRequest,
                                                         AsyncHandler<DeleteLogGroupRequest,​DeleteLogGroupResult> asyncHandler)

        Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.

        Parameters:
        deleteLogGroupRequest -
        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 DeleteLogGroup operation returned by the service.
      • deleteLogStreamAsync

        Future<DeleteLogStreamResult> deleteLogStreamAsync​(DeleteLogStreamRequest deleteLogStreamRequest)

        Deletes a log stream and permanently deletes all the archived log events associated with it.

        Parameters:
        deleteLogStreamRequest -
        Returns:
        A Java Future containing the result of the DeleteLogStream operation returned by the service.
      • deleteLogStreamAsync

        Future<DeleteLogStreamResult> deleteLogStreamAsync​(DeleteLogStreamRequest deleteLogStreamRequest,
                                                           AsyncHandler<DeleteLogStreamRequest,​DeleteLogStreamResult> asyncHandler)

        Deletes a log stream and permanently deletes all the archived log events associated with it.

        Parameters:
        deleteLogStreamRequest -
        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 DeleteLogStream operation returned by the service.
      • deleteMetricFilterAsync

        Future<DeleteMetricFilterResult> deleteMetricFilterAsync​(DeleteMetricFilterRequest deleteMetricFilterRequest)

        Deletes a metric filter associated with the specified log group.

        Parameters:
        deleteMetricFilterRequest -
        Returns:
        A Java Future containing the result of the DeleteMetricFilter operation returned by the service.
      • deleteMetricFilterAsync

        Future<DeleteMetricFilterResult> deleteMetricFilterAsync​(DeleteMetricFilterRequest deleteMetricFilterRequest,
                                                                 AsyncHandler<DeleteMetricFilterRequest,​DeleteMetricFilterResult> asyncHandler)

        Deletes a metric filter associated with the specified log group.

        Parameters:
        deleteMetricFilterRequest -
        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 DeleteMetricFilter operation returned by the service.
      • deleteRetentionPolicyAsync

        Future<DeleteRetentionPolicyResult> deleteRetentionPolicyAsync​(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)

        Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.

        Parameters:
        deleteRetentionPolicyRequest -
        Returns:
        A Java Future containing the result of the DeleteRetentionPolicy operation returned by the service.
      • deleteRetentionPolicyAsync

        Future<DeleteRetentionPolicyResult> deleteRetentionPolicyAsync​(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest,
                                                                       AsyncHandler<DeleteRetentionPolicyRequest,​DeleteRetentionPolicyResult> asyncHandler)

        Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.

        Parameters:
        deleteRetentionPolicyRequest -
        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 DeleteRetentionPolicy operation returned by the service.
      • deleteSubscriptionFilterAsync

        Future<DeleteSubscriptionFilterResult> deleteSubscriptionFilterAsync​(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)

        Deletes a subscription filter associated with the specified log group.

        Parameters:
        deleteSubscriptionFilterRequest -
        Returns:
        A Java Future containing the result of the DeleteSubscriptionFilter operation returned by the service.
      • deleteSubscriptionFilterAsync

        Future<DeleteSubscriptionFilterResult> deleteSubscriptionFilterAsync​(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest,
                                                                             AsyncHandler<DeleteSubscriptionFilterRequest,​DeleteSubscriptionFilterResult> asyncHandler)

        Deletes a subscription filter associated with the specified log group.

        Parameters:
        deleteSubscriptionFilterRequest -
        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 DeleteSubscriptionFilter operation returned by the service.
      • describeDestinationsAsync

        Future<DescribeDestinationsResult> describeDestinationsAsync​(DescribeDestinationsRequest describeDestinationsRequest)

        Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name.

        By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a nextToken value in the response body. You can also limit the number of destinations returned in the response by specifying the limit parameter in the request.

        Parameters:
        describeDestinationsRequest -
        Returns:
        A Java Future containing the result of the DescribeDestinations operation returned by the service.
      • describeDestinationsAsync

        Future<DescribeDestinationsResult> describeDestinationsAsync​(DescribeDestinationsRequest describeDestinationsRequest,
                                                                     AsyncHandler<DescribeDestinationsRequest,​DescribeDestinationsResult> asyncHandler)

        Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name.

        By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a nextToken value in the response body. You can also limit the number of destinations returned in the response by specifying the limit parameter in the request.

        Parameters:
        describeDestinationsRequest -
        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 DescribeDestinations operation returned by the service.
      • describeExportTasksAsync

        Future<DescribeExportTasksResult> describeExportTasksAsync​(DescribeExportTasksRequest describeExportTasksRequest)

        Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on TaskId or TaskStatus.

        By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a nextToken value in the response body. You can also limit the number of export tasks returned in the response by specifying the limit parameter in the request.

        Parameters:
        describeExportTasksRequest -
        Returns:
        A Java Future containing the result of the DescribeExportTasks operation returned by the service.
      • describeExportTasksAsync

        Future<DescribeExportTasksResult> describeExportTasksAsync​(DescribeExportTasksRequest describeExportTasksRequest,
                                                                   AsyncHandler<DescribeExportTasksRequest,​DescribeExportTasksResult> asyncHandler)

        Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on TaskId or TaskStatus.

        By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a nextToken value in the response body. You can also limit the number of export tasks returned in the response by specifying the limit parameter in the request.

        Parameters:
        describeExportTasksRequest -
        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 DescribeExportTasks operation returned by the service.
      • describeLogGroupsAsync

        Future<DescribeLogGroupsResult> describeLogGroupsAsync​(DescribeLogGroupsRequest describeLogGroupsRequest)

        Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.

        By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a nextToken value in the response body. You can also limit the number of log groups returned in the response by specifying the limit parameter in the request.

        Parameters:
        describeLogGroupsRequest -
        Returns:
        A Java Future containing the result of the DescribeLogGroups operation returned by the service.
      • describeLogGroupsAsync

        Future<DescribeLogGroupsResult> describeLogGroupsAsync​(DescribeLogGroupsRequest describeLogGroupsRequest,
                                                               AsyncHandler<DescribeLogGroupsRequest,​DescribeLogGroupsResult> asyncHandler)

        Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.

        By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a nextToken value in the response body. You can also limit the number of log groups returned in the response by specifying the limit parameter in the request.

        Parameters:
        describeLogGroupsRequest -
        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 DescribeLogGroups operation returned by the service.
      • describeLogStreamsAsync

        Future<DescribeLogStreamsResult> describeLogStreamsAsync​(DescribeLogStreamsRequest describeLogStreamsRequest)

        Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.

        By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled.

        Parameters:
        describeLogStreamsRequest -
        Returns:
        A Java Future containing the result of the DescribeLogStreams operation returned by the service.
      • describeLogStreamsAsync

        Future<DescribeLogStreamsResult> describeLogStreamsAsync​(DescribeLogStreamsRequest describeLogStreamsRequest,
                                                                 AsyncHandler<DescribeLogStreamsRequest,​DescribeLogStreamsResult> asyncHandler)

        Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.

        By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled.

        Parameters:
        describeLogStreamsRequest -
        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 DescribeLogStreams operation returned by the service.
      • describeMetricFiltersAsync

        Future<DescribeMetricFiltersResult> describeMetricFiltersAsync​(DescribeMetricFiltersRequest describeMetricFiltersRequest)

        Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

        By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a nextToken value in the response body. You can also limit the number of metric filters returned in the response by specifying the limit parameter in the request.

        Parameters:
        describeMetricFiltersRequest -
        Returns:
        A Java Future containing the result of the DescribeMetricFilters operation returned by the service.
      • describeMetricFiltersAsync

        Future<DescribeMetricFiltersResult> describeMetricFiltersAsync​(DescribeMetricFiltersRequest describeMetricFiltersRequest,
                                                                       AsyncHandler<DescribeMetricFiltersRequest,​DescribeMetricFiltersResult> asyncHandler)

        Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

        By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a nextToken value in the response body. You can also limit the number of metric filters returned in the response by specifying the limit parameter in the request.

        Parameters:
        describeMetricFiltersRequest -
        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 DescribeMetricFilters operation returned by the service.
      • describeSubscriptionFiltersAsync

        Future<DescribeSubscriptionFiltersResult> describeSubscriptionFiltersAsync​(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)

        Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

        By default, this operation returns up to 50 subscription filters. If there are more subscription filters to list, the response would contain a nextToken value in the response body. You can also limit the number of subscription filters returned in the response by specifying the limit parameter in the request.

        Parameters:
        describeSubscriptionFiltersRequest -
        Returns:
        A Java Future containing the result of the DescribeSubscriptionFilters operation returned by the service.
      • describeSubscriptionFiltersAsync

        Future<DescribeSubscriptionFiltersResult> describeSubscriptionFiltersAsync​(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest,
                                                                                   AsyncHandler<DescribeSubscriptionFiltersRequest,​DescribeSubscriptionFiltersResult> asyncHandler)

        Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

        By default, this operation returns up to 50 subscription filters. If there are more subscription filters to list, the response would contain a nextToken value in the response body. You can also limit the number of subscription filters returned in the response by specifying the limit parameter in the request.

        Parameters:
        describeSubscriptionFiltersRequest -
        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 DescribeSubscriptionFilters operation returned by the service.
      • filterLogEventsAsync

        Future<FilterLogEventsResult> filterLogEventsAsync​(FilterLogEventsRequest filterLogEventsRequest)

        Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event timestamp. You can limit the streams searched to an explicit list of logStreamNames.

        By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a nextToken, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of searchedLogStreams that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The limit parameter in the request. can be used to specify the maximum number of events to return in a page.

        Parameters:
        filterLogEventsRequest -
        Returns:
        A Java Future containing the result of the FilterLogEvents operation returned by the service.
      • filterLogEventsAsync

        Future<FilterLogEventsResult> filterLogEventsAsync​(FilterLogEventsRequest filterLogEventsRequest,
                                                           AsyncHandler<FilterLogEventsRequest,​FilterLogEventsResult> asyncHandler)

        Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event timestamp. You can limit the streams searched to an explicit list of logStreamNames.

        By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a nextToken, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of searchedLogStreams that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The limit parameter in the request. can be used to specify the maximum number of events to return in a page.

        Parameters:
        filterLogEventsRequest -
        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 FilterLogEvents operation returned by the service.
      • getLogEventsAsync

        Future<GetLogEventsResult> getLogEventsAsync​(GetLogEventsRequest getLogEventsRequest)

        Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp.

        By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.

        Parameters:
        getLogEventsRequest -
        Returns:
        A Java Future containing the result of the GetLogEvents operation returned by the service.
      • getLogEventsAsync

        Future<GetLogEventsResult> getLogEventsAsync​(GetLogEventsRequest getLogEventsRequest,
                                                     AsyncHandler<GetLogEventsRequest,​GetLogEventsResult> asyncHandler)

        Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp.

        By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.

        Parameters:
        getLogEventsRequest -
        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 GetLogEvents operation returned by the service.
      • putDestinationAsync

        Future<PutDestinationResult> putDestinationAsync​(PutDestinationRequest putDestinationRequest)

        Creates or updates a Destination. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through PutLogEvents requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination.

        A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call PutSubscriptionFilter against this destination. To enable that, the destination owner must call PutDestinationPolicy after PutDestination.

        Parameters:
        putDestinationRequest -
        Returns:
        A Java Future containing the result of the PutDestination operation returned by the service.
      • putDestinationAsync

        Future<PutDestinationResult> putDestinationAsync​(PutDestinationRequest putDestinationRequest,
                                                         AsyncHandler<PutDestinationRequest,​PutDestinationResult> asyncHandler)

        Creates or updates a Destination. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through PutLogEvents requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination.

        A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call PutSubscriptionFilter against this destination. To enable that, the destination owner must call PutDestinationPolicy after PutDestination.

        Parameters:
        putDestinationRequest -
        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 PutDestination operation returned by the service.
      • putDestinationPolicyAsync

        Future<PutDestinationPolicyResult> putDestinationPolicyAsync​(PutDestinationPolicyRequest putDestinationPolicyRequest)

        Creates or updates an access policy associated with an existing Destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.

        Parameters:
        putDestinationPolicyRequest -
        Returns:
        A Java Future containing the result of the PutDestinationPolicy operation returned by the service.
      • putDestinationPolicyAsync

        Future<PutDestinationPolicyResult> putDestinationPolicyAsync​(PutDestinationPolicyRequest putDestinationPolicyRequest,
                                                                     AsyncHandler<PutDestinationPolicyRequest,​PutDestinationPolicyResult> asyncHandler)

        Creates or updates an access policy associated with an existing Destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.

        Parameters:
        putDestinationPolicyRequest -
        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 PutDestinationPolicy operation returned by the service.
      • putLogEventsAsync

        Future<PutLogEventsResult> putLogEventsAsync​(PutLogEventsRequest putLogEventsRequest)

        Uploads a batch of log events to the specified log stream.

        Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request. An upload in a newly created log stream does not require a sequenceToken.

        The batch of events must satisfy the following constraints:

        • The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
        • None of the log events in the batch can be more than 2 hours in the future.
        • None of the log events in the batch can be older than 14 days or the retention period of the log group.
        • The log events in the batch must be in chronological ordered by their timestamp.
        • The maximum number of log events in a batch is 10,000.
        • A batch of log events in a single PutLogEvents request cannot span more than 24 hours. Otherwise, the PutLogEvents operation will fail.

        Parameters:
        putLogEventsRequest -
        Returns:
        A Java Future containing the result of the PutLogEvents operation returned by the service.
      • putLogEventsAsync

        Future<PutLogEventsResult> putLogEventsAsync​(PutLogEventsRequest putLogEventsRequest,
                                                     AsyncHandler<PutLogEventsRequest,​PutLogEventsResult> asyncHandler)

        Uploads a batch of log events to the specified log stream.

        Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request. An upload in a newly created log stream does not require a sequenceToken.

        The batch of events must satisfy the following constraints:

        • The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
        • None of the log events in the batch can be more than 2 hours in the future.
        • None of the log events in the batch can be older than 14 days or the retention period of the log group.
        • The log events in the batch must be in chronological ordered by their timestamp.
        • The maximum number of log events in a batch is 10,000.
        • A batch of log events in a single PutLogEvents request cannot span more than 24 hours. Otherwise, the PutLogEvents operation will fail.

        Parameters:
        putLogEventsRequest -
        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 PutLogEvents operation returned by the service.
      • putMetricFilterAsync

        Future<PutMetricFilterResult> putMetricFilterAsync​(PutMetricFilterRequest putMetricFilterRequest)

        Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents requests.

        The maximum number of metric filters that can be associated with a log group is 100.

        Parameters:
        putMetricFilterRequest -
        Returns:
        A Java Future containing the result of the PutMetricFilter operation returned by the service.
      • putMetricFilterAsync

        Future<PutMetricFilterResult> putMetricFilterAsync​(PutMetricFilterRequest putMetricFilterRequest,
                                                           AsyncHandler<PutMetricFilterRequest,​PutMetricFilterResult> asyncHandler)

        Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents requests.

        The maximum number of metric filters that can be associated with a log group is 100.

        Parameters:
        putMetricFilterRequest -
        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 PutMetricFilter operation returned by the service.
      • putRetentionPolicyAsync

        Future<PutRetentionPolicyResult> putRetentionPolicyAsync​(PutRetentionPolicyRequest putRetentionPolicyRequest)

        Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.

        Parameters:
        putRetentionPolicyRequest -
        Returns:
        A Java Future containing the result of the PutRetentionPolicy operation returned by the service.
      • putRetentionPolicyAsync

        Future<PutRetentionPolicyResult> putRetentionPolicyAsync​(PutRetentionPolicyRequest putRetentionPolicyRequest,
                                                                 AsyncHandler<PutRetentionPolicyRequest,​PutRetentionPolicyResult> asyncHandler)

        Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.

        Parameters:
        putRetentionPolicyRequest -
        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 PutRetentionPolicy operation returned by the service.
      • putSubscriptionFilterAsync

        Future<PutSubscriptionFilterResult> putSubscriptionFilterAsync​(PutSubscriptionFilterRequest putSubscriptionFilterRequest)

        Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents requests and have them delivered to a specific destination. Currently, the supported destinations are:

        • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
        • A logical destination (used via an ARN of Destination) belonging to a different account, for cross-account delivery.
        • An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery.
        • An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

        Currently there can only be one subscription filter associated with a log group.

        Parameters:
        putSubscriptionFilterRequest -
        Returns:
        A Java Future containing the result of the PutSubscriptionFilter operation returned by the service.
      • putSubscriptionFilterAsync

        Future<PutSubscriptionFilterResult> putSubscriptionFilterAsync​(PutSubscriptionFilterRequest putSubscriptionFilterRequest,
                                                                       AsyncHandler<PutSubscriptionFilterRequest,​PutSubscriptionFilterResult> asyncHandler)

        Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents requests and have them delivered to a specific destination. Currently, the supported destinations are:

        • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
        • A logical destination (used via an ARN of Destination) belonging to a different account, for cross-account delivery.
        • An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery.
        • An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

        Currently there can only be one subscription filter associated with a log group.

        Parameters:
        putSubscriptionFilterRequest -
        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 PutSubscriptionFilter operation returned by the service.
      • testMetricFilterAsync

        Future<TestMetricFilterResult> testMetricFilterAsync​(TestMetricFilterRequest testMetricFilterRequest)

        Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

        Parameters:
        testMetricFilterRequest -
        Returns:
        A Java Future containing the result of the TestMetricFilter operation returned by the service.
      • testMetricFilterAsync

        Future<TestMetricFilterResult> testMetricFilterAsync​(TestMetricFilterRequest testMetricFilterRequest,
                                                             AsyncHandler<TestMetricFilterRequest,​TestMetricFilterResult> asyncHandler)

        Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

        Parameters:
        testMetricFilterRequest -
        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 TestMetricFilter operation returned by the service.