@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CloudWatchLogsClient extends SdkClient
builder()
method.
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the Amazon Web Services 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 CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can 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_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AssociateKmsKeyResponse |
associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest)
Associates the specified Key Management Service customer master key (CMK) with the specified log group.
|
default AssociateKmsKeyResponse |
associateKmsKey(Consumer<AssociateKmsKeyRequest.Builder> associateKmsKeyRequest)
Associates the specified Key Management Service 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 DeleteQueryDefinitionResponse |
deleteQueryDefinition(Consumer<DeleteQueryDefinitionRequest.Builder> deleteQueryDefinitionRequest)
Deletes a saved CloudWatch Logs Insights query definition.
|
default DeleteQueryDefinitionResponse |
deleteQueryDefinition(DeleteQueryDefinitionRequest deleteQueryDefinitionRequest)
Deletes a saved CloudWatch Logs Insights query definition.
|
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 DescribeQueryDefinitionsResponse |
describeQueryDefinitions(Consumer<DescribeQueryDefinitionsRequest.Builder> describeQueryDefinitionsRequest)
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
|
default DescribeQueryDefinitionsResponse |
describeQueryDefinitions(DescribeQueryDefinitionsRequest describeQueryDefinitionsRequest)
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
|
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 Key Management Service customer master key (CMK) from the specified log group.
|
default DisassociateKmsKeyResponse |
disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest)
Disassociates the associated Key Management Service 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 of the fields and values of a single log event.
|
default GetLogRecordResponse |
getLogRecord(GetLogRecordRequest getLogRecordRequest)
Retrieves all of 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 PutQueryDefinitionResponse |
putQueryDefinition(Consumer<PutQueryDefinitionRequest.Builder> putQueryDefinitionRequest)
Creates or updates a query definition for CloudWatch Logs Insights.
|
default PutQueryDefinitionResponse |
putQueryDefinition(PutQueryDefinitionRequest putQueryDefinitionRequest)
Creates or updates a query definition for CloudWatch Logs Insights.
|
default PutResourcePolicyResponse |
putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
Creates or updates a resource policy allowing other Amazon Web Services 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 Amazon Web Services 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.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.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 Key Management Service customer master key (CMK) with the specified log group.
Associating an 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 CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.
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 receive
an InvalidParameterException
error.
associateKmsKeyRequest
- InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.OperationAbortedException
- Multiple concurrent 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.AwsServiceException
default AssociateKmsKeyResponse associateKmsKey(Consumer<AssociateKmsKeyRequest.Builder> associateKmsKeyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Associates the specified Key Management Service customer master key (CMK) with the specified log group.
Associating an 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 CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.
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 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 concurrent 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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. When
you perform a CreateExportTask
operation, you must use credentials that have permission to write to
the S3 bucket that you specify as the destination.
Exporting log data to Amazon S3 buckets that are encrypted by KMS is not supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is not supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
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.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log fild data by using Linux utilities.
createExportTaskRequest
- InvalidParameterException
- A parameter is specified incorrectly.LimitExceededException
- You have reached the maximum number of resources that can be created.OperationAbortedException
- Multiple concurrent 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.AwsServiceException
default 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. When
you perform a CreateExportTask
operation, you must use credentials that have permission to write to
the S3 bucket that you specify as the destination.
Exporting log data to Amazon S3 buckets that are encrypted by KMS is not supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is not supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
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.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log fild data by using Linux utilities.
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 concurrent 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.AwsServiceException
default 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 20,000 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 Amazon Web Services 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), '.' (period), and '#' (number sign)
When you create a log group, by default the log events in the log group never expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate a Key Management Service 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 CloudWatch Logs. This enables 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
receive an InvalidParameterException
error.
CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.
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 concurrent 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.AwsServiceException
default 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 20,000 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 Amazon Web Services 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), '.' (period), and '#' (number sign)
When you create a log group, by default the log events in the log group never expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate a Key Management Service 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 CloudWatch Logs. This enables 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
receive an InvalidParameterException
error.
CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.
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 concurrent 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.AwsServiceException
default CreateLogStreamResponse createLogStream(CreateLogStreamRequest createLogStreamRequest) throws InvalidParameterException, ResourceAlreadyExistsException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on
CreateLogStream
operations, after which transactions are throttled.
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.AwsServiceException
default CreateLogStreamResponse createLogStream(Consumer<CreateLogStreamRequest.Builder> createLogStreamRequest) throws InvalidParameterException, ResourceAlreadyExistsException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on
CreateLogStream
operations, after which transactions are throttled.
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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default DeleteQueryDefinitionResponse deleteQueryDefinition(DeleteQueryDefinitionRequest deleteQueryDefinitionRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each DeleteQueryDefinition
operation can delete one query definition.
You must have the logs:DeleteQueryDefinition
permission to be able to perform this operation.
deleteQueryDefinitionRequest
- 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.AwsServiceException
default DeleteQueryDefinitionResponse deleteQueryDefinition(Consumer<DeleteQueryDefinitionRequest.Builder> deleteQueryDefinitionRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each DeleteQueryDefinition
operation can delete one query definition.
You must have the logs:DeleteQueryDefinition
permission to be able to perform this operation.
This is a convenience which creates an instance of the DeleteQueryDefinitionRequest.Builder
avoiding the
need to create one manually via DeleteQueryDefinitionRequest.builder()
deleteQueryDefinitionRequest
- A Consumer
that will call methods on DeleteQueryDefinitionRequest.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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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.AwsServiceException
describeDestinations(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.AwsServiceException
default 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.AwsServiceException
default 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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
describeDestinationsPaginator(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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default 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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default 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.AwsServiceException
describeExportTasks(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.AwsServiceException
default 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.AwsServiceException
default 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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
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.AwsServiceException
describeLogGroups(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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
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.AwsServiceException
default 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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
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.AwsServiceException
default 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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
describeLogGroupsPaginator(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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default 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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default 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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default DescribeMetricFiltersResponse describeMetricFilters() throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all of 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.AwsServiceException
describeMetricFilters(DescribeMetricFiltersRequest)
,
AWS
API Documentationdefault DescribeMetricFiltersResponse describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all of 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.AwsServiceException
default DescribeMetricFiltersResponse describeMetricFilters(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all of 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.AwsServiceException
default DescribeMetricFiltersIterable describeMetricFiltersPaginator() throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all of 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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
describeMetricFiltersPaginator(DescribeMetricFiltersRequest)
,
AWS
API Documentationdefault DescribeMetricFiltersIterable describeMetricFiltersPaginator(DescribeMetricFiltersRequest describeMetricFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all of 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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default DescribeMetricFiltersIterable describeMetricFiltersPaginator(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all of 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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default 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.AwsServiceException
describeQueries(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.AwsServiceException
default 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.AwsServiceException
default DescribeQueryDefinitionsResponse describeQueryDefinitions(DescribeQueryDefinitionsRequest describeQueryDefinitionsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
You can use the queryDefinitionNamePrefix
parameter to limit the results to only the query
definitions that have names that start with a certain string.
describeQueryDefinitionsRequest
- 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.AwsServiceException
default DescribeQueryDefinitionsResponse describeQueryDefinitions(Consumer<DescribeQueryDefinitionsRequest.Builder> describeQueryDefinitionsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
You can use the queryDefinitionNamePrefix
parameter to limit the results to only the query
definitions that have names that start with a certain string.
This is a convenience which creates an instance of the DescribeQueryDefinitionsRequest.Builder
avoiding
the need to create one manually via DescribeQueryDefinitionsRequest.builder()
describeQueryDefinitionsRequest
- A Consumer
that will call methods on DescribeQueryDefinitionsRequest.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.AwsServiceException
default 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.AwsServiceException
describeResourcePolicies(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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default 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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default DisassociateKmsKeyResponse disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Disassociates the associated Key Management Service customer master key (CMK) from the specified log group.
After the KMS CMK is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and 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 concurrent 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.AwsServiceException
default DisassociateKmsKeyResponse disassociateKmsKey(Consumer<DisassociateKmsKeyRequest.Builder> disassociateKmsKeyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Disassociates the associated Key Management Service customer master key (CMK) from the specified log group.
After the KMS CMK is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and 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 concurrent 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.AwsServiceException
default 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. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
Logs, and the ID of the PutLogEvents
request.
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.AwsServiceException
default 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 operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
Logs, and the ID of the PutLogEvents
request.
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.AwsServiceException
default 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 operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
Logs, and the ID of the PutLogEvents
request.
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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default 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 operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
Logs, and the ID of the PutLogEvents
request.
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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default GetLogEventsResponse getLogEvents(GetLogEventsRequest getLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists log events from the specified log stream. You can list all of 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 operation can return empty results while there are more log events available through the token.
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.AwsServiceException
default 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 of 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 operation can return empty results while there are more log events available through the token.
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.AwsServiceException
default GetLogEventsIterable getLogEventsPaginator(GetLogEventsRequest getLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists log events from the specified log stream. You can list all of 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 operation can return empty results while there are more log events available through the token.
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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default 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 of 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 operation can return empty results while there are more log events available through the token.
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(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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.AwsServiceException
default 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. For more information about the fields that are
generated by CloudWatch logs, see Supported Logs and Discovered Fields.
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.AwsServiceException
default 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. For more information about the fields that are
generated by CloudWatch logs, see Supported Logs and Discovered Fields.
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.AwsServiceException
default GetLogRecordResponse getLogRecord(GetLogRecordRequest getLogRecordRequest) throws InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves all of 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.
The full 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.AwsServiceException
default GetLogRecordResponse getLogRecord(Consumer<GetLogRecordRequest.Builder> getLogRecordRequest) throws InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves all of 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.
The full 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.AwsServiceException
default GetQueryResultsResponse getQueryResults(GetQueryResultsRequest getQueryResultsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns the results from the specified query.
Only the fields requested in the query are returned, along with a @ptr
field, which is the
identifier for the log record. You can use the value of @ptr
in a GetLogRecord operation to get the full log record.
GetQueryResults
does not start a query execution. To run a query, use StartQuery.
If the value of the Status
field in the output is Running
, this operation returns only
partial results. If you see a value of Scheduled
or Running
for the status, you can
retry the operation later to see the final results.
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.AwsServiceException
default GetQueryResultsResponse getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns the results from the specified query.
Only the fields requested in the query are returned, along with a @ptr
field, which is the
identifier for the log record. You can use the value of @ptr
in a GetLogRecord operation to get the full log record.
GetQueryResults
does not start a query execution. To run a query, use StartQuery.
If the value of the Status
field in the output is Running
, this operation returns only
partial results. If you see a value of Scheduled
or Running
for the status, you can
retry the operation later to see the final results.
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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default PutDestinationResponse putDestination(PutDestinationRequest putDestinationRequest) throws InvalidParameterException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
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.
Through an access policy, a destination controls what is written to it. 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
.
To perform a PutDestination
operation, you must also have the iam:PassRole
permission.
putDestinationRequest
- InvalidParameterException
- A parameter is specified incorrectly.OperationAbortedException
- Multiple concurrent 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.AwsServiceException
default PutDestinationResponse putDestination(Consumer<PutDestinationRequest.Builder> putDestinationRequest) throws InvalidParameterException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
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.
Through an access policy, a destination controls what is written to it. 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
.
To perform a PutDestination
operation, you must also have the iam:PassRole
permission.
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 concurrent 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.AwsServiceException
default 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.
If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be listed
separately in the policy. The policy does not support specifying *
as the Principal or the use of
the aws:PrincipalOrgId
global key.
putDestinationPolicyRequest
- InvalidParameterException
- A parameter is specified incorrectly.OperationAbortedException
- Multiple concurrent 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.AwsServiceException
default 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.
If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be listed
separately in the policy. The policy does not support specifying *
as the Principal or the use of
the aws:PrincipalOrgId
global key.
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 concurrent 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.AwsServiceException
default 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 in the
expectedSequenceToken
field from InvalidSequenceTokenException
. If you call
PutLogEvents
twice within a narrow time period using the same value for sequenceToken
,
both calls might be successful or one might be rejected.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. 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 older than the retention period of the log group.
The log events in the batch must be in chronological order 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 Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
The maximum number of log events in a batch is 10,000.
There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.
If a call to PutLogEvents
returns "UnrecognizedClientException" the most likely cause is an invalid
Amazon Web Services access key ID or secret key.
putLogEventsRequest
- InvalidParameterException
- A parameter is specified incorrectly.InvalidSequenceTokenException
- The sequence token is not valid. You can get the correct sequence token in the
expectedSequenceToken
field in the InvalidSequenceTokenException
message.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 Amazon Web Services 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.AwsServiceException
default 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 in the
expectedSequenceToken
field from InvalidSequenceTokenException
. If you call
PutLogEvents
twice within a narrow time period using the same value for sequenceToken
,
both calls might be successful or one might be rejected.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. 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 older than the retention period of the log group.
The log events in the batch must be in chronological order 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 Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
The maximum number of log events in a batch is 10,000.
There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.
If a call to PutLogEvents
returns "UnrecognizedClientException" the most likely cause is an invalid
Amazon Web Services 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. You can get the correct sequence token in the
expectedSequenceToken
field in the InvalidSequenceTokenException
message.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 Amazon Web Services 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.AwsServiceException
default 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.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not
specify high-cardinality fields such as IPAddress
or requestID
as dimensions. Each
different value found for a dimension is treated as a separate metric and accrues charges as a separate custom
metric.
To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
putMetricFilterRequest
- InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.OperationAbortedException
- Multiple concurrent 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.AwsServiceException
default 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.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not
specify high-cardinality fields such as IPAddress
or requestID
as dimensions. Each
different value found for a dimension is treated as a separate metric and accrues charges as a separate custom
metric.
To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
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 concurrent 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.AwsServiceException
default PutQueryDefinitionResponse putQueryDefinition(PutQueryDefinitionRequest putQueryDefinitionRequest) throws InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its queryDefinitionId
in your request. The values of
name
, queryString
, and logGroupNames
are changed to the values that you
specify in your update operation. No current values are retained from the current query definition. For example,
if you update a current query definition that includes log groups, and you don't specify the
logGroupNames
parameter in your update operation, the query definition changes to contain no log
groups.
You must have the logs:PutQueryDefinition
permission to be able to perform this operation.
putQueryDefinitionRequest
- 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.AwsServiceException
default PutQueryDefinitionResponse putQueryDefinition(Consumer<PutQueryDefinitionRequest.Builder> putQueryDefinitionRequest) throws InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its queryDefinitionId
in your request. The values of
name
, queryString
, and logGroupNames
are changed to the values that you
specify in your update operation. No current values are retained from the current query definition. For example,
if you update a current query definition that includes log groups, and you don't specify the
logGroupNames
parameter in your update operation, the query definition changes to contain no log
groups.
You must have the logs:PutQueryDefinition
permission to be able to perform this operation.
This is a convenience which creates an instance of the PutQueryDefinitionRequest.Builder
avoiding the
need to create one manually via PutQueryDefinitionRequest.builder()
putQueryDefinitionRequest
- A Consumer
that will call methods on PutQueryDefinitionRequest.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.AwsServiceException
default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws InvalidParameterException, LimitExceededException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services 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.AwsServiceException
default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) throws InvalidParameterException, LimitExceededException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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 concurrent 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.AwsServiceException
default 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. When log events are sent to the receiving service, they are Base64 encoded and compressed with the gzip format.
The following destinations are supported for subscription filters:
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 Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with it. If you are updating an existing
filter, you must specify the correct name in filterName
.
To perform a PutSubscriptionFilter
operation, you must also have the iam:PassRole
permission.
putSubscriptionFilterRequest
- InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.OperationAbortedException
- Multiple concurrent 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.AwsServiceException
default 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. When log events are sent to the receiving service, they are Base64 encoded and compressed with the gzip format.
The following destinations are supported for subscription filters:
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 Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with it. If you are updating an existing
filter, you must specify the correct name in filterName
.
To perform a PutSubscriptionFilter
operation, you must also have the iam:PassRole
permission.
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 concurrent 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.AwsServiceException
default 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 and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
startQueryRequest
- MalformedQueryException
- The query string is not valid. Details about this error are displayed in a QueryCompileError
object. For more information, see QueryCompileError.
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.AwsServiceException
default 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 and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
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 QueryCompileError.
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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name
or aws:TagKeys
condition keys. For more information
about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
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.AwsServiceException
default 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.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name
or aws:TagKeys
condition keys. For more information
about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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 TagLogGroup.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name
or aws:TagKeys
condition keys.
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.AwsServiceException
default 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 TagLogGroup.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name
or aws:TagKeys
condition keys.
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.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.