@Generated(value="software.amazon.awssdk:codegen") public interface CloudWatchLogsClient extends SdkClient
builder() method.
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon EC2 instances, AWS CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
You can use CloudWatch Logs to:
Monitor logs from 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 that 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 CloudWatch metric that you specify.
Monitor AWS CloudTrail logged events: You can create alarms in 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateKmsKeyResponse |
associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest)
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log
group.
|
default AssociateKmsKeyResponse |
associateKmsKey(Consumer<AssociateKmsKeyRequest.Builder> associateKmsKeyRequest)
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log
group.
|
static CloudWatchLogsClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudWatchLogsClient. |
default CancelExportTaskResponse |
cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)
Cancels the specified export task.
|
default CancelExportTaskResponse |
cancelExportTask(Consumer<CancelExportTaskRequest.Builder> cancelExportTaskRequest)
Cancels the specified export task.
|
static CloudWatchLogsClient |
create()
Create a
CloudWatchLogsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateExportTaskResponse |
createExportTask(Consumer<CreateExportTaskRequest.Builder> createExportTaskRequest)
Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
|
default CreateExportTaskResponse |
createExportTask(CreateExportTaskRequest createExportTaskRequest)
Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
|
default CreateLogGroupResponse |
createLogGroup(Consumer<CreateLogGroupRequest.Builder> createLogGroupRequest)
Creates a log group with the specified name.
|
default CreateLogGroupResponse |
createLogGroup(CreateLogGroupRequest createLogGroupRequest)
Creates a log group with the specified name.
|
default CreateLogStreamResponse |
createLogStream(Consumer<CreateLogStreamRequest.Builder> createLogStreamRequest)
Creates a log stream for the specified log group.
|
default CreateLogStreamResponse |
createLogStream(CreateLogStreamRequest createLogStreamRequest)
Creates a log stream for the specified log group.
|
default DeleteDestinationResponse |
deleteDestination(Consumer<DeleteDestinationRequest.Builder> deleteDestinationRequest)
Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
|
default DeleteDestinationResponse |
deleteDestination(DeleteDestinationRequest deleteDestinationRequest)
Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
|
default DeleteLogGroupResponse |
deleteLogGroup(Consumer<DeleteLogGroupRequest.Builder> deleteLogGroupRequest)
Deletes the specified log group and permanently deletes all the archived log events associated with the log
group.
|
default DeleteLogGroupResponse |
deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest)
Deletes the specified log group and permanently deletes all the archived log events associated with the log
group.
|
default DeleteLogStreamResponse |
deleteLogStream(Consumer<DeleteLogStreamRequest.Builder> deleteLogStreamRequest)
Deletes the specified log stream and permanently deletes all the archived log events associated with the log
stream.
|
default DeleteLogStreamResponse |
deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest)
Deletes the specified log stream and permanently deletes all the archived log events associated with the log
stream.
|
default DeleteMetricFilterResponse |
deleteMetricFilter(Consumer<DeleteMetricFilterRequest.Builder> deleteMetricFilterRequest)
Deletes the specified metric filter.
|
default DeleteMetricFilterResponse |
deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest)
Deletes the specified metric filter.
|
default DeleteResourcePolicyResponse |
deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
Deletes a resource policy from this account.
|
default DeleteResourcePolicyResponse |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a resource policy from this account.
|
default DeleteRetentionPolicyResponse |
deleteRetentionPolicy(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest)
Deletes the specified retention policy.
|
default DeleteRetentionPolicyResponse |
deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
Deletes the specified retention policy.
|
default DeleteSubscriptionFilterResponse |
deleteSubscriptionFilter(Consumer<DeleteSubscriptionFilterRequest.Builder> deleteSubscriptionFilterRequest)
Deletes the specified subscription filter.
|
default DeleteSubscriptionFilterResponse |
deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)
Deletes the specified subscription filter.
|
default DescribeDestinationsResponse |
describeDestinations()
Lists all your destinations.
|
default DescribeDestinationsResponse |
describeDestinations(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest)
Lists all your destinations.
|
default DescribeDestinationsResponse |
describeDestinations(DescribeDestinationsRequest describeDestinationsRequest)
Lists all your destinations.
|
default DescribeDestinationsIterable |
describeDestinationsPaginator()
Lists all your destinations.
|
default DescribeDestinationsIterable |
describeDestinationsPaginator(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest)
Lists all your destinations.
|
default DescribeDestinationsIterable |
describeDestinationsPaginator(DescribeDestinationsRequest describeDestinationsRequest)
Lists all your destinations.
|
default DescribeExportTasksResponse |
describeExportTasks()
Lists the specified export tasks.
|
default DescribeExportTasksResponse |
describeExportTasks(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest)
Lists the specified export tasks.
|
default DescribeExportTasksResponse |
describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
Lists the specified export tasks.
|
default DescribeLogGroupsResponse |
describeLogGroups()
Lists the specified log groups.
|
default DescribeLogGroupsResponse |
describeLogGroups(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest)
Lists the specified log groups.
|
default DescribeLogGroupsResponse |
describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest)
Lists the specified log groups.
|
default DescribeLogGroupsIterable |
describeLogGroupsPaginator()
Lists the specified log groups.
|
default DescribeLogGroupsIterable |
describeLogGroupsPaginator(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest)
Lists the specified log groups.
|
default DescribeLogGroupsIterable |
describeLogGroupsPaginator(DescribeLogGroupsRequest describeLogGroupsRequest)
Lists the specified log groups.
|
default DescribeLogStreamsResponse |
describeLogStreams(Consumer<DescribeLogStreamsRequest.Builder> describeLogStreamsRequest)
Lists the log streams for the specified log group.
|
default DescribeLogStreamsResponse |
describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest)
Lists the log streams for the specified log group.
|
default DescribeLogStreamsIterable |
describeLogStreamsPaginator(Consumer<DescribeLogStreamsRequest.Builder> describeLogStreamsRequest)
Lists the log streams for the specified log group.
|
default DescribeLogStreamsIterable |
describeLogStreamsPaginator(DescribeLogStreamsRequest describeLogStreamsRequest)
Lists the log streams for the specified log group.
|
default DescribeMetricFiltersResponse |
describeMetricFilters()
Lists the specified metric filters.
|
default DescribeMetricFiltersResponse |
describeMetricFilters(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest)
Lists the specified metric filters.
|
default DescribeMetricFiltersResponse |
describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest)
Lists the specified metric filters.
|
default DescribeMetricFiltersIterable |
describeMetricFiltersPaginator()
Lists the specified metric filters.
|
default DescribeMetricFiltersIterable |
describeMetricFiltersPaginator(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest)
Lists the specified metric filters.
|
default DescribeMetricFiltersIterable |
describeMetricFiltersPaginator(DescribeMetricFiltersRequest describeMetricFiltersRequest)
Lists the specified metric filters.
|
default DescribeQueriesResponse |
describeQueries()
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently
in this account.
|
default DescribeQueriesResponse |
describeQueries(Consumer<DescribeQueriesRequest.Builder> describeQueriesRequest)
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently
in this account.
|
default DescribeQueriesResponse |
describeQueries(DescribeQueriesRequest describeQueriesRequest)
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently
in this account.
|
default DescribeResourcePoliciesResponse |
describeResourcePolicies()
Lists the resource policies in this account.
|
default DescribeResourcePoliciesResponse |
describeResourcePolicies(Consumer<DescribeResourcePoliciesRequest.Builder> describeResourcePoliciesRequest)
Lists the resource policies in this account.
|
default DescribeResourcePoliciesResponse |
describeResourcePolicies(DescribeResourcePoliciesRequest describeResourcePoliciesRequest)
Lists the resource policies in this account.
|
default DescribeSubscriptionFiltersResponse |
describeSubscriptionFilters(Consumer<DescribeSubscriptionFiltersRequest.Builder> describeSubscriptionFiltersRequest)
Lists the subscription filters for the specified log group.
|
default DescribeSubscriptionFiltersResponse |
describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)
Lists the subscription filters for the specified log group.
|
default DescribeSubscriptionFiltersIterable |
describeSubscriptionFiltersPaginator(Consumer<DescribeSubscriptionFiltersRequest.Builder> describeSubscriptionFiltersRequest)
Lists the subscription filters for the specified log group.
|
default DescribeSubscriptionFiltersIterable |
describeSubscriptionFiltersPaginator(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)
Lists the subscription filters for the specified log group.
|
default DisassociateKmsKeyResponse |
disassociateKmsKey(Consumer<DisassociateKmsKeyRequest.Builder> disassociateKmsKeyRequest)
Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified
log group.
|
default DisassociateKmsKeyResponse |
disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest)
Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified
log group.
|
default FilterLogEventsResponse |
filterLogEvents(Consumer<FilterLogEventsRequest.Builder> filterLogEventsRequest)
Lists log events from the specified log group.
|
default FilterLogEventsResponse |
filterLogEvents(FilterLogEventsRequest filterLogEventsRequest)
Lists log events from the specified log group.
|
default FilterLogEventsIterable |
filterLogEventsPaginator(Consumer<FilterLogEventsRequest.Builder> filterLogEventsRequest)
Lists log events from the specified log group.
|
default FilterLogEventsIterable |
filterLogEventsPaginator(FilterLogEventsRequest filterLogEventsRequest)
Lists log events from the specified log group.
|
default GetLogEventsResponse |
getLogEvents(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest)
Lists log events from the specified log stream.
|
default GetLogEventsResponse |
getLogEvents(GetLogEventsRequest getLogEventsRequest)
Lists log events from the specified log stream.
|
default GetLogEventsIterable |
getLogEventsPaginator(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest)
Lists log events from the specified log stream.
|
default GetLogEventsIterable |
getLogEventsPaginator(GetLogEventsRequest getLogEventsRequest)
Lists log events from the specified log stream.
|
default GetLogGroupFieldsResponse |
getLogGroupFields(Consumer<GetLogGroupFieldsRequest.Builder> getLogGroupFieldsRequest)
Returns a list of the fields that are included in log events in the specified log group, along with the
percentage of log events that contain each field.
|
default GetLogGroupFieldsResponse |
getLogGroupFields(GetLogGroupFieldsRequest getLogGroupFieldsRequest)
Returns a list of the fields that are included in log events in the specified log group, along with the
percentage of log events that contain each field.
|
default GetLogRecordResponse |
getLogRecord(Consumer<GetLogRecordRequest.Builder> getLogRecordRequest)
Retrieves all the fields and values of a single log event.
|
default GetLogRecordResponse |
getLogRecord(GetLogRecordRequest getLogRecordRequest)
Retrieves all the fields and values of a single log event.
|
default GetQueryResultsResponse |
getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
Returns the results from the specified query.
|
default GetQueryResultsResponse |
getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
Returns the results from the specified query.
|
default ListTagsLogGroupResponse |
listTagsLogGroup(Consumer<ListTagsLogGroupRequest.Builder> listTagsLogGroupRequest)
Lists the tags for the specified log group.
|
default ListTagsLogGroupResponse |
listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest)
Lists the tags for the specified log group.
|
default PutDestinationResponse |
putDestination(Consumer<PutDestinationRequest.Builder> putDestinationRequest)
Creates or updates a destination.
|
default PutDestinationResponse |
putDestination(PutDestinationRequest putDestinationRequest)
Creates or updates a destination.
|
default PutDestinationPolicyResponse |
putDestinationPolicy(Consumer<PutDestinationPolicyRequest.Builder> putDestinationPolicyRequest)
Creates or updates an access policy associated with an existing destination.
|
default PutDestinationPolicyResponse |
putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest)
Creates or updates an access policy associated with an existing destination.
|
default PutLogEventsResponse |
putLogEvents(Consumer<PutLogEventsRequest.Builder> putLogEventsRequest)
Uploads a batch of log events to the specified log stream.
|
default PutLogEventsResponse |
putLogEvents(PutLogEventsRequest putLogEventsRequest)
Uploads a batch of log events to the specified log stream.
|
default PutMetricFilterResponse |
putMetricFilter(Consumer<PutMetricFilterRequest.Builder> putMetricFilterRequest)
Creates or updates a metric filter and associates it with the specified log group.
|
default PutMetricFilterResponse |
putMetricFilter(PutMetricFilterRequest putMetricFilterRequest)
Creates or updates a metric filter and associates it with the specified log group.
|
default PutResourcePolicyResponse |
putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
Creates or updates a resource policy allowing other AWS services to put log events to this account, such as
Amazon Route 53.
|
default PutResourcePolicyResponse |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates a resource policy allowing other AWS services to put log events to this account, such as
Amazon Route 53.
|
default PutRetentionPolicyResponse |
putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest)
Sets the retention of the specified log group.
|
default PutRetentionPolicyResponse |
putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)
Sets the retention of the specified log group.
|
default PutSubscriptionFilterResponse |
putSubscriptionFilter(Consumer<PutSubscriptionFilterRequest.Builder> putSubscriptionFilterRequest)
Creates or updates a subscription filter and associates it with the specified log group.
|
default PutSubscriptionFilterResponse |
putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest)
Creates or updates a subscription filter and associates it with the specified log group.
|
static ServiceMetadata |
serviceMetadata() |
default StartQueryResponse |
startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest)
Schedules a query of a log group using CloudWatch Logs Insights.
|
default StartQueryResponse |
startQuery(StartQueryRequest startQueryRequest)
Schedules a query of a log group using CloudWatch Logs Insights.
|
default StopQueryResponse |
stopQuery(Consumer<StopQueryRequest.Builder> stopQueryRequest)
Stops a CloudWatch Logs Insights query that is in progress.
|
default StopQueryResponse |
stopQuery(StopQueryRequest stopQueryRequest)
Stops a CloudWatch Logs Insights query that is in progress.
|
default TagLogGroupResponse |
tagLogGroup(Consumer<TagLogGroupRequest.Builder> tagLogGroupRequest)
Adds or updates the specified tags for the specified log group.
|
default TagLogGroupResponse |
tagLogGroup(TagLogGroupRequest tagLogGroupRequest)
Adds or updates the specified tags for the specified log group.
|
default TestMetricFilterResponse |
testMetricFilter(Consumer<TestMetricFilterRequest.Builder> testMetricFilterRequest)
Tests the filter pattern of a metric filter against a sample of log event messages.
|
default TestMetricFilterResponse |
testMetricFilter(TestMetricFilterRequest testMetricFilterRequest)
Tests the filter pattern of a metric filter against a sample of log event messages.
|
default UntagLogGroupResponse |
untagLogGroup(Consumer<UntagLogGroupRequest.Builder> untagLogGroupRequest)
Removes the specified tags from the specified log group.
|
default UntagLogGroupResponse |
untagLogGroup(UntagLogGroupRequest untagLogGroupRequest)
Removes the specified tags from the specified log group.
|
serviceNameclosestatic final String SERVICE_NAME
static CloudWatchLogsClient create()
CloudWatchLogsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudWatchLogsClientBuilder builder()
CloudWatchLogsClient.default AssociateKmsKeyResponse associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.
Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
Note that it can take up to 5 minutes for this operation to take effect.
If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will
receive an InvalidParameterException error.
associateKmsKeyRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateKmsKeyResponse associateKmsKey(Consumer<AssociateKmsKeyRequest.Builder> associateKmsKeyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.
Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
Note that it can take up to 5 minutes for this operation to take effect.
If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will
receive an InvalidParameterException error.
This is a convenience which creates an instance of the AssociateKmsKeyRequest.Builder avoiding the need
to create one manually via AssociateKmsKeyRequest.builder()
associateKmsKeyRequest - A Consumer that will call methods on AssociateKmsKeyRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelExportTaskResponse cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidOperationException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Cancels the specified export task.
The task must be in the PENDING or RUNNING state.
cancelExportTaskRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.InvalidOperationException - The operation is not valid on the specified resource.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelExportTaskResponse cancelExportTask(Consumer<CancelExportTaskRequest.Builder> cancelExportTaskRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidOperationException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Cancels the specified export task.
The task must be in the PENDING or RUNNING state.
This is a convenience which creates an instance of the CancelExportTaskRequest.Builder avoiding the need
to create one manually via CancelExportTaskRequest.builder()
cancelExportTaskRequest - A Consumer that will call methods on CancelExportTaskRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.InvalidOperationException - The operation is not valid on the specified resource.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateExportTaskResponse createExportTask(CreateExportTaskRequest createExportTaskRequest) throws InvalidParameterException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, ResourceNotFoundException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
This is an asynchronous call. If all the required information is provided, this operation initiates an export
task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to
get the status of the export task. Each account can only have one active (RUNNING or
PENDING) export task at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
createExportTaskRequest - InvalidParameterException - A parameter is specified incorrectly.LimitExceededException - You have reached the maximum number of resources that can be created.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.ResourceNotFoundException - The specified resource does not exist.ResourceAlreadyExistsException - The specified resource already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateExportTaskResponse createExportTask(Consumer<CreateExportTaskRequest.Builder> createExportTaskRequest) throws InvalidParameterException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, ResourceNotFoundException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
This is an asynchronous call. If all the required information is provided, this operation initiates an export
task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to
get the status of the export task. Each account can only have one active (RUNNING or
PENDING) export task at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
This is a convenience which creates an instance of the CreateExportTaskRequest.Builder avoiding the need
to create one manually via CreateExportTaskRequest.builder()
createExportTaskRequest - A Consumer that will call methods on CreateExportTaskRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.LimitExceededException - You have reached the maximum number of resources that can be created.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.ResourceNotFoundException - The specified resource does not exist.ResourceAlreadyExistsException - The specified resource already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLogGroupResponse createLogGroup(CreateLogGroupRequest createLogGroupRequest) throws InvalidParameterException, ResourceAlreadyExistsException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates a log group with the specified name.
You can create up to 5000 log groups per account.
You must use the following guidelines when naming a log group:
Log group names must be unique within a region for an AWS account.
Log group names can be between 1 and 512 characters long.
Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will
receive an InvalidParameterException error.
createLogGroupRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - You have reached the maximum number of resources that can be created.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLogGroupResponse createLogGroup(Consumer<CreateLogGroupRequest.Builder> createLogGroupRequest) throws InvalidParameterException, ResourceAlreadyExistsException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates a log group with the specified name.
You can create up to 5000 log groups per account.
You must use the following guidelines when naming a log group:
Log group names must be unique within a region for an AWS account.
Log group names can be between 1 and 512 characters long.
Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will
receive an InvalidParameterException error.
This is a convenience which creates an instance of the CreateLogGroupRequest.Builder avoiding the need to
create one manually via CreateLogGroupRequest.builder()
createLogGroupRequest - A Consumer that will call methods on CreateLogGroupRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - You have reached the maximum number of resources that can be created.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLogStreamResponse createLogStream(CreateLogStreamRequest createLogStreamRequest) throws InvalidParameterException, ResourceAlreadyExistsException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates a log stream for the specified log group.
There is no limit on the number of log streams that you can create for a log group.
You must use the following guidelines when naming a log stream:
Log stream names must be unique within the log group.
Log stream names can be between 1 and 512 characters long.
The ':' (colon) and '*' (asterisk) characters are not allowed.
createLogStreamRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLogStreamResponse createLogStream(Consumer<CreateLogStreamRequest.Builder> createLogStreamRequest) throws InvalidParameterException, ResourceAlreadyExistsException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates a log stream for the specified log group.
There is no limit on the number of log streams that you can create for a log group.
You must use the following guidelines when naming a log stream:
Log stream names must be unique within the log group.
Log stream names can be between 1 and 512 characters long.
The ':' (colon) and '*' (asterisk) characters are not allowed.
This is a convenience which creates an instance of the CreateLogStreamRequest.Builder avoiding the need
to create one manually via CreateLogStreamRequest.builder()
createLogStreamRequest - A Consumer that will call methods on CreateLogStreamRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDestinationResponse deleteDestination(DeleteDestinationRequest deleteDestinationRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.
deleteDestinationRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDestinationResponse deleteDestination(Consumer<DeleteDestinationRequest.Builder> deleteDestinationRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.
This is a convenience which creates an instance of the DeleteDestinationRequest.Builder avoiding the need
to create one manually via DeleteDestinationRequest.builder()
deleteDestinationRequest - A Consumer that will call methods on DeleteDestinationRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLogGroupResponse deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
deleteLogGroupRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLogGroupResponse deleteLogGroup(Consumer<DeleteLogGroupRequest.Builder> deleteLogGroupRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
This is a convenience which creates an instance of the DeleteLogGroupRequest.Builder avoiding the need to
create one manually via DeleteLogGroupRequest.builder()
deleteLogGroupRequest - A Consumer that will call methods on DeleteLogGroupRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLogStreamResponse deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
deleteLogStreamRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLogStreamResponse deleteLogStream(Consumer<DeleteLogStreamRequest.Builder> deleteLogStreamRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
This is a convenience which creates an instance of the DeleteLogStreamRequest.Builder avoiding the need
to create one manually via DeleteLogStreamRequest.builder()
deleteLogStreamRequest - A Consumer that will call methods on DeleteLogStreamRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMetricFilterResponse deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified metric filter.
deleteMetricFilterRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMetricFilterResponse deleteMetricFilter(Consumer<DeleteMetricFilterRequest.Builder> deleteMetricFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified metric filter.
This is a convenience which creates an instance of the DeleteMetricFilterRequest.Builder avoiding the
need to create one manually via DeleteMetricFilterRequest.builder()
deleteMetricFilterRequest - A Consumer that will call methods on DeleteMetricFilterRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
deleteResourcePolicyRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the
need to create one manually via DeleteResourcePolicyRequest.builder()
deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRetentionPolicyResponse deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
deleteRetentionPolicyRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRetentionPolicyResponse deleteRetentionPolicy(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
This is a convenience which creates an instance of the DeleteRetentionPolicyRequest.Builder avoiding the
need to create one manually via DeleteRetentionPolicyRequest.builder()
deleteRetentionPolicyRequest - A Consumer that will call methods on DeleteRetentionPolicyRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSubscriptionFilterResponse deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified subscription filter.
deleteSubscriptionFilterRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSubscriptionFilterResponse deleteSubscriptionFilter(Consumer<DeleteSubscriptionFilterRequest.Builder> deleteSubscriptionFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified subscription filter.
This is a convenience which creates an instance of the DeleteSubscriptionFilterRequest.Builder avoiding
the need to create one manually via DeleteSubscriptionFilterRequest.builder()
deleteSubscriptionFilterRequest - A Consumer that will call methods on DeleteSubscriptionFilterRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDestinationsResponse describeDestinations() throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists all your destinations. The results are ASCII-sorted by destination name.
InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDestinations(DescribeDestinationsRequest),
AWS API
Documentationdefault DescribeDestinationsResponse describeDestinations(DescribeDestinationsRequest describeDestinationsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists all your destinations. The results are ASCII-sorted by destination name.
describeDestinationsRequest - InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDestinationsResponse describeDestinations(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists all your destinations. The results are ASCII-sorted by destination name.
This is a convenience which creates an instance of the DescribeDestinationsRequest.Builder avoiding the
need to create one manually via DescribeDestinationsRequest.builder()
describeDestinationsRequest - A Consumer that will call methods on DescribeDestinationsRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDestinationsIterable describeDestinationsPaginator() throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists all your destinations. The results are ASCII-sorted by destination name.
This is a variant of
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client.describeDestinationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client
.describeDestinationsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client.describeDestinationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation.
InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDestinationsPaginator(DescribeDestinationsRequest),
AWS API
Documentationdefault DescribeDestinationsIterable describeDestinationsPaginator(DescribeDestinationsRequest describeDestinationsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists all your destinations. The results are ASCII-sorted by destination name.
This is a variant of
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client.describeDestinationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client
.describeDestinationsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client.describeDestinationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation.
describeDestinationsRequest - InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDestinationsIterable describeDestinationsPaginator(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists all your destinations. The results are ASCII-sorted by destination name.
This is a variant of
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client.describeDestinationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client
.describeDestinationsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client.describeDestinationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation.
This is a convenience which creates an instance of the DescribeDestinationsRequest.Builder avoiding the
need to create one manually via DescribeDestinationsRequest.builder()
describeDestinationsRequest - A Consumer that will call methods on DescribeDestinationsRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeExportTasksResponse describeExportTasks() throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeExportTasks(DescribeExportTasksRequest),
AWS API
Documentationdefault DescribeExportTasksResponse describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
describeExportTasksRequest - InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeExportTasksResponse describeExportTasks(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
This is a convenience which creates an instance of the DescribeExportTasksRequest.Builder avoiding the
need to create one manually via DescribeExportTasksRequest.builder()
describeExportTasksRequest - A Consumer that will call methods on DescribeExportTasksRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLogGroupsResponse describeLogGroups() throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeLogGroups(DescribeLogGroupsRequest),
AWS API
Documentationdefault DescribeLogGroupsResponse describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
describeLogGroupsRequest - InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLogGroupsResponse describeLogGroups(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
This is a convenience which creates an instance of the DescribeLogGroupsRequest.Builder avoiding the need
to create one manually via DescribeLogGroupsRequest.builder()
describeLogGroupsRequest - A Consumer that will call methods on DescribeLogGroupsRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLogGroupsIterable describeLogGroupsPaginator() throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
This is a variant of
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client.describeLogGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client
.describeLogGroupsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client.describeLogGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation.
InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeLogGroupsPaginator(DescribeLogGroupsRequest),
AWS API
Documentationdefault DescribeLogGroupsIterable describeLogGroupsPaginator(DescribeLogGroupsRequest describeLogGroupsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
This is a variant of
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client.describeLogGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client
.describeLogGroupsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client.describeLogGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation.
describeLogGroupsRequest - InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLogGroupsIterable describeLogGroupsPaginator(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
This is a variant of
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client.describeLogGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client
.describeLogGroupsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client.describeLogGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeLogGroupsRequest.Builder avoiding the need
to create one manually via DescribeLogGroupsRequest.builder()
describeLogGroupsRequest - A Consumer that will call methods on DescribeLogGroupsRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLogStreamsResponse describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
This operation has a limit of five transactions per second, after which transactions are throttled.
describeLogStreamsRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLogStreamsResponse describeLogStreams(Consumer<DescribeLogStreamsRequest.Builder> describeLogStreamsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
This operation has a limit of five transactions per second, after which transactions are throttled.
This is a convenience which creates an instance of the DescribeLogStreamsRequest.Builder avoiding the
need to create one manually via DescribeLogStreamsRequest.builder()
describeLogStreamsRequest - A Consumer that will call methods on DescribeLogStreamsRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLogStreamsIterable describeLogStreamsPaginator(DescribeLogStreamsRequest describeLogStreamsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
This operation has a limit of five transactions per second, after which transactions are throttled.
This is a variant of
describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsIterable responses = client.describeLogStreamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsIterable responses = client
.describeLogStreamsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsIterable responses = client.describeLogStreamsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)
operation.
describeLogStreamsRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLogStreamsIterable describeLogStreamsPaginator(Consumer<DescribeLogStreamsRequest.Builder> describeLogStreamsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
This operation has a limit of five transactions per second, after which transactions are throttled.
This is a variant of
describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsIterable responses = client.describeLogStreamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsIterable responses = client
.describeLogStreamsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsIterable responses = client.describeLogStreamsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)
operation.
This is a convenience which creates an instance of the DescribeLogStreamsRequest.Builder avoiding the
need to create one manually via DescribeLogStreamsRequest.builder()
describeLogStreamsRequest - A Consumer that will call methods on DescribeLogStreamsRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMetricFiltersResponse describeMetricFilters() throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeMetricFilters(DescribeMetricFiltersRequest),
AWS API
Documentationdefault DescribeMetricFiltersResponse describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
describeMetricFiltersRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMetricFiltersResponse describeMetricFilters(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
This is a convenience which creates an instance of the DescribeMetricFiltersRequest.Builder avoiding the
need to create one manually via DescribeMetricFiltersRequest.builder()
describeMetricFiltersRequest - A Consumer that will call methods on DescribeMetricFiltersRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMetricFiltersIterable describeMetricFiltersPaginator() throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
This is a variant of
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client.describeMetricFiltersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client
.describeMetricFiltersPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client.describeMetricFiltersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation.
InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeMetricFiltersPaginator(DescribeMetricFiltersRequest),
AWS API
Documentationdefault DescribeMetricFiltersIterable describeMetricFiltersPaginator(DescribeMetricFiltersRequest describeMetricFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
This is a variant of
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client.describeMetricFiltersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client
.describeMetricFiltersPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client.describeMetricFiltersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation.
describeMetricFiltersRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMetricFiltersIterable describeMetricFiltersPaginator(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
This is a variant of
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client.describeMetricFiltersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client
.describeMetricFiltersPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client.describeMetricFiltersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation.
This is a convenience which creates an instance of the DescribeMetricFiltersRequest.Builder avoiding the
need to create one manually via DescribeMetricFiltersRequest.builder()
describeMetricFiltersRequest - A Consumer that will call methods on DescribeMetricFiltersRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeQueriesResponse describeQueries() throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all queries, or limit it to queries of a specific log group or queries with a certain status.
InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeQueries(DescribeQueriesRequest),
AWS API
Documentationdefault DescribeQueriesResponse describeQueries(DescribeQueriesRequest describeQueriesRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all queries, or limit it to queries of a specific log group or queries with a certain status.
describeQueriesRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeQueriesResponse describeQueries(Consumer<DescribeQueriesRequest.Builder> describeQueriesRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all queries, or limit it to queries of a specific log group or queries with a certain status.
This is a convenience which creates an instance of the DescribeQueriesRequest.Builder avoiding the need
to create one manually via DescribeQueriesRequest.builder()
describeQueriesRequest - A Consumer that will call methods on DescribeQueriesRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeResourcePoliciesResponse describeResourcePolicies() throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the resource policies in this account.
InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeResourcePolicies(DescribeResourcePoliciesRequest),
AWS
API Documentationdefault DescribeResourcePoliciesResponse describeResourcePolicies(DescribeResourcePoliciesRequest describeResourcePoliciesRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the resource policies in this account.
describeResourcePoliciesRequest - InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeResourcePoliciesResponse describeResourcePolicies(Consumer<DescribeResourcePoliciesRequest.Builder> describeResourcePoliciesRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the resource policies in this account.
This is a convenience which creates an instance of the DescribeResourcePoliciesRequest.Builder avoiding
the need to create one manually via DescribeResourcePoliciesRequest.builder()
describeResourcePoliciesRequest - A Consumer that will call methods on DescribeResourcePoliciesRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSubscriptionFiltersResponse describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.
describeSubscriptionFiltersRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSubscriptionFiltersResponse describeSubscriptionFilters(Consumer<DescribeSubscriptionFiltersRequest.Builder> describeSubscriptionFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.
This is a convenience which creates an instance of the DescribeSubscriptionFiltersRequest.Builder
avoiding the need to create one manually via DescribeSubscriptionFiltersRequest.builder()
describeSubscriptionFiltersRequest - A Consumer that will call methods on DescribeSubscriptionFiltersRequest.Builder to create
a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSubscriptionFiltersIterable describeSubscriptionFiltersPaginator(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.
This is a variant of
describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersIterable responses = client.describeSubscriptionFiltersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersIterable responses = client
.describeSubscriptionFiltersPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersIterable responses = client.describeSubscriptionFiltersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)
operation.
describeSubscriptionFiltersRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSubscriptionFiltersIterable describeSubscriptionFiltersPaginator(Consumer<DescribeSubscriptionFiltersRequest.Builder> describeSubscriptionFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.
This is a variant of
describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersIterable responses = client.describeSubscriptionFiltersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersIterable responses = client
.describeSubscriptionFiltersPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersIterable responses = client.describeSubscriptionFiltersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)
operation.
This is a convenience which creates an instance of the DescribeSubscriptionFiltersRequest.Builder
avoiding the need to create one manually via DescribeSubscriptionFiltersRequest.builder()
describeSubscriptionFiltersRequest - A Consumer that will call methods on DescribeSubscriptionFiltersRequest.Builder to create
a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateKmsKeyResponse disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.
After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.
Note that it can take up to 5 minutes for this operation to take effect.
disassociateKmsKeyRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateKmsKeyResponse disassociateKmsKey(Consumer<DisassociateKmsKeyRequest.Builder> disassociateKmsKeyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.
After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.
Note that it can take up to 5 minutes for this operation to take effect.
This is a convenience which creates an instance of the DisassociateKmsKeyRequest.Builder avoiding the
need to create one manually via DisassociateKmsKeyRequest.builder()
disassociateKmsKeyRequest - A Consumer that will call methods on DisassociateKmsKeyRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FilterLogEventsResponse filterLogEvents(FilterLogEventsRequest filterLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.
filterLogEventsRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FilterLogEventsResponse filterLogEvents(Consumer<FilterLogEventsRequest.Builder> filterLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.
This is a convenience which creates an instance of the FilterLogEventsRequest.Builder avoiding the need
to create one manually via FilterLogEventsRequest.builder()
filterLogEventsRequest - A Consumer that will call methods on FilterLogEventsRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FilterLogEventsIterable filterLogEventsPaginator(FilterLogEventsRequest filterLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.
This is a variant of
filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsIterable responses = client.filterLogEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsIterable responses = client
.filterLogEventsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsIterable responses = client.filterLogEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)
operation.
filterLogEventsRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FilterLogEventsIterable filterLogEventsPaginator(Consumer<FilterLogEventsRequest.Builder> filterLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.
This is a variant of
filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsIterable responses = client.filterLogEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsIterable responses = client
.filterLogEventsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsIterable responses = client.filterLogEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)
operation.
This is a convenience which creates an instance of the FilterLogEventsRequest.Builder avoiding the need
to create one manually via FilterLogEventsRequest.builder()
filterLogEventsRequest - A Consumer that will call methods on FilterLogEventsRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLogEventsResponse getLogEvents(GetLogEventsRequest getLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists log events from the specified log stream. You can list all the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.
getLogEventsRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLogEventsResponse getLogEvents(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists log events from the specified log stream. You can list all the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.
This is a convenience which creates an instance of the GetLogEventsRequest.Builder avoiding the need to
create one manually via GetLogEventsRequest.builder()
getLogEventsRequest - A Consumer that will call methods on GetLogEventsRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLogEventsIterable getLogEventsPaginator(GetLogEventsRequest getLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists log events from the specified log stream. You can list all the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.
This is a variant of
getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsIterable responses = client.getLogEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsIterable responses = client
.getLogEventsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsIterable responses = client.getLogEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest) operation.
getLogEventsRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLogEventsIterable getLogEventsPaginator(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists log events from the specified log stream. You can list all the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.
This is a variant of
getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsIterable responses = client.getLogEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsIterable responses = client
.getLogEventsPaginator(request);
for (software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsIterable responses = client.getLogEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest) operation.
This is a convenience which creates an instance of the GetLogEventsRequest.Builder avoiding the need to
create one manually via GetLogEventsRequest.builder()
getLogEventsRequest - A Consumer that will call methods on GetLogEventsRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLogGroupFieldsResponse getLogGroupFields(GetLogGroupFieldsRequest getLogGroupFieldsRequest) throws InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify.
In the results, fields that start with @ are fields generated by CloudWatch Logs. For example,
@timestamp is the timestamp of each log event.
The response results are sorted by the frequency percentage, starting with the highest percentage.
getLogGroupFieldsRequest - InvalidParameterException - A parameter is specified incorrectly.LimitExceededException - You have reached the maximum number of resources that can be created.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLogGroupFieldsResponse getLogGroupFields(Consumer<GetLogGroupFieldsRequest.Builder> getLogGroupFieldsRequest) throws InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify.
In the results, fields that start with @ are fields generated by CloudWatch Logs. For example,
@timestamp is the timestamp of each log event.
The response results are sorted by the frequency percentage, starting with the highest percentage.
This is a convenience which creates an instance of the GetLogGroupFieldsRequest.Builder avoiding the need
to create one manually via GetLogGroupFieldsRequest.builder()
getLogGroupFieldsRequest - A Consumer that will call methods on GetLogGroupFieldsRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.LimitExceededException - You have reached the maximum number of resources that can be created.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLogRecordResponse getLogRecord(GetLogRecordRequest getLogRecordRequest) throws InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves all the fields and values of a single log event. All fields are retrieved, even if the original query
that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field
name/field value pairs.
Additionally, the entire unparsed log event is returned within @message.
getLogRecordRequest - InvalidParameterException - A parameter is specified incorrectly.LimitExceededException - You have reached the maximum number of resources that can be created.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLogRecordResponse getLogRecord(Consumer<GetLogRecordRequest.Builder> getLogRecordRequest) throws InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves all the fields and values of a single log event. All fields are retrieved, even if the original query
that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field
name/field value pairs.
Additionally, the entire unparsed log event is returned within @message.
This is a convenience which creates an instance of the GetLogRecordRequest.Builder avoiding the need to
create one manually via GetLogRecordRequest.builder()
getLogRecordRequest - A Consumer that will call methods on GetLogRecordRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.LimitExceededException - You have reached the maximum number of resources that can be created.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryResultsResponse getQueryResults(GetQueryResultsRequest getQueryResultsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns the results from the specified query. If the query is in progress, partial results of that current execution are returned. Only the fields requested in the query are returned.
GetQueryResults does not start a query execution. To run a query, use .
getQueryResultsRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryResultsResponse getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns the results from the specified query. If the query is in progress, partial results of that current execution are returned. Only the fields requested in the query are returned.
GetQueryResults does not start a query execution. To run a query, use .
This is a convenience which creates an instance of the GetQueryResultsRequest.Builder avoiding the need
to create one manually via GetQueryResultsRequest.builder()
getQueryResultsRequest - A Consumer that will call methods on GetQueryResultsRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsLogGroupResponse listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest) throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the tags for the specified log group.
listTagsLogGroupRequest - ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsLogGroupResponse listTagsLogGroup(Consumer<ListTagsLogGroupRequest.Builder> listTagsLogGroupRequest) throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the tags for the specified log group.
This is a convenience which creates an instance of the ListTagsLogGroupRequest.Builder avoiding the need
to create one manually via ListTagsLogGroupRequest.builder()
listTagsLogGroupRequest - A Consumer that will call methods on ListTagsLogGroupRequest.Builder to create a request.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDestinationResponse putDestination(PutDestinationRequest putDestinationRequest) throws InvalidParameterException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination.
Through an access policy, a destination controls what is written to its Kinesis stream. By default,
PutDestination does not set any access policy with the destination, which means a cross-account user
cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must
call PutDestinationPolicy after PutDestination.
putDestinationRequest - InvalidParameterException - A parameter is specified incorrectly.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDestinationResponse putDestination(Consumer<PutDestinationRequest.Builder> putDestinationRequest) throws InvalidParameterException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination.
Through an access policy, a destination controls what is written to its Kinesis stream. By default,
PutDestination does not set any access policy with the destination, which means a cross-account user
cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must
call PutDestinationPolicy after PutDestination.
This is a convenience which creates an instance of the PutDestinationRequest.Builder avoiding the need to
create one manually via PutDestinationRequest.builder()
putDestinationRequest - A Consumer that will call methods on PutDestinationRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDestinationPolicyResponse putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest) throws InvalidParameterException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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.
putDestinationPolicyRequest - InvalidParameterException - A parameter is specified incorrectly.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDestinationPolicyResponse putDestinationPolicy(Consumer<PutDestinationPolicyRequest.Builder> putDestinationPolicyRequest) throws InvalidParameterException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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.
This is a convenience which creates an instance of the PutDestinationPolicyRequest.Builder avoiding the
need to create one manually via PutDestinationPolicyRequest.builder()
putDestinationPolicyRequest - A Consumer that will call methods on PutDestinationPolicyRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutLogEventsResponse putLogEvents(PutLogEventsRequest putLogEventsRequest) throws InvalidParameterException, InvalidSequenceTokenException, DataAlreadyAcceptedException, ResourceNotFoundException, ServiceUnavailableException, UnrecognizedClientException, AwsServiceException, SdkClientException, CloudWatchLogsException
Uploads a batch of log events to the specified log stream.
You must include the sequence token obtained from the response of the previous call. An upload in a newly created
log stream does not require a sequence token. You can also get the sequence token using
DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same
value for sequenceToken, both calls may be successful, or one may be rejected.
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 timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
The maximum number of log events in a batch is 10,000.
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.
putLogEventsRequest - InvalidParameterException - A parameter is specified incorrectly.InvalidSequenceTokenException - The sequence token is not valid.DataAlreadyAcceptedException - The event was already logged.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.UnrecognizedClientException - The most likely cause is an invalid AWS access key ID or secret key.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutLogEventsResponse putLogEvents(Consumer<PutLogEventsRequest.Builder> putLogEventsRequest) throws InvalidParameterException, InvalidSequenceTokenException, DataAlreadyAcceptedException, ResourceNotFoundException, ServiceUnavailableException, UnrecognizedClientException, AwsServiceException, SdkClientException, CloudWatchLogsException
Uploads a batch of log events to the specified log stream.
You must include the sequence token obtained from the response of the previous call. An upload in a newly created
log stream does not require a sequence token. You can also get the sequence token using
DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same
value for sequenceToken, both calls may be successful, or one may be rejected.
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 timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
The maximum number of log events in a batch is 10,000.
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.
This is a convenience which creates an instance of the PutLogEventsRequest.Builder avoiding the need to
create one manually via PutLogEventsRequest.builder()
putLogEventsRequest - A Consumer that will call methods on PutLogEventsRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.InvalidSequenceTokenException - The sequence token is not valid.DataAlreadyAcceptedException - The event was already logged.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.UnrecognizedClientException - The most likely cause is an invalid AWS access key ID or secret key.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutMetricFilterResponse putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, LimitExceededException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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.
The maximum number of metric filters that can be associated with a log group is 100.
putMetricFilterRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.LimitExceededException - You have reached the maximum number of resources that can be created.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutMetricFilterResponse putMetricFilter(Consumer<PutMetricFilterRequest.Builder> putMetricFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, LimitExceededException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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.
The maximum number of metric filters that can be associated with a log group is 100.
This is a convenience which creates an instance of the PutMetricFilterRequest.Builder avoiding the need
to create one manually via PutMetricFilterRequest.builder()
putMetricFilterRequest - A Consumer that will call methods on PutMetricFilterRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.LimitExceededException - You have reached the maximum number of resources that can be created.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws InvalidParameterException, LimitExceededException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per region.
putResourcePolicyRequest - InvalidParameterException - A parameter is specified incorrectly.LimitExceededException - You have reached the maximum number of resources that can be created.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) throws InvalidParameterException, LimitExceededException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per region.
This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need
to create one manually via PutResourcePolicyRequest.builder()
putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.LimitExceededException - You have reached the maximum number of resources that can be created.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRetentionPolicyResponse putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.
putRetentionPolicyRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRetentionPolicyResponse putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.
This is a convenience which creates an instance of the PutRetentionPolicyRequest.Builder avoiding the
need to create one manually via PutRetentionPolicyRequest.builder()
putRetentionPolicyRequest - A Consumer that will call methods on PutRetentionPolicyRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutSubscriptionFilterResponse putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, LimitExceededException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 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 that belongs to a different account, for cross-account delivery.
An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
There can only be one subscription filter associated with a log group. If you are updating an existing filter,
you must specify the correct name in filterName. Otherwise, the call fails because you cannot
associate a second filter with a log group.
putSubscriptionFilterRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.LimitExceededException - You have reached the maximum number of resources that can be created.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutSubscriptionFilterResponse putSubscriptionFilter(Consumer<PutSubscriptionFilterRequest.Builder> putSubscriptionFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, LimitExceededException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 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 that belongs to a different account, for cross-account delivery.
An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
There can only be one subscription filter associated with a log group. If you are updating an existing filter,
you must specify the correct name in filterName. Otherwise, the call fails because you cannot
associate a second filter with a log group.
This is a convenience which creates an instance of the PutSubscriptionFilterRequest.Builder avoiding the
need to create one manually via PutSubscriptionFilterRequest.builder()
putSubscriptionFilterRequest - A Consumer that will call methods on PutSubscriptionFilterRequest.Builder to create a
request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.LimitExceededException - You have reached the maximum number of resources that can be created.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartQueryResponse startQuery(StartQueryRequest startQueryRequest) throws MalformedQueryException, InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group to query, the query string to use, and the time to query.
For more information, see CloudWatch Logs Insights Query Syntax.
startQueryRequest - MalformedQueryException - The query string is not valid. Details about this error are displayed in a QueryCompileError
object. For more information, see .
For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.
InvalidParameterException - A parameter is specified incorrectly.LimitExceededException - You have reached the maximum number of resources that can be created.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartQueryResponse startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest) throws MalformedQueryException, InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group to query, the query string to use, and the time to query.
For more information, see CloudWatch Logs Insights Query Syntax.
This is a convenience which creates an instance of the StartQueryRequest.Builder avoiding the need to
create one manually via StartQueryRequest.builder()
startQueryRequest - A Consumer that will call methods on StartQueryRequest.Builder to create a request.MalformedQueryException - The query string is not valid. Details about this error are displayed in a QueryCompileError
object. For more information, see .
For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.
InvalidParameterException - A parameter is specified incorrectly.LimitExceededException - You have reached the maximum number of resources that can be created.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopQueryResponse stopQuery(StopQueryRequest stopQueryRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.
stopQueryRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopQueryResponse stopQuery(Consumer<StopQueryRequest.Builder> stopQueryRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.
This is a convenience which creates an instance of the StopQueryRequest.Builder avoiding the need to
create one manually via StopQueryRequest.builder()
stopQueryRequest - A Consumer that will call methods on StopQueryRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagLogGroupResponse tagLogGroup(TagLogGroupRequest tagLogGroupRequest) throws ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, CloudWatchLogsException
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
tagLogGroupRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter is specified incorrectly.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagLogGroupResponse tagLogGroup(Consumer<TagLogGroupRequest.Builder> tagLogGroupRequest) throws ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, CloudWatchLogsException
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
This is a convenience which creates an instance of the TagLogGroupRequest.Builder avoiding the need to
create one manually via TagLogGroupRequest.builder()
tagLogGroupRequest - A Consumer that will call methods on TagLogGroupRequest.Builder to create a request.ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter is specified incorrectly.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestMetricFilterResponse testMetricFilter(TestMetricFilterRequest testMetricFilterRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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.
testMetricFilterRequest - InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestMetricFilterResponse testMetricFilter(Consumer<TestMetricFilterRequest.Builder> testMetricFilterRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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.
This is a convenience which creates an instance of the TestMetricFilterRequest.Builder avoiding the need
to create one manually via TestMetricFilterRequest.builder()
testMetricFilterRequest - A Consumer that will call methods on TestMetricFilterRequest.Builder to create a request.InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagLogGroupResponse untagLogGroup(UntagLogGroupRequest untagLogGroupRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchLogsException
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.
untagLogGroupRequest - ResourceNotFoundException - The specified resource does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagLogGroupResponse untagLogGroup(Consumer<UntagLogGroupRequest.Builder> untagLogGroupRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchLogsException
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.
This is a convenience which creates an instance of the UntagLogGroupRequest.Builder avoiding the need to
create one manually via UntagLogGroupRequest.builder()
untagLogGroupRequest - A Consumer that will call methods on UntagLogGroupRequest.Builder to create a request.ResourceNotFoundException - The specified resource does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchLogsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.