Interface CloudWatchLogsClient
-
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CloudWatchLogsClient extends AwsClient
Service client for accessing Amazon CloudWatch Logs. This can be created using the staticbuilder()
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. Alternatively, you can use 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. Then, it can 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"). You can also 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 earlier than this setting are automatically deleted. The CloudWatch Logs agent helps 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.
-
-
Field Summary
Fields Modifier and Type Field Description static String
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.static String
SERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Deprecated Methods Modifier and Type Method Description default AssociateKmsKeyResponse
associateKmsKey(Consumer<AssociateKmsKeyRequest.Builder> associateKmsKeyRequest)
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.default AssociateKmsKeyResponse
associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest)
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.static CloudWatchLogsClientBuilder
builder()
Create a builder that can be used to configure and create aCloudWatchLogsClient
.default CancelExportTaskResponse
cancelExportTask(Consumer<CancelExportTaskRequest.Builder> cancelExportTaskRequest)
Cancels the specified export task.default CancelExportTaskResponse
cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)
Cancels the specified export task.static CloudWatchLogsClient
create()
Create aCloudWatchLogsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateDeliveryResponse
createDelivery(Consumer<CreateDeliveryRequest.Builder> createDeliveryRequest)
Creates a delivery.default CreateDeliveryResponse
createDelivery(CreateDeliveryRequest createDeliveryRequest)
Creates a delivery.default CreateExportTaskResponse
createExportTask(Consumer<CreateExportTaskRequest.Builder> createExportTaskRequest)
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket.default CreateExportTaskResponse
createExportTask(CreateExportTaskRequest createExportTaskRequest)
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket.default CreateLogAnomalyDetectorResponse
createLogAnomalyDetector(Consumer<CreateLogAnomalyDetectorRequest.Builder> createLogAnomalyDetectorRequest)
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.default CreateLogAnomalyDetectorResponse
createLogAnomalyDetector(CreateLogAnomalyDetectorRequest createLogAnomalyDetectorRequest)
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.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 DeleteAccountPolicyResponse
deleteAccountPolicy(Consumer<DeleteAccountPolicyRequest.Builder> deleteAccountPolicyRequest)
Deletes a CloudWatch Logs account policy.default DeleteAccountPolicyResponse
deleteAccountPolicy(DeleteAccountPolicyRequest deleteAccountPolicyRequest)
Deletes a CloudWatch Logs account policy.default DeleteDataProtectionPolicyResponse
deleteDataProtectionPolicy(Consumer<DeleteDataProtectionPolicyRequest.Builder> deleteDataProtectionPolicyRequest)
Deletes the data protection policy from the specified log group.default DeleteDataProtectionPolicyResponse
deleteDataProtectionPolicy(DeleteDataProtectionPolicyRequest deleteDataProtectionPolicyRequest)
Deletes the data protection policy from the specified log group.default DeleteDeliveryResponse
deleteDelivery(Consumer<DeleteDeliveryRequest.Builder> deleteDeliveryRequest)
Deletes s delivery.default DeleteDeliveryResponse
deleteDelivery(DeleteDeliveryRequest deleteDeliveryRequest)
Deletes s delivery.default DeleteDeliveryDestinationResponse
deleteDeliveryDestination(Consumer<DeleteDeliveryDestinationRequest.Builder> deleteDeliveryDestinationRequest)
Deletes a delivery destination.default DeleteDeliveryDestinationResponse
deleteDeliveryDestination(DeleteDeliveryDestinationRequest deleteDeliveryDestinationRequest)
Deletes a delivery destination.default DeleteDeliveryDestinationPolicyResponse
deleteDeliveryDestinationPolicy(Consumer<DeleteDeliveryDestinationPolicyRequest.Builder> deleteDeliveryDestinationPolicyRequest)
Deletes a delivery destination policy.default DeleteDeliveryDestinationPolicyResponse
deleteDeliveryDestinationPolicy(DeleteDeliveryDestinationPolicyRequest deleteDeliveryDestinationPolicyRequest)
Deletes a delivery destination policy.default DeleteDeliverySourceResponse
deleteDeliverySource(Consumer<DeleteDeliverySourceRequest.Builder> deleteDeliverySourceRequest)
Deletes a delivery source.default DeleteDeliverySourceResponse
deleteDeliverySource(DeleteDeliverySourceRequest deleteDeliverySourceRequest)
Deletes a delivery source.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 DeleteIndexPolicyResponse
deleteIndexPolicy(Consumer<DeleteIndexPolicyRequest.Builder> deleteIndexPolicyRequest)
Deletes a log-group level field index policy that was applied to a single log group.default DeleteIndexPolicyResponse
deleteIndexPolicy(DeleteIndexPolicyRequest deleteIndexPolicyRequest)
Deletes a log-group level field index policy that was applied to a single log group.default DeleteIntegrationResponse
deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest)
Deletes the integration between CloudWatch Logs and OpenSearch Service.default DeleteIntegrationResponse
deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Deletes the integration between CloudWatch Logs and OpenSearch Service.default DeleteLogAnomalyDetectorResponse
deleteLogAnomalyDetector(Consumer<DeleteLogAnomalyDetectorRequest.Builder> deleteLogAnomalyDetectorRequest)
Deletes the specified CloudWatch Logs anomaly detector.default DeleteLogAnomalyDetectorResponse
deleteLogAnomalyDetector(DeleteLogAnomalyDetectorRequest deleteLogAnomalyDetectorRequest)
Deletes the specified CloudWatch Logs anomaly detector.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 DeleteTransformerResponse
deleteTransformer(Consumer<DeleteTransformerRequest.Builder> deleteTransformerRequest)
Deletes the log transformer for the specified log group.default DeleteTransformerResponse
deleteTransformer(DeleteTransformerRequest deleteTransformerRequest)
Deletes the log transformer for the specified log group.default DescribeAccountPoliciesResponse
describeAccountPolicies(Consumer<DescribeAccountPoliciesRequest.Builder> describeAccountPoliciesRequest)
Returns a list of all CloudWatch Logs account policies in the account.default DescribeAccountPoliciesResponse
describeAccountPolicies(DescribeAccountPoliciesRequest describeAccountPoliciesRequest)
Returns a list of all CloudWatch Logs account policies in the account.default DescribeConfigurationTemplatesResponse
describeConfigurationTemplates(Consumer<DescribeConfigurationTemplatesRequest.Builder> describeConfigurationTemplatesRequest)
Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries.default DescribeConfigurationTemplatesResponse
describeConfigurationTemplates(DescribeConfigurationTemplatesRequest describeConfigurationTemplatesRequest)
Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries.default DescribeConfigurationTemplatesIterable
describeConfigurationTemplatesPaginator(Consumer<DescribeConfigurationTemplatesRequest.Builder> describeConfigurationTemplatesRequest)
This is a variant ofdescribeConfigurationTemplates(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeConfigurationTemplatesRequest)
operation.default DescribeConfigurationTemplatesIterable
describeConfigurationTemplatesPaginator(DescribeConfigurationTemplatesRequest describeConfigurationTemplatesRequest)
This is a variant ofdescribeConfigurationTemplates(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeConfigurationTemplatesRequest)
operation.default DescribeDeliveriesResponse
describeDeliveries(Consumer<DescribeDeliveriesRequest.Builder> describeDeliveriesRequest)
Retrieves a list of the deliveries that have been created in the account.default DescribeDeliveriesResponse
describeDeliveries(DescribeDeliveriesRequest describeDeliveriesRequest)
Retrieves a list of the deliveries that have been created in the account.default DescribeDeliveriesIterable
describeDeliveriesPaginator(Consumer<DescribeDeliveriesRequest.Builder> describeDeliveriesRequest)
This is a variant ofdescribeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest)
operation.default DescribeDeliveriesIterable
describeDeliveriesPaginator(DescribeDeliveriesRequest describeDeliveriesRequest)
This is a variant ofdescribeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest)
operation.default DescribeDeliveryDestinationsResponse
describeDeliveryDestinations(Consumer<DescribeDeliveryDestinationsRequest.Builder> describeDeliveryDestinationsRequest)
Retrieves a list of the delivery destinations that have been created in the account.default DescribeDeliveryDestinationsResponse
describeDeliveryDestinations(DescribeDeliveryDestinationsRequest describeDeliveryDestinationsRequest)
Retrieves a list of the delivery destinations that have been created in the account.default DescribeDeliveryDestinationsIterable
describeDeliveryDestinationsPaginator(Consumer<DescribeDeliveryDestinationsRequest.Builder> describeDeliveryDestinationsRequest)
This is a variant ofdescribeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest)
operation.default DescribeDeliveryDestinationsIterable
describeDeliveryDestinationsPaginator(DescribeDeliveryDestinationsRequest describeDeliveryDestinationsRequest)
This is a variant ofdescribeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest)
operation.default DescribeDeliverySourcesResponse
describeDeliverySources(Consumer<DescribeDeliverySourcesRequest.Builder> describeDeliverySourcesRequest)
Retrieves a list of the delivery sources that have been created in the account.default DescribeDeliverySourcesResponse
describeDeliverySources(DescribeDeliverySourcesRequest describeDeliverySourcesRequest)
Retrieves a list of the delivery sources that have been created in the account.default DescribeDeliverySourcesIterable
describeDeliverySourcesPaginator(Consumer<DescribeDeliverySourcesRequest.Builder> describeDeliverySourcesRequest)
This is a variant ofdescribeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest)
operation.default DescribeDeliverySourcesIterable
describeDeliverySourcesPaginator(DescribeDeliverySourcesRequest describeDeliverySourcesRequest)
This is a variant ofdescribeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest)
operation.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()
This is a variant ofdescribeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation.default DescribeDestinationsIterable
describeDestinationsPaginator(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest)
This is a variant ofdescribeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation.default DescribeDestinationsIterable
describeDestinationsPaginator(DescribeDestinationsRequest describeDestinationsRequest)
This is a variant ofdescribeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation.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 DescribeFieldIndexesResponse
describeFieldIndexes(Consumer<DescribeFieldIndexesRequest.Builder> describeFieldIndexesRequest)
Returns a list of field indexes listed in the field index policies of one or more log groups.default DescribeFieldIndexesResponse
describeFieldIndexes(DescribeFieldIndexesRequest describeFieldIndexesRequest)
Returns a list of field indexes listed in the field index policies of one or more log groups.default DescribeIndexPoliciesResponse
describeIndexPolicies(Consumer<DescribeIndexPoliciesRequest.Builder> describeIndexPoliciesRequest)
Returns the field index policies of one or more log groups.default DescribeIndexPoliciesResponse
describeIndexPolicies(DescribeIndexPoliciesRequest describeIndexPoliciesRequest)
Returns the field index policies of one or more log groups.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()
This is a variant ofdescribeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation.default DescribeLogGroupsIterable
describeLogGroupsPaginator(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest)
This is a variant ofdescribeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation.default DescribeLogGroupsIterable
describeLogGroupsPaginator(DescribeLogGroupsRequest describeLogGroupsRequest)
This is a variant ofdescribeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation.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)
This is a variant ofdescribeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)
operation.default DescribeLogStreamsIterable
describeLogStreamsPaginator(DescribeLogStreamsRequest describeLogStreamsRequest)
This is a variant ofdescribeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)
operation.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()
This is a variant ofdescribeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation.default DescribeMetricFiltersIterable
describeMetricFiltersPaginator(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest)
This is a variant ofdescribeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation.default DescribeMetricFiltersIterable
describeMetricFiltersPaginator(DescribeMetricFiltersRequest describeMetricFiltersRequest)
This is a variant ofdescribeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation.default DescribeQueriesResponse
describeQueries()
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account.default DescribeQueriesResponse
describeQueries(Consumer<DescribeQueriesRequest.Builder> describeQueriesRequest)
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account.default DescribeQueriesResponse
describeQueries(DescribeQueriesRequest describeQueriesRequest)
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run 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)
This is a variant ofdescribeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)
operation.default DescribeSubscriptionFiltersIterable
describeSubscriptionFiltersPaginator(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)
This is a variant ofdescribeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)
operation.default DisassociateKmsKeyResponse
disassociateKmsKey(Consumer<DisassociateKmsKeyRequest.Builder> disassociateKmsKeyRequest)
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.default DisassociateKmsKeyResponse
disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest)
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.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)
This is a variant offilterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)
operation.default FilterLogEventsIterable
filterLogEventsPaginator(FilterLogEventsRequest filterLogEventsRequest)
This is a variant offilterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)
operation.default GetDataProtectionPolicyResponse
getDataProtectionPolicy(Consumer<GetDataProtectionPolicyRequest.Builder> getDataProtectionPolicyRequest)
Returns information about a log group data protection policy.default GetDataProtectionPolicyResponse
getDataProtectionPolicy(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest)
Returns information about a log group data protection policy.default GetDeliveryResponse
getDelivery(Consumer<GetDeliveryRequest.Builder> getDeliveryRequest)
Returns complete information about one logical delivery.default GetDeliveryResponse
getDelivery(GetDeliveryRequest getDeliveryRequest)
Returns complete information about one logical delivery.default GetDeliveryDestinationResponse
getDeliveryDestination(Consumer<GetDeliveryDestinationRequest.Builder> getDeliveryDestinationRequest)
Retrieves complete information about one delivery destination.default GetDeliveryDestinationResponse
getDeliveryDestination(GetDeliveryDestinationRequest getDeliveryDestinationRequest)
Retrieves complete information about one delivery destination.default GetDeliveryDestinationPolicyResponse
getDeliveryDestinationPolicy(Consumer<GetDeliveryDestinationPolicyRequest.Builder> getDeliveryDestinationPolicyRequest)
Retrieves the delivery destination policy assigned to the delivery destination that you specify.default GetDeliveryDestinationPolicyResponse
getDeliveryDestinationPolicy(GetDeliveryDestinationPolicyRequest getDeliveryDestinationPolicyRequest)
Retrieves the delivery destination policy assigned to the delivery destination that you specify.default GetDeliverySourceResponse
getDeliverySource(Consumer<GetDeliverySourceRequest.Builder> getDeliverySourceRequest)
Retrieves complete information about one delivery source.default GetDeliverySourceResponse
getDeliverySource(GetDeliverySourceRequest getDeliverySourceRequest)
Retrieves complete information about one delivery source.default GetIntegrationResponse
getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest)
Returns information about one integration between CloudWatch Logs and OpenSearch Service.default GetIntegrationResponse
getIntegration(GetIntegrationRequest getIntegrationRequest)
Returns information about one integration between CloudWatch Logs and OpenSearch Service.default GetLogAnomalyDetectorResponse
getLogAnomalyDetector(Consumer<GetLogAnomalyDetectorRequest.Builder> getLogAnomalyDetectorRequest)
Retrieves information about the log anomaly detector that you specify.default GetLogAnomalyDetectorResponse
getLogAnomalyDetector(GetLogAnomalyDetectorRequest getLogAnomalyDetectorRequest)
Retrieves information about the log anomaly detector that you specify.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)
This is a variant ofgetLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)
operation.default GetLogEventsIterable
getLogEventsPaginator(GetLogEventsRequest getLogEventsRequest)
This is a variant ofgetLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)
operation.default GetLogGroupFieldsResponse
getLogGroupFields(Consumer<GetLogGroupFieldsRequest.Builder> getLogGroupFieldsRequest)
Returns a list of the fields that are included in log events in the specified log group.default GetLogGroupFieldsResponse
getLogGroupFields(GetLogGroupFieldsRequest getLogGroupFieldsRequest)
Returns a list of the fields that are included in log events in the specified log group.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 GetTransformerResponse
getTransformer(Consumer<GetTransformerRequest.Builder> getTransformerRequest)
Returns the information about the log transformer associated with this log group.default GetTransformerResponse
getTransformer(GetTransformerRequest getTransformerRequest)
Returns the information about the log transformer associated with this log group.default ListAnomaliesResponse
listAnomalies(Consumer<ListAnomaliesRequest.Builder> listAnomaliesRequest)
Returns a list of anomalies that log anomaly detectors have found.default ListAnomaliesResponse
listAnomalies(ListAnomaliesRequest listAnomaliesRequest)
Returns a list of anomalies that log anomaly detectors have found.default ListAnomaliesIterable
listAnomaliesPaginator(Consumer<ListAnomaliesRequest.Builder> listAnomaliesRequest)
This is a variant oflistAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest)
operation.default ListAnomaliesIterable
listAnomaliesPaginator(ListAnomaliesRequest listAnomaliesRequest)
This is a variant oflistAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest)
operation.default ListIntegrationsResponse
listIntegrations(Consumer<ListIntegrationsRequest.Builder> listIntegrationsRequest)
Returns a list of integrations between CloudWatch Logs and other services in this account.default ListIntegrationsResponse
listIntegrations(ListIntegrationsRequest listIntegrationsRequest)
Returns a list of integrations between CloudWatch Logs and other services in this account.default ListLogAnomalyDetectorsResponse
listLogAnomalyDetectors(Consumer<ListLogAnomalyDetectorsRequest.Builder> listLogAnomalyDetectorsRequest)
Retrieves a list of the log anomaly detectors in the account.default ListLogAnomalyDetectorsResponse
listLogAnomalyDetectors(ListLogAnomalyDetectorsRequest listLogAnomalyDetectorsRequest)
Retrieves a list of the log anomaly detectors in the account.default ListLogAnomalyDetectorsIterable
listLogAnomalyDetectorsPaginator(Consumer<ListLogAnomalyDetectorsRequest.Builder> listLogAnomalyDetectorsRequest)
This is a variant oflistLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest)
operation.default ListLogAnomalyDetectorsIterable
listLogAnomalyDetectorsPaginator(ListLogAnomalyDetectorsRequest listLogAnomalyDetectorsRequest)
This is a variant oflistLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest)
operation.default ListLogGroupsForQueryResponse
listLogGroupsForQuery(Consumer<ListLogGroupsForQueryRequest.Builder> listLogGroupsForQueryRequest)
Returns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query.default ListLogGroupsForQueryResponse
listLogGroupsForQuery(ListLogGroupsForQueryRequest listLogGroupsForQueryRequest)
Returns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query.default ListLogGroupsForQueryIterable
listLogGroupsForQueryPaginator(Consumer<ListLogGroupsForQueryRequest.Builder> listLogGroupsForQueryRequest)
This is a variant oflistLogGroupsForQuery(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogGroupsForQueryRequest)
operation.default ListLogGroupsForQueryIterable
listLogGroupsForQueryPaginator(ListLogGroupsForQueryRequest listLogGroupsForQueryRequest)
This is a variant oflistLogGroupsForQuery(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogGroupsForQueryRequest)
operation.default ListTagsForResourceResponse
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with a CloudWatch Logs resource.default ListTagsForResourceResponse
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a CloudWatch Logs resource.default ListTagsLogGroupResponse
listTagsLogGroup(Consumer<ListTagsLogGroupRequest.Builder> listTagsLogGroupRequest)
Deprecated.Please use the generic tagging API ListTagsForResourcedefault ListTagsLogGroupResponse
listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest)
Deprecated.Please use the generic tagging API ListTagsForResourcedefault PutAccountPolicyResponse
putAccountPolicy(Consumer<PutAccountPolicyRequest.Builder> putAccountPolicyRequest)
Creates an account-level data protection policy, subscription filter policy, or field index policy that applies to all log groups or a subset of log groups in the account.default PutAccountPolicyResponse
putAccountPolicy(PutAccountPolicyRequest putAccountPolicyRequest)
Creates an account-level data protection policy, subscription filter policy, or field index policy that applies to all log groups or a subset of log groups in the account.default PutDataProtectionPolicyResponse
putDataProtectionPolicy(Consumer<PutDataProtectionPolicyRequest.Builder> putDataProtectionPolicyRequest)
Creates a data protection policy for the specified log group.default PutDataProtectionPolicyResponse
putDataProtectionPolicy(PutDataProtectionPolicyRequest putDataProtectionPolicyRequest)
Creates a data protection policy for the specified log group.default PutDeliveryDestinationResponse
putDeliveryDestination(Consumer<PutDeliveryDestinationRequest.Builder> putDeliveryDestinationRequest)
Creates or updates a logical delivery destination.default PutDeliveryDestinationResponse
putDeliveryDestination(PutDeliveryDestinationRequest putDeliveryDestinationRequest)
Creates or updates a logical delivery destination.default PutDeliveryDestinationPolicyResponse
putDeliveryDestinationPolicy(Consumer<PutDeliveryDestinationPolicyRequest.Builder> putDeliveryDestinationPolicyRequest)
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.default PutDeliveryDestinationPolicyResponse
putDeliveryDestinationPolicy(PutDeliveryDestinationPolicyRequest putDeliveryDestinationPolicyRequest)
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.default PutDeliverySourceResponse
putDeliverySource(Consumer<PutDeliverySourceRequest.Builder> putDeliverySourceRequest)
Creates or updates a logical delivery source.default PutDeliverySourceResponse
putDeliverySource(PutDeliverySourceRequest putDeliverySourceRequest)
Creates or updates a logical delivery source.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 PutIndexPolicyResponse
putIndexPolicy(Consumer<PutIndexPolicyRequest.Builder> putIndexPolicyRequest)
Creates or updates a field index policy for the specified log group.default PutIndexPolicyResponse
putIndexPolicy(PutIndexPolicyRequest putIndexPolicyRequest)
Creates or updates a field index policy for the specified log group.default PutIntegrationResponse
putIntegration(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest)
Creates an integration between CloudWatch Logs and another service in this account.default PutIntegrationResponse
putIntegration(PutIntegrationRequest putIntegrationRequest)
Creates an integration between CloudWatch Logs and another service in this account.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.default PutTransformerResponse
putTransformer(Consumer<PutTransformerRequest.Builder> putTransformerRequest)
Creates or updates a log transformer for a single log group.default PutTransformerResponse
putTransformer(PutTransformerRequest putTransformerRequest)
Creates or updates a log transformer for a single log group.default CloudWatchLogsServiceClientConfiguration
serviceClientConfiguration()
static ServiceMetadata
serviceMetadata()
default StartQueryResponse
startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest)
Starts a query of one or more log groups using CloudWatch Logs Insights.default StartQueryResponse
startQuery(StartQueryRequest startQueryRequest)
Starts a query of one or more log groups 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)
Deprecated.Please use the generic tagging API TagResourcedefault TagLogGroupResponse
tagLogGroup(TagLogGroupRequest tagLogGroupRequest)
Deprecated.Please use the generic tagging API TagResourcedefault TagResourceResponse
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource.default TagResourceResponse
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource.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 TestTransformerResponse
testTransformer(Consumer<TestTransformerRequest.Builder> testTransformerRequest)
Use this operation to test a log transformer.default TestTransformerResponse
testTransformer(TestTransformerRequest testTransformerRequest)
Use this operation to test a log transformer.default UntagLogGroupResponse
untagLogGroup(Consumer<UntagLogGroupRequest.Builder> untagLogGroupRequest)
Deprecated.Please use the generic tagging API UntagResourcedefault UntagLogGroupResponse
untagLogGroup(UntagLogGroupRequest untagLogGroupRequest)
Deprecated.Please use the generic tagging API UntagResourcedefault UntagResourceResponse
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified resource.default UntagResourceResponse
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.default UpdateAnomalyResponse
updateAnomaly(Consumer<UpdateAnomalyRequest.Builder> updateAnomalyRequest)
Use this operation to suppress anomaly detection for a specified anomaly or pattern.default UpdateAnomalyResponse
updateAnomaly(UpdateAnomalyRequest updateAnomalyRequest)
Use this operation to suppress anomaly detection for a specified anomaly or pattern.default UpdateDeliveryConfigurationResponse
updateDeliveryConfiguration(Consumer<UpdateDeliveryConfigurationRequest.Builder> updateDeliveryConfigurationRequest)
Use this operation to update the configuration of a delivery to change either the S3 path pattern or the format of the delivered logs.default UpdateDeliveryConfigurationResponse
updateDeliveryConfiguration(UpdateDeliveryConfigurationRequest updateDeliveryConfigurationRequest)
Use this operation to update the configuration of a delivery to change either the S3 path pattern or the format of the delivered logs.default UpdateLogAnomalyDetectorResponse
updateLogAnomalyDetector(Consumer<UpdateLogAnomalyDetectorRequest.Builder> updateLogAnomalyDetectorRequest)
Updates an existing log anomaly detector.default UpdateLogAnomalyDetectorResponse
updateLogAnomalyDetector(UpdateLogAnomalyDetectorRequest updateLogAnomalyDetectorRequest)
Updates an existing log anomaly detector.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
- Constant Field Values
-
-
Method Detail
-
associateKmsKey
default AssociateKmsKeyResponse associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use
AssociateKmsKey
, you specify either thelogGroupName
parameter or theresourceIdentifier
parameter. You can't specify both of those parameters in the same operation.-
Specify the
logGroupName
parameter to cause all log events stored in the log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an
AssociateKmsKey
operation with theresourceIdentifier
parameter that specifies aquery-result
resource. -
Specify the
resourceIdentifier
parameter with aquery-result
resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. 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 KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an
InvalidParameterException
error.- Parameters:
associateKmsKeyRequest
-- Returns:
- Result of the AssociateKmsKey operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
-
associateKmsKey
default AssociateKmsKeyResponse associateKmsKey(Consumer<AssociateKmsKeyRequest.Builder> associateKmsKeyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use
AssociateKmsKey
, you specify either thelogGroupName
parameter or theresourceIdentifier
parameter. You can't specify both of those parameters in the same operation.-
Specify the
logGroupName
parameter to cause all log events stored in the log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an
AssociateKmsKey
operation with theresourceIdentifier
parameter that specifies aquery-result
resource. -
Specify the
resourceIdentifier
parameter with aquery-result
resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. 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 KMS key with a log group but the KMS key does not exist or the KMS key 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 viaAssociateKmsKeyRequest.builder()
- Parameters:
associateKmsKeyRequest
- AConsumer
that will call methods onAssociateKmsKeyRequest.Builder
to create a request.- Returns:
- Result of the AssociateKmsKey operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
-
cancelExportTask
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
orRUNNING
state.- Parameters:
cancelExportTaskRequest
-- Returns:
- Result of the CancelExportTask operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
cancelExportTask
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
orRUNNING
state.
This is a convenience which creates an instance of the
CancelExportTaskRequest.Builder
avoiding the need to create one manually viaCancelExportTaskRequest.builder()
- Parameters:
cancelExportTaskRequest
- AConsumer
that will call methods onCancelExportTaskRequest.Builder
to create a request.- Returns:
- Result of the CancelExportTask operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
createDelivery
default CreateDeliveryResponse createDelivery(CreateDeliveryRequest createDeliveryRequest) throws ServiceUnavailableException, ConflictException, ResourceNotFoundException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.
Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
-
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
-
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
-
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
-
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
To update an existing delivery configuration, use UpdateDeliveryConfiguration.
- Parameters:
createDeliveryRequest
-- Returns:
- Result of the CreateDelivery operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ResourceNotFoundException
- The specified resource does not exist.ValidationException
- One of the parameters for the request is not valid.AccessDeniedException
- You don't have sufficient permissions to perform this action.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
-
createDelivery
default CreateDeliveryResponse createDelivery(Consumer<CreateDeliveryRequest.Builder> createDeliveryRequest) throws ServiceUnavailableException, ConflictException, ResourceNotFoundException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.
Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
-
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
-
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
-
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
-
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
To update an existing delivery configuration, use UpdateDeliveryConfiguration.
This is a convenience which creates an instance of the
CreateDeliveryRequest.Builder
avoiding the need to create one manually viaCreateDeliveryRequest.builder()
- Parameters:
createDeliveryRequest
- AConsumer
that will call methods onCreateDeliveryRequest.Builder
to create a request.- Returns:
- Result of the CreateDelivery operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ResourceNotFoundException
- The specified resource does not exist.ValidationException
- One of the parameters for the request is not valid.AccessDeniedException
- You don't have sufficient permissions to perform this action.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
-
createExportTask
default CreateExportTaskResponse createExportTask(CreateExportTaskRequest createExportTaskRequest) throws InvalidParameterException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, ResourceNotFoundException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates an export task so that you can 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 S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also 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
orPENDING
) 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 log data for each export task, 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 field data by using Linux utilities.
- Parameters:
createExportTaskRequest
-- Returns:
- Result of the CreateExportTask operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
createExportTask
default CreateExportTaskResponse createExportTask(Consumer<CreateExportTaskRequest.Builder> createExportTaskRequest) throws InvalidParameterException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, ResourceNotFoundException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates an export task so that you can 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 S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also 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
orPENDING
) 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 log data for each export task, 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 field data by using Linux utilities.
This is a convenience which creates an instance of the
CreateExportTaskRequest.Builder
avoiding the need to create one manually viaCreateExportTaskRequest.builder()
- Parameters:
createExportTaskRequest
- AConsumer
that will call methods onCreateExportTaskRequest.Builder
to create a request.- Returns:
- Result of the CreateExportTask operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
createLogAnomalyDetector
default CreateLogAnomalyDetectorResponse createLogAnomalyDetector(CreateLogAnomalyDetectorRequest createLogAnomalyDetectorRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, LimitExceededException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.
An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns.
The anomaly detector uses pattern recognition to find
anomalies
, which are unusual log events. It uses theevaluationFrequency
to compare current log events and patterns with trained baselines.Fields within a pattern are called tokens. Fields that vary within a pattern, such as a request ID or timestamp, are referred to as dynamic tokens and represented by
<*>
.The following is an example of a pattern:
[INFO] Request time: <*> ms
This pattern represents log events like
[INFO] Request time: 327 ms
and other similar log events that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced by<*>
Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information about masking sensitive data, see Help protect sensitive log data with masking.
- Parameters:
createLogAnomalyDetectorRequest
-- Returns:
- Result of the CreateLogAnomalyDetector operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.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.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
- See Also:
- AWS API Documentation
-
createLogAnomalyDetector
default CreateLogAnomalyDetectorResponse createLogAnomalyDetector(Consumer<CreateLogAnomalyDetectorRequest.Builder> createLogAnomalyDetectorRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, LimitExceededException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.
An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns.
The anomaly detector uses pattern recognition to find
anomalies
, which are unusual log events. It uses theevaluationFrequency
to compare current log events and patterns with trained baselines.Fields within a pattern are called tokens. Fields that vary within a pattern, such as a request ID or timestamp, are referred to as dynamic tokens and represented by
<*>
.The following is an example of a pattern:
[INFO] Request time: <*> ms
This pattern represents log events like
[INFO] Request time: 327 ms
and other similar log events that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced by<*>
Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information about masking sensitive data, see Help protect sensitive log data with masking.
This is a convenience which creates an instance of the
CreateLogAnomalyDetectorRequest.Builder
avoiding the need to create one manually viaCreateLogAnomalyDetectorRequest.builder()
- Parameters:
createLogAnomalyDetectorRequest
- AConsumer
that will call methods onCreateLogAnomalyDetectorRequest.Builder
to create a request.- Returns:
- Result of the CreateLogAnomalyDetector operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.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.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
- See Also:
- AWS API Documentation
-
createLogGroup
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 1,000,000 log groups per Region 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)
-
Log group names can't start with the string
aws/
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an
InvalidParameterException
error.CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
- Parameters:
createLogGroupRequest
-- Returns:
- Result of the CreateLogGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
-
createLogGroup
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 1,000,000 log groups per Region 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)
-
Log group names can't start with the string
aws/
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an
InvalidParameterException
error.CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key 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 viaCreateLogGroupRequest.builder()
- Parameters:
createLogGroupRequest
- AConsumer
that will call methods onCreateLogGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateLogGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
-
createLogStream
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.
-
Don't use ':' (colon) or '*' (asterisk) characters.
- Parameters:
createLogStreamRequest
-- Returns:
- Result of the CreateLogStream operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
-
createLogStream
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.
-
Don't use ':' (colon) or '*' (asterisk) characters.
This is a convenience which creates an instance of the
CreateLogStreamRequest.Builder
avoiding the need to create one manually viaCreateLogStreamRequest.builder()
- Parameters:
createLogStreamRequest
- AConsumer
that will call methods onCreateLogStreamRequest.Builder
to create a request.- Returns:
- Result of the CreateLogStream operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
-
deleteAccountPolicy
default DeleteAccountPolicyResponse deleteAccountPolicy(DeleteAccountPolicyRequest deleteAccountPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a CloudWatch Logs account policy. This stops the account-wide policy from applying to log groups in the account. If you delete a data protection policy or subscription filter policy, any log-group level policies of those types remain in effect.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting.
-
To delete a data protection policy, you must have the
logs:DeleteDataProtectionPolicy
andlogs:DeleteAccountPolicy
permissions. -
To delete a subscription filter policy, you must have the
logs:DeleteSubscriptionFilter
andlogs:DeleteAccountPolicy
permissions. -
To delete a transformer policy, you must have the
logs:DeleteTransformer
andlogs:DeleteAccountPolicy
permissions. -
To delete a field index policy, you must have the
logs:DeleteIndexPolicy
andlogs:DeleteAccountPolicy
permissions.
If you delete a field index policy, the indexing of the log events that happened before you deleted the policy will still be used for up to 30 days to improve CloudWatch Logs Insights queries.
- Parameters:
deleteAccountPolicyRequest
-- Returns:
- Result of the DeleteAccountPolicy operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
-
deleteAccountPolicy
default DeleteAccountPolicyResponse deleteAccountPolicy(Consumer<DeleteAccountPolicyRequest.Builder> deleteAccountPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a CloudWatch Logs account policy. This stops the account-wide policy from applying to log groups in the account. If you delete a data protection policy or subscription filter policy, any log-group level policies of those types remain in effect.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting.
-
To delete a data protection policy, you must have the
logs:DeleteDataProtectionPolicy
andlogs:DeleteAccountPolicy
permissions. -
To delete a subscription filter policy, you must have the
logs:DeleteSubscriptionFilter
andlogs:DeleteAccountPolicy
permissions. -
To delete a transformer policy, you must have the
logs:DeleteTransformer
andlogs:DeleteAccountPolicy
permissions. -
To delete a field index policy, you must have the
logs:DeleteIndexPolicy
andlogs:DeleteAccountPolicy
permissions.
If you delete a field index policy, the indexing of the log events that happened before you deleted the policy will still be used for up to 30 days to improve CloudWatch Logs Insights queries.
This is a convenience which creates an instance of the
DeleteAccountPolicyRequest.Builder
avoiding the need to create one manually viaDeleteAccountPolicyRequest.builder()
- Parameters:
deleteAccountPolicyRequest
- AConsumer
that will call methods onDeleteAccountPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccountPolicy operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
-
deleteDataProtectionPolicy
default DeleteDataProtectionPolicyResponse deleteDataProtectionPolicy(DeleteDataProtectionPolicyRequest deleteDataProtectionPolicyRequest) throws InvalidParameterException, OperationAbortedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
- Parameters:
deleteDataProtectionPolicyRequest
-- Returns:
- Result of the DeleteDataProtectionPolicy operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
deleteDataProtectionPolicy
default DeleteDataProtectionPolicyResponse deleteDataProtectionPolicy(Consumer<DeleteDataProtectionPolicyRequest.Builder> deleteDataProtectionPolicyRequest) throws InvalidParameterException, OperationAbortedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
This is a convenience which creates an instance of the
DeleteDataProtectionPolicyRequest.Builder
avoiding the need to create one manually viaDeleteDataProtectionPolicyRequest.builder()
- Parameters:
deleteDataProtectionPolicyRequest
- AConsumer
that will call methods onDeleteDataProtectionPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataProtectionPolicy operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
deleteDelivery
default DeleteDeliveryResponse deleteDelivery(DeleteDeliveryRequest deleteDeliveryRequest) throws ResourceNotFoundException, ServiceUnavailableException, ConflictException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes s delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.
- Parameters:
deleteDeliveryRequest
-- Returns:
- Result of the DeleteDelivery operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
deleteDelivery
default DeleteDeliveryResponse deleteDelivery(Consumer<DeleteDeliveryRequest.Builder> deleteDeliveryRequest) throws ResourceNotFoundException, ServiceUnavailableException, ConflictException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes s delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.
This is a convenience which creates an instance of the
DeleteDeliveryRequest.Builder
avoiding the need to create one manually viaDeleteDeliveryRequest.builder()
- Parameters:
deleteDeliveryRequest
- AConsumer
that will call methods onDeleteDeliveryRequest.Builder
to create a request.- Returns:
- Result of the DeleteDelivery operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
deleteDeliveryDestination
default DeleteDeliveryDestinationResponse deleteDeliveryDestination(DeleteDeliveryDestinationRequest deleteDeliveryDestinationRequest) throws ResourceNotFoundException, ServiceUnavailableException, ConflictException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the
deliveryDestinationArn
field in the results.- Parameters:
deleteDeliveryDestinationRequest
-- Returns:
- Result of the DeleteDeliveryDestination operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
deleteDeliveryDestination
default DeleteDeliveryDestinationResponse deleteDeliveryDestination(Consumer<DeleteDeliveryDestinationRequest.Builder> deleteDeliveryDestinationRequest) throws ResourceNotFoundException, ServiceUnavailableException, ConflictException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the
deliveryDestinationArn
field in the results.
This is a convenience which creates an instance of the
DeleteDeliveryDestinationRequest.Builder
avoiding the need to create one manually viaDeleteDeliveryDestinationRequest.builder()
- Parameters:
deleteDeliveryDestinationRequest
- AConsumer
that will call methods onDeleteDeliveryDestinationRequest.Builder
to create a request.- Returns:
- Result of the DeleteDeliveryDestination operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
deleteDeliveryDestinationPolicy
default DeleteDeliveryDestinationPolicyResponse deleteDeliveryDestinationPolicy(DeleteDeliveryDestinationPolicyRequest deleteDeliveryDestinationPolicyRequest) throws ServiceUnavailableException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.
- Parameters:
deleteDeliveryDestinationPolicyRequest
-- Returns:
- Result of the DeleteDeliveryDestinationPolicy operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ResourceNotFoundException
- The specified resource does not exist.ConflictException
- This operation attempted to create a resource that 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
- See Also:
- AWS API Documentation
-
deleteDeliveryDestinationPolicy
default DeleteDeliveryDestinationPolicyResponse deleteDeliveryDestinationPolicy(Consumer<DeleteDeliveryDestinationPolicyRequest.Builder> deleteDeliveryDestinationPolicyRequest) throws ServiceUnavailableException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.
This is a convenience which creates an instance of the
DeleteDeliveryDestinationPolicyRequest.Builder
avoiding the need to create one manually viaDeleteDeliveryDestinationPolicyRequest.builder()
- Parameters:
deleteDeliveryDestinationPolicyRequest
- AConsumer
that will call methods onDeleteDeliveryDestinationPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteDeliveryDestinationPolicy operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ResourceNotFoundException
- The specified resource does not exist.ConflictException
- This operation attempted to create a resource that 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
- See Also:
- AWS API Documentation
-
deleteDeliverySource
default DeleteDeliverySourceResponse deleteDeliverySource(DeleteDeliverySourceRequest deleteDeliverySourceRequest) throws ResourceNotFoundException, ServiceUnavailableException, ConflictException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can't delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the
deliverySourceName
field in the results.- Parameters:
deleteDeliverySourceRequest
-- Returns:
- Result of the DeleteDeliverySource operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
deleteDeliverySource
default DeleteDeliverySourceResponse deleteDeliverySource(Consumer<DeleteDeliverySourceRequest.Builder> deleteDeliverySourceRequest) throws ResourceNotFoundException, ServiceUnavailableException, ConflictException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can't delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the
deliverySourceName
field in the results.
This is a convenience which creates an instance of the
DeleteDeliverySourceRequest.Builder
avoiding the need to create one manually viaDeleteDeliverySourceRequest.builder()
- Parameters:
deleteDeliverySourceRequest
- AConsumer
that will call methods onDeleteDeliverySourceRequest.Builder
to create a request.- Returns:
- Result of the DeleteDeliverySource operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
deleteDestination
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.
- Parameters:
deleteDestinationRequest
-- Returns:
- Result of the DeleteDestination operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteDestination
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 viaDeleteDestinationRequest.builder()
- Parameters:
deleteDestinationRequest
- AConsumer
that will call methods onDeleteDestinationRequest.Builder
to create a request.- Returns:
- Result of the DeleteDestination operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteIndexPolicy
default DeleteIndexPolicyResponse deleteIndexPolicy(DeleteIndexPolicyRequest deleteIndexPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a log-group level field index policy that was applied to a single log group. The indexing of the log events that happened before you delete the policy will still be used for as many as 30 days to improve CloudWatch Logs Insights queries.
You can't use this operation to delete an account-level index policy. Instead, use DeletAccountPolicy.
If you delete a log-group level field index policy and there is an account-level field index policy, in a few minutes the log group begins using that account-wide policy to index new incoming log events.
- Parameters:
deleteIndexPolicyRequest
-- Returns:
- Result of the DeleteIndexPolicy operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.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
- See Also:
- AWS API Documentation
-
deleteIndexPolicy
default DeleteIndexPolicyResponse deleteIndexPolicy(Consumer<DeleteIndexPolicyRequest.Builder> deleteIndexPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes a log-group level field index policy that was applied to a single log group. The indexing of the log events that happened before you delete the policy will still be used for as many as 30 days to improve CloudWatch Logs Insights queries.
You can't use this operation to delete an account-level index policy. Instead, use DeletAccountPolicy.
If you delete a log-group level field index policy and there is an account-level field index policy, in a few minutes the log group begins using that account-wide policy to index new incoming log events.
This is a convenience which creates an instance of the
DeleteIndexPolicyRequest.Builder
avoiding the need to create one manually viaDeleteIndexPolicyRequest.builder()
- Parameters:
deleteIndexPolicyRequest
- AConsumer
that will call methods onDeleteIndexPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteIndexPolicy operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.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
- See Also:
- AWS API Documentation
-
deleteIntegration
default DeleteIntegrationResponse deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active vended logs dashboards, you must specify
true
for theforce
parameter, otherwise the operation will fail. If you delete the integration by settingforce
totrue
, all your vended logs dashboards powered by OpenSearch Service will be deleted and the data that was on them will no longer be accessible.- Parameters:
deleteIntegrationRequest
-- Returns:
- Result of the DeleteIntegration operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.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
- See Also:
- AWS API Documentation
-
deleteIntegration
default DeleteIntegrationResponse deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active vended logs dashboards, you must specify
true
for theforce
parameter, otherwise the operation will fail. If you delete the integration by settingforce
totrue
, all your vended logs dashboards powered by OpenSearch Service will be deleted and the data that was on them will no longer be accessible.
This is a convenience which creates an instance of the
DeleteIntegrationRequest.Builder
avoiding the need to create one manually viaDeleteIntegrationRequest.builder()
- Parameters:
deleteIntegrationRequest
- AConsumer
that will call methods onDeleteIntegrationRequest.Builder
to create a request.- Returns:
- Result of the DeleteIntegration operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.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
- See Also:
- AWS API Documentation
-
deleteLogAnomalyDetector
default DeleteLogAnomalyDetectorResponse deleteLogAnomalyDetector(DeleteLogAnomalyDetectorRequest deleteLogAnomalyDetectorRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified CloudWatch Logs anomaly detector.
- Parameters:
deleteLogAnomalyDetectorRequest
-- Returns:
- Result of the DeleteLogAnomalyDetector operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
deleteLogAnomalyDetector
default DeleteLogAnomalyDetectorResponse deleteLogAnomalyDetector(Consumer<DeleteLogAnomalyDetectorRequest.Builder> deleteLogAnomalyDetectorRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified CloudWatch Logs anomaly detector.
This is a convenience which creates an instance of the
DeleteLogAnomalyDetectorRequest.Builder
avoiding the need to create one manually viaDeleteLogAnomalyDetectorRequest.builder()
- Parameters:
deleteLogAnomalyDetectorRequest
- AConsumer
that will call methods onDeleteLogAnomalyDetectorRequest.Builder
to create a request.- Returns:
- Result of the DeleteLogAnomalyDetector operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
deleteLogGroup
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.
- Parameters:
deleteLogGroupRequest
-- Returns:
- Result of the DeleteLogGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteLogGroup
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 viaDeleteLogGroupRequest.builder()
- Parameters:
deleteLogGroupRequest
- AConsumer
that will call methods onDeleteLogGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteLogGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteLogStream
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.
- Parameters:
deleteLogStreamRequest
-- Returns:
- Result of the DeleteLogStream operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteLogStream
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 viaDeleteLogStreamRequest.builder()
- Parameters:
deleteLogStreamRequest
- AConsumer
that will call methods onDeleteLogStreamRequest.Builder
to create a request.- Returns:
- Result of the DeleteLogStream operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteMetricFilter
default DeleteMetricFilterResponse deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified metric filter.
- Parameters:
deleteMetricFilterRequest
-- Returns:
- Result of the DeleteMetricFilter operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteMetricFilter
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 viaDeleteMetricFilterRequest.builder()
- Parameters:
deleteMetricFilterRequest
- AConsumer
that will call methods onDeleteMetricFilterRequest.Builder
to create a request.- Returns:
- Result of the DeleteMetricFilter operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteQueryDefinition
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.- Parameters:
deleteQueryDefinitionRequest
-- Returns:
- Result of the DeleteQueryDefinition operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteQueryDefinition
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 viaDeleteQueryDefinitionRequest.builder()
- Parameters:
deleteQueryDefinitionRequest
- AConsumer
that will call methods onDeleteQueryDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DeleteQueryDefinition operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteResourcePolicy
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.
- Parameters:
deleteResourcePolicyRequest
-- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteResourcePolicy
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 viaDeleteResourcePolicyRequest.builder()
- Parameters:
deleteResourcePolicyRequest
- AConsumer
that will call methods onDeleteResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteRetentionPolicy
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.
- Parameters:
deleteRetentionPolicyRequest
-- Returns:
- Result of the DeleteRetentionPolicy operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteRetentionPolicy
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 viaDeleteRetentionPolicyRequest.builder()
- Parameters:
deleteRetentionPolicyRequest
- AConsumer
that will call methods onDeleteRetentionPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteRetentionPolicy operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteSubscriptionFilter
default DeleteSubscriptionFilterResponse deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the specified subscription filter.
- Parameters:
deleteSubscriptionFilterRequest
-- Returns:
- Result of the DeleteSubscriptionFilter operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteSubscriptionFilter
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 viaDeleteSubscriptionFilterRequest.builder()
- Parameters:
deleteSubscriptionFilterRequest
- AConsumer
that will call methods onDeleteSubscriptionFilterRequest.Builder
to create a request.- Returns:
- Result of the DeleteSubscriptionFilter operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteTransformer
default DeleteTransformerResponse deleteTransformer(DeleteTransformerRequest deleteTransformerRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the log transformer for the specified log group. As soon as you do this, the transformation of incoming log events according to that transformer stops. If this account has an account-level transformer that applies to this log group, the log group begins using that account-level transformer when this log-group level transformer is deleted.
After you delete a transformer, be sure to edit any metric filters or subscription filters that relied on the transformed versions of the log events.
- Parameters:
deleteTransformerRequest
-- Returns:
- Result of the DeleteTransformer operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
deleteTransformer
default DeleteTransformerResponse deleteTransformer(Consumer<DeleteTransformerRequest.Builder> deleteTransformerRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deletes the log transformer for the specified log group. As soon as you do this, the transformation of incoming log events according to that transformer stops. If this account has an account-level transformer that applies to this log group, the log group begins using that account-level transformer when this log-group level transformer is deleted.
After you delete a transformer, be sure to edit any metric filters or subscription filters that relied on the transformed versions of the log events.
This is a convenience which creates an instance of the
DeleteTransformerRequest.Builder
avoiding the need to create one manually viaDeleteTransformerRequest.builder()
- Parameters:
deleteTransformerRequest
- AConsumer
that will call methods onDeleteTransformerRequest.Builder
to create a request.- Returns:
- Result of the DeleteTransformer operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
describeAccountPolicies
default DescribeAccountPoliciesResponse describeAccountPolicies(DescribeAccountPoliciesRequest describeAccountPoliciesRequest) throws InvalidParameterException, OperationAbortedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of all CloudWatch Logs account policies in the account.
- Parameters:
describeAccountPoliciesRequest
-- Returns:
- Result of the DescribeAccountPolicies operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
describeAccountPolicies
default DescribeAccountPoliciesResponse describeAccountPolicies(Consumer<DescribeAccountPoliciesRequest.Builder> describeAccountPoliciesRequest) throws InvalidParameterException, OperationAbortedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of all CloudWatch Logs account policies in the account.
This is a convenience which creates an instance of the
DescribeAccountPoliciesRequest.Builder
avoiding the need to create one manually viaDescribeAccountPoliciesRequest.builder()
- Parameters:
describeAccountPoliciesRequest
- AConsumer
that will call methods onDescribeAccountPoliciesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccountPolicies operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
describeConfigurationTemplates
default DescribeConfigurationTemplatesResponse describeConfigurationTemplates(DescribeConfigurationTemplatesRequest describeConfigurationTemplatesRequest) throws ServiceUnavailableException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see CreateDelivery.
- Parameters:
describeConfigurationTemplatesRequest
-- Returns:
- Result of the DescribeConfigurationTemplates operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeConfigurationTemplates
default DescribeConfigurationTemplatesResponse describeConfigurationTemplates(Consumer<DescribeConfigurationTemplatesRequest.Builder> describeConfigurationTemplatesRequest) throws ServiceUnavailableException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see CreateDelivery.
This is a convenience which creates an instance of the
DescribeConfigurationTemplatesRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationTemplatesRequest.builder()
- Parameters:
describeConfigurationTemplatesRequest
- AConsumer
that will call methods onDescribeConfigurationTemplatesRequest.Builder
to create a request.- Returns:
- Result of the DescribeConfigurationTemplates operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeConfigurationTemplatesPaginator
default DescribeConfigurationTemplatesIterable describeConfigurationTemplatesPaginator(DescribeConfigurationTemplatesRequest describeConfigurationTemplatesRequest) throws ServiceUnavailableException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
describeConfigurationTemplates(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeConfigurationTemplatesRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeConfigurationTemplatesIterable responses = client.describeConfigurationTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeConfigurationTemplatesIterable responses = client .describeConfigurationTemplatesPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeConfigurationTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeConfigurationTemplatesIterable responses = client.describeConfigurationTemplatesPaginator(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
describeConfigurationTemplates(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeConfigurationTemplatesRequest)
operation.- Parameters:
describeConfigurationTemplatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeConfigurationTemplatesPaginator
default DescribeConfigurationTemplatesIterable describeConfigurationTemplatesPaginator(Consumer<DescribeConfigurationTemplatesRequest.Builder> describeConfigurationTemplatesRequest) throws ServiceUnavailableException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
describeConfigurationTemplates(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeConfigurationTemplatesRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeConfigurationTemplatesIterable responses = client.describeConfigurationTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeConfigurationTemplatesIterable responses = client .describeConfigurationTemplatesPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeConfigurationTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeConfigurationTemplatesIterable responses = client.describeConfigurationTemplatesPaginator(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
describeConfigurationTemplates(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeConfigurationTemplatesRequest)
operation.
This is a convenience which creates an instance of the
DescribeConfigurationTemplatesRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationTemplatesRequest.builder()
- Parameters:
describeConfigurationTemplatesRequest
- AConsumer
that will call methods onDescribeConfigurationTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliveries
default DescribeDeliveriesResponse describeDeliveries(DescribeDeliveriesRequest describeDeliveriesRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves a list of the deliveries that have been created in the account.
A delivery is a connection between a delivery source and a delivery destination .
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
- Parameters:
describeDeliveriesRequest
-- Returns:
- Result of the DescribeDeliveries operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliveries
default DescribeDeliveriesResponse describeDeliveries(Consumer<DescribeDeliveriesRequest.Builder> describeDeliveriesRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves a list of the deliveries that have been created in the account.
A delivery is a connection between a delivery source and a delivery destination .
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
This is a convenience which creates an instance of the
DescribeDeliveriesRequest.Builder
avoiding the need to create one manually viaDescribeDeliveriesRequest.builder()
- Parameters:
describeDeliveriesRequest
- AConsumer
that will call methods onDescribeDeliveriesRequest.Builder
to create a request.- Returns:
- Result of the DescribeDeliveries operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliveriesPaginator
default DescribeDeliveriesIterable describeDeliveriesPaginator(DescribeDeliveriesRequest describeDeliveriesRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
describeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesIterable responses = client.describeDeliveriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesIterable responses = client .describeDeliveriesPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesIterable responses = client.describeDeliveriesPaginator(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
describeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest)
operation.- Parameters:
describeDeliveriesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliveriesPaginator
default DescribeDeliveriesIterable describeDeliveriesPaginator(Consumer<DescribeDeliveriesRequest.Builder> describeDeliveriesRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
describeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesIterable responses = client.describeDeliveriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesIterable responses = client .describeDeliveriesPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesIterable responses = client.describeDeliveriesPaginator(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
describeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest)
operation.
This is a convenience which creates an instance of the
DescribeDeliveriesRequest.Builder
avoiding the need to create one manually viaDescribeDeliveriesRequest.builder()
- Parameters:
describeDeliveriesRequest
- AConsumer
that will call methods onDescribeDeliveriesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliveryDestinations
default DescribeDeliveryDestinationsResponse describeDeliveryDestinations(DescribeDeliveryDestinationsRequest describeDeliveryDestinationsRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves a list of the delivery destinations that have been created in the account.
- Parameters:
describeDeliveryDestinationsRequest
-- Returns:
- Result of the DescribeDeliveryDestinations operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliveryDestinations
default DescribeDeliveryDestinationsResponse describeDeliveryDestinations(Consumer<DescribeDeliveryDestinationsRequest.Builder> describeDeliveryDestinationsRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves a list of the delivery destinations that have been created in the account.
This is a convenience which creates an instance of the
DescribeDeliveryDestinationsRequest.Builder
avoiding the need to create one manually viaDescribeDeliveryDestinationsRequest.builder()
- Parameters:
describeDeliveryDestinationsRequest
- AConsumer
that will call methods onDescribeDeliveryDestinationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDeliveryDestinations operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliveryDestinationsPaginator
default DescribeDeliveryDestinationsIterable describeDeliveryDestinationsPaginator(DescribeDeliveryDestinationsRequest describeDeliveryDestinationsRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
describeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsIterable responses = client.describeDeliveryDestinationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsIterable responses = client .describeDeliveryDestinationsPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsIterable responses = client.describeDeliveryDestinationsPaginator(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
describeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest)
operation.- Parameters:
describeDeliveryDestinationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliveryDestinationsPaginator
default DescribeDeliveryDestinationsIterable describeDeliveryDestinationsPaginator(Consumer<DescribeDeliveryDestinationsRequest.Builder> describeDeliveryDestinationsRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
describeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsIterable responses = client.describeDeliveryDestinationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsIterable responses = client .describeDeliveryDestinationsPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsIterable responses = client.describeDeliveryDestinationsPaginator(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
describeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDeliveryDestinationsRequest.Builder
avoiding the need to create one manually viaDescribeDeliveryDestinationsRequest.builder()
- Parameters:
describeDeliveryDestinationsRequest
- AConsumer
that will call methods onDescribeDeliveryDestinationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliverySources
default DescribeDeliverySourcesResponse describeDeliverySources(DescribeDeliverySourcesRequest describeDeliverySourcesRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves a list of the delivery sources that have been created in the account.
- Parameters:
describeDeliverySourcesRequest
-- Returns:
- Result of the DescribeDeliverySources operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliverySources
default DescribeDeliverySourcesResponse describeDeliverySources(Consumer<DescribeDeliverySourcesRequest.Builder> describeDeliverySourcesRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves a list of the delivery sources that have been created in the account.
This is a convenience which creates an instance of the
DescribeDeliverySourcesRequest.Builder
avoiding the need to create one manually viaDescribeDeliverySourcesRequest.builder()
- Parameters:
describeDeliverySourcesRequest
- AConsumer
that will call methods onDescribeDeliverySourcesRequest.Builder
to create a request.- Returns:
- Result of the DescribeDeliverySources operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliverySourcesPaginator
default DescribeDeliverySourcesIterable describeDeliverySourcesPaginator(DescribeDeliverySourcesRequest describeDeliverySourcesRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
describeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesIterable responses = client.describeDeliverySourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesIterable responses = client .describeDeliverySourcesPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesIterable responses = client.describeDeliverySourcesPaginator(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
describeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest)
operation.- Parameters:
describeDeliverySourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDeliverySourcesPaginator
default DescribeDeliverySourcesIterable describeDeliverySourcesPaginator(Consumer<DescribeDeliverySourcesRequest.Builder> describeDeliverySourcesRequest) throws ServiceUnavailableException, ServiceQuotaExceededException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
describeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesIterable responses = client.describeDeliverySourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesIterable responses = client .describeDeliverySourcesPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesIterable responses = client.describeDeliverySourcesPaginator(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
describeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest)
operation.
This is a convenience which creates an instance of the
DescribeDeliverySourcesRequest.Builder
avoiding the need to create one manually viaDescribeDeliverySourcesRequest.builder()
- Parameters:
describeDeliverySourcesRequest
- AConsumer
that will call methods onDescribeDeliverySourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ServiceQuotaExceededException
- This request exceeds a service quota.ValidationException
- One of the parameters for the request is not valid.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
describeDestinations
default DescribeDestinationsResponse describeDestinations(DescribeDestinationsRequest describeDestinationsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists all your destinations. The results are ASCII-sorted by destination name.
- Parameters:
describeDestinationsRequest
-- Returns:
- Result of the DescribeDestinations operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeDestinations
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 viaDescribeDestinationsRequest.builder()
- Parameters:
describeDestinationsRequest
- AConsumer
that will call methods onDescribeDestinationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDestinations operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeDestinations
default DescribeDestinationsResponse describeDestinations() throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists all your destinations. The results are ASCII-sorted by destination name.
- Returns:
- Result of the DescribeDestinations operation returned by the service.
- Throws:
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
- See Also:
describeDestinations(DescribeDestinationsRequest)
, AWS API Documentation
-
describeDestinationsPaginator
default DescribeDestinationsIterable describeDestinationsPaginator() throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client.describeDestinationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
describeDestinationsPaginator(DescribeDestinationsRequest)
, AWS API Documentation
-
describeDestinationsPaginator
default DescribeDestinationsIterable describeDestinationsPaginator(DescribeDestinationsRequest describeDestinationsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client.describeDestinationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeDestinationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeDestinationsPaginator
default DescribeDestinationsIterable describeDestinationsPaginator(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsIterable responses = client.describeDestinationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeDestinationsRequest.builder()
- Parameters:
describeDestinationsRequest
- AConsumer
that will call methods onDescribeDestinationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeExportTasks
default 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.
- Parameters:
describeExportTasksRequest
-- Returns:
- Result of the DescribeExportTasks operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeExportTasks
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 viaDescribeExportTasksRequest.builder()
- Parameters:
describeExportTasksRequest
- AConsumer
that will call methods onDescribeExportTasksRequest.Builder
to create a request.- Returns:
- Result of the DescribeExportTasks operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeExportTasks
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.
- Returns:
- Result of the DescribeExportTasks operation returned by the service.
- Throws:
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
- See Also:
describeExportTasks(DescribeExportTasksRequest)
, AWS API Documentation
-
describeFieldIndexes
default DescribeFieldIndexesResponse describeFieldIndexes(DescribeFieldIndexesRequest describeFieldIndexesRequest) throws InvalidParameterException, ResourceNotFoundException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of field indexes listed in the field index policies of one or more log groups. For more information about field index policies, see PutIndexPolicy.
- Parameters:
describeFieldIndexesRequest
-- Returns:
- Result of the DescribeFieldIndexes operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.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
- See Also:
- AWS API Documentation
-
describeFieldIndexes
default DescribeFieldIndexesResponse describeFieldIndexes(Consumer<DescribeFieldIndexesRequest.Builder> describeFieldIndexesRequest) throws InvalidParameterException, ResourceNotFoundException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of field indexes listed in the field index policies of one or more log groups. For more information about field index policies, see PutIndexPolicy.
This is a convenience which creates an instance of the
DescribeFieldIndexesRequest.Builder
avoiding the need to create one manually viaDescribeFieldIndexesRequest.builder()
- Parameters:
describeFieldIndexesRequest
- AConsumer
that will call methods onDescribeFieldIndexesRequest.Builder
to create a request.- Returns:
- Result of the DescribeFieldIndexes operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.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
- See Also:
- AWS API Documentation
-
describeIndexPolicies
default DescribeIndexPoliciesResponse describeIndexPolicies(DescribeIndexPoliciesRequest describeIndexPoliciesRequest) throws InvalidParameterException, ResourceNotFoundException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns the field index policies of one or more log groups. For more information about field index policies, see PutIndexPolicy.
If a specified log group has a log-group level index policy, that policy is returned by this operation.
If a specified log group doesn't have a log-group level index policy, but an account-wide index policy applies to it, that account-wide policy is returned by this operation.
To find information about only account-level policies, use DescribeAccountPolicies instead.
- Parameters:
describeIndexPoliciesRequest
-- Returns:
- Result of the DescribeIndexPolicies operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.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
- See Also:
- AWS API Documentation
-
describeIndexPolicies
default DescribeIndexPoliciesResponse describeIndexPolicies(Consumer<DescribeIndexPoliciesRequest.Builder> describeIndexPoliciesRequest) throws InvalidParameterException, ResourceNotFoundException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns the field index policies of one or more log groups. For more information about field index policies, see PutIndexPolicy.
If a specified log group has a log-group level index policy, that policy is returned by this operation.
If a specified log group doesn't have a log-group level index policy, but an account-wide index policy applies to it, that account-wide policy is returned by this operation.
To find information about only account-level policies, use DescribeAccountPolicies instead.
This is a convenience which creates an instance of the
DescribeIndexPoliciesRequest.Builder
avoiding the need to create one manually viaDescribeIndexPoliciesRequest.builder()
- Parameters:
describeIndexPoliciesRequest
- AConsumer
that will call methods onDescribeIndexPoliciesRequest.Builder
to create a request.- Returns:
- Result of the DescribeIndexPolicies operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.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
- See Also:
- AWS API Documentation
-
describeLogGroups
default 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 theaws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support the use of theaws: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.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
- Parameters:
describeLogGroupsRequest
-- Returns:
- Result of the DescribeLogGroups operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeLogGroups
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 theaws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support the use of theaws: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.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
This is a convenience which creates an instance of the
DescribeLogGroupsRequest.Builder
avoiding the need to create one manually viaDescribeLogGroupsRequest.builder()
- Parameters:
describeLogGroupsRequest
- AConsumer
that will call methods onDescribeLogGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeLogGroups operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeLogGroups
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 theaws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support the use of theaws: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.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
- Returns:
- Result of the DescribeLogGroups operation returned by the service.
- Throws:
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
- See Also:
describeLogGroups(DescribeLogGroupsRequest)
, AWS API Documentation
-
describeLogGroupsPaginator
default DescribeLogGroupsIterable describeLogGroupsPaginator() throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client.describeLogGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
describeLogGroupsPaginator(DescribeLogGroupsRequest)
, AWS API Documentation
-
describeLogGroupsPaginator
default DescribeLogGroupsIterable describeLogGroupsPaginator(DescribeLogGroupsRequest describeLogGroupsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client.describeLogGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeLogGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeLogGroupsPaginator
default DescribeLogGroupsIterable describeLogGroupsPaginator(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsIterable responses = client.describeLogGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeLogGroupsRequest.builder()
- Parameters:
describeLogGroupsRequest
- AConsumer
that will call methods onDescribeLogGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeLogStreams
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.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can't include both.This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
- Parameters:
describeLogStreamsRequest
-- Returns:
- Result of the DescribeLogStreams operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeLogStreams
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.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can't include both.This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
This is a convenience which creates an instance of the
DescribeLogStreamsRequest.Builder
avoiding the need to create one manually viaDescribeLogStreamsRequest.builder()
- Parameters:
describeLogStreamsRequest
- AConsumer
that will call methods onDescribeLogStreamsRequest.Builder
to create a request.- Returns:
- Result of the DescribeLogStreams operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeLogStreamsPaginator
default DescribeLogStreamsIterable describeLogStreamsPaginator(DescribeLogStreamsRequest describeLogStreamsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsIterable responses = client.describeLogStreamsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeLogStreamsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeLogStreamsPaginator
default DescribeLogStreamsIterable describeLogStreamsPaginator(Consumer<DescribeLogStreamsRequest.Builder> describeLogStreamsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsIterable responses = client.describeLogStreamsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeLogStreamsRequest.builder()
- Parameters:
describeLogStreamsRequest
- AConsumer
that will call methods onDescribeLogStreamsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMetricFilters
default 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.
- Parameters:
describeMetricFiltersRequest
-- Returns:
- Result of the DescribeMetricFilters operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMetricFilters
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 viaDescribeMetricFiltersRequest.builder()
- Parameters:
describeMetricFiltersRequest
- AConsumer
that will call methods onDescribeMetricFiltersRequest.Builder
to create a request.- Returns:
- Result of the DescribeMetricFilters operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMetricFilters
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.
- Returns:
- Result of the DescribeMetricFilters operation returned by the service.
- Throws:
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
- See Also:
describeMetricFilters(DescribeMetricFiltersRequest)
, AWS API Documentation
-
describeMetricFiltersPaginator
default DescribeMetricFiltersIterable describeMetricFiltersPaginator() throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client.describeMetricFiltersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
describeMetricFiltersPaginator(DescribeMetricFiltersRequest)
, AWS API Documentation
-
describeMetricFiltersPaginator
default DescribeMetricFiltersIterable describeMetricFiltersPaginator(DescribeMetricFiltersRequest describeMetricFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client.describeMetricFiltersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeMetricFiltersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMetricFiltersPaginator
default DescribeMetricFiltersIterable describeMetricFiltersPaginator(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersIterable responses = client.describeMetricFiltersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeMetricFiltersRequest.builder()
- Parameters:
describeMetricFiltersRequest
- AConsumer
that will call methods onDescribeMetricFiltersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeQueries
default DescribeQueriesResponse describeQueries(DescribeQueriesRequest describeQueriesRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run 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.
- Parameters:
describeQueriesRequest
-- Returns:
- Result of the DescribeQueries operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeQueries
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, running, or have been run 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 viaDescribeQueriesRequest.builder()
- Parameters:
describeQueriesRequest
- AConsumer
that will call methods onDescribeQueriesRequest.Builder
to create a request.- Returns:
- Result of the DescribeQueries operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeQueries
default DescribeQueriesResponse describeQueries() throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run 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.
- Returns:
- Result of the DescribeQueries operation returned by the service.
- Throws:
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
- See Also:
describeQueries(DescribeQueriesRequest)
, AWS API Documentation
-
describeQueryDefinitions
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 retrieve query definitions from the current account or from a source account that is linked to the current account.
You can use the
queryDefinitionNamePrefix
parameter to limit the results to only the query definitions that have names that start with a certain string.- Parameters:
describeQueryDefinitionsRequest
-- Returns:
- Result of the DescribeQueryDefinitions operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeQueryDefinitions
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 retrieve query definitions from the current account or from a source account that is linked to the current account.
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 viaDescribeQueryDefinitionsRequest.builder()
- Parameters:
describeQueryDefinitionsRequest
- AConsumer
that will call methods onDescribeQueryDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeQueryDefinitions operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeResourcePolicies
default DescribeResourcePoliciesResponse describeResourcePolicies(DescribeResourcePoliciesRequest describeResourcePoliciesRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the resource policies in this account.
- Parameters:
describeResourcePoliciesRequest
-- Returns:
- Result of the DescribeResourcePolicies operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeResourcePolicies
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 viaDescribeResourcePoliciesRequest.builder()
- Parameters:
describeResourcePoliciesRequest
- AConsumer
that will call methods onDescribeResourcePoliciesRequest.Builder
to create a request.- Returns:
- Result of the DescribeResourcePolicies operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeResourcePolicies
default DescribeResourcePoliciesResponse describeResourcePolicies() throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Lists the resource policies in this account.
- Returns:
- Result of the DescribeResourcePolicies operation returned by the service.
- Throws:
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
- See Also:
describeResourcePolicies(DescribeResourcePoliciesRequest)
, AWS API Documentation
-
describeSubscriptionFilters
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.
- Parameters:
describeSubscriptionFiltersRequest
-- Returns:
- Result of the DescribeSubscriptionFilters operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeSubscriptionFilters
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 viaDescribeSubscriptionFiltersRequest.builder()
- Parameters:
describeSubscriptionFiltersRequest
- AConsumer
that will call methods onDescribeSubscriptionFiltersRequest.Builder
to create a request.- Returns:
- Result of the DescribeSubscriptionFilters operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeSubscriptionFiltersPaginator
default DescribeSubscriptionFiltersIterable describeSubscriptionFiltersPaginator(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersIterable responses = client.describeSubscriptionFiltersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeSubscriptionFiltersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeSubscriptionFiltersPaginator
default DescribeSubscriptionFiltersIterable describeSubscriptionFiltersPaginator(Consumer<DescribeSubscriptionFiltersRequest.Builder> describeSubscriptionFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersIterable responses = client.describeSubscriptionFiltersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeSubscriptionFiltersRequest.builder()
- Parameters:
describeSubscriptionFiltersRequest
- AConsumer
that will call methods onDescribeSubscriptionFiltersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
disassociateKmsKey
default DisassociateKmsKeyResponse disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
When you use
DisassociateKmsKey
, you specify either thelogGroupName
parameter or theresourceIdentifier
parameter. You can't specify both of those parameters in the same operation.-
Specify the
logGroupName
parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed. -
Specify the
resourceIdentifier
parameter with thequery-result
resource to stop using the KMS key to encrypt the results of all future StartQuery operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.
It can take up to 5 minutes for this operation to take effect.
- Parameters:
disassociateKmsKeyRequest
-- Returns:
- Result of the DisassociateKmsKey operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
-
disassociateKmsKey
default DisassociateKmsKeyResponse disassociateKmsKey(Consumer<DisassociateKmsKeyRequest.Builder> disassociateKmsKeyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
When you use
DisassociateKmsKey
, you specify either thelogGroupName
parameter or theresourceIdentifier
parameter. You can't specify both of those parameters in the same operation.-
Specify the
logGroupName
parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed. -
Specify the
resourceIdentifier
parameter with thequery-result
resource to stop using the KMS key to encrypt the results of all future StartQuery operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.
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 viaDisassociateKmsKeyRequest.builder()
- Parameters:
disassociateKmsKeyRequest
- AConsumer
that will call methods onDisassociateKmsKeyRequest.Builder
to create a request.- Returns:
- Result of the DisassociateKmsKey operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
-
filterLogEvents
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.
You must have the
logs:FilterLogEvents
permission to perform this operation.You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can't include both.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 specified time range. If the results include a token, that means there are more log events available. 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.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
- Parameters:
filterLogEventsRequest
-- Returns:
- Result of the FilterLogEvents operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
filterLogEvents
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.
You must have the
logs:FilterLogEvents
permission to perform this operation.You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can't include both.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 specified time range. If the results include a token, that means there are more log events available. 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.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
This is a convenience which creates an instance of the
FilterLogEventsRequest.Builder
avoiding the need to create one manually viaFilterLogEventsRequest.builder()
- Parameters:
filterLogEventsRequest
- AConsumer
that will call methods onFilterLogEventsRequest.Builder
to create a request.- Returns:
- Result of the FilterLogEvents operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
filterLogEventsPaginator
default FilterLogEventsIterable filterLogEventsPaginator(FilterLogEventsRequest filterLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsIterable responses = client.filterLogEventsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
filterLogEventsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
filterLogEventsPaginator
default FilterLogEventsIterable filterLogEventsPaginator(Consumer<FilterLogEventsRequest.Builder> filterLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsIterable responses = client.filterLogEventsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaFilterLogEventsRequest.builder()
- Parameters:
filterLogEventsRequest
- AConsumer
that will call methods onFilterLogEventsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
getDataProtectionPolicy
default GetDataProtectionPolicyResponse getDataProtectionPolicy(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest) throws InvalidParameterException, OperationAbortedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns information about a log group data protection policy.
- Parameters:
getDataProtectionPolicyRequest
-- Returns:
- Result of the GetDataProtectionPolicy operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
getDataProtectionPolicy
default GetDataProtectionPolicyResponse getDataProtectionPolicy(Consumer<GetDataProtectionPolicyRequest.Builder> getDataProtectionPolicyRequest) throws InvalidParameterException, OperationAbortedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns information about a log group data protection policy.
This is a convenience which creates an instance of the
GetDataProtectionPolicyRequest.Builder
avoiding the need to create one manually viaGetDataProtectionPolicyRequest.builder()
- Parameters:
getDataProtectionPolicyRequest
- AConsumer
that will call methods onGetDataProtectionPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetDataProtectionPolicy operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
getDelivery
default GetDeliveryResponse getDelivery(GetDeliveryRequest getDeliveryRequest) throws ResourceNotFoundException, ServiceUnavailableException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination .
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
You need to specify the delivery
id
in this operation. You can find the IDs of the deliveries in your account with the DescribeDeliveries operation.- Parameters:
getDeliveryRequest
-- Returns:
- Result of the GetDelivery operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
getDelivery
default GetDeliveryResponse getDelivery(Consumer<GetDeliveryRequest.Builder> getDeliveryRequest) throws ResourceNotFoundException, ServiceUnavailableException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination .
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
You need to specify the delivery
id
in this operation. You can find the IDs of the deliveries in your account with the DescribeDeliveries operation.
This is a convenience which creates an instance of the
GetDeliveryRequest.Builder
avoiding the need to create one manually viaGetDeliveryRequest.builder()
- Parameters:
getDeliveryRequest
- AConsumer
that will call methods onGetDeliveryRequest.Builder
to create a request.- Returns:
- Result of the GetDelivery operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
getDeliveryDestination
default GetDeliveryDestinationResponse getDeliveryDestination(GetDeliveryDestinationRequest getDeliveryDestinationRequest) throws ResourceNotFoundException, ServiceUnavailableException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves complete information about one delivery destination.
- Parameters:
getDeliveryDestinationRequest
-- Returns:
- Result of the GetDeliveryDestination operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
getDeliveryDestination
default GetDeliveryDestinationResponse getDeliveryDestination(Consumer<GetDeliveryDestinationRequest.Builder> getDeliveryDestinationRequest) throws ResourceNotFoundException, ServiceUnavailableException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves complete information about one delivery destination.
This is a convenience which creates an instance of the
GetDeliveryDestinationRequest.Builder
avoiding the need to create one manually viaGetDeliveryDestinationRequest.builder()
- Parameters:
getDeliveryDestinationRequest
- AConsumer
that will call methods onGetDeliveryDestinationRequest.Builder
to create a request.- Returns:
- Result of the GetDeliveryDestination operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
getDeliveryDestinationPolicy
default GetDeliveryDestinationPolicyResponse getDeliveryDestinationPolicy(GetDeliveryDestinationPolicyRequest getDeliveryDestinationPolicyRequest) throws ServiceUnavailableException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.
- Parameters:
getDeliveryDestinationPolicyRequest
-- Returns:
- Result of the GetDeliveryDestinationPolicy operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.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
- See Also:
- AWS API Documentation
-
getDeliveryDestinationPolicy
default GetDeliveryDestinationPolicyResponse getDeliveryDestinationPolicy(Consumer<GetDeliveryDestinationPolicyRequest.Builder> getDeliveryDestinationPolicyRequest) throws ServiceUnavailableException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.
This is a convenience which creates an instance of the
GetDeliveryDestinationPolicyRequest.Builder
avoiding the need to create one manually viaGetDeliveryDestinationPolicyRequest.builder()
- Parameters:
getDeliveryDestinationPolicyRequest
- AConsumer
that will call methods onGetDeliveryDestinationPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetDeliveryDestinationPolicy operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.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
- See Also:
- AWS API Documentation
-
getDeliverySource
default GetDeliverySourceResponse getDeliverySource(GetDeliverySourceRequest getDeliverySourceRequest) throws ResourceNotFoundException, ServiceUnavailableException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves complete information about one delivery source.
- Parameters:
getDeliverySourceRequest
-- Returns:
- Result of the GetDeliverySource operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
getDeliverySource
default GetDeliverySourceResponse getDeliverySource(Consumer<GetDeliverySourceRequest.Builder> getDeliverySourceRequest) throws ResourceNotFoundException, ServiceUnavailableException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves complete information about one delivery source.
This is a convenience which creates an instance of the
GetDeliverySourceRequest.Builder
avoiding the need to create one manually viaGetDeliverySourceRequest.builder()
- Parameters:
getDeliverySourceRequest
- AConsumer
that will call methods onGetDeliverySourceRequest.Builder
to create a request.- Returns:
- Result of the GetDeliverySource operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
getIntegration
default GetIntegrationResponse getIntegration(GetIntegrationRequest getIntegrationRequest) throws InvalidParameterException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns information about one integration between CloudWatch Logs and OpenSearch Service.
- Parameters:
getIntegrationRequest
-- Returns:
- Result of the GetIntegration operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ServiceUnavailableException
- The service cannot complete the 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
- See Also:
- AWS API Documentation
-
getIntegration
default GetIntegrationResponse getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest) throws InvalidParameterException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns information about one integration between CloudWatch Logs and OpenSearch Service.
This is a convenience which creates an instance of the
GetIntegrationRequest.Builder
avoiding the need to create one manually viaGetIntegrationRequest.builder()
- Parameters:
getIntegrationRequest
- AConsumer
that will call methods onGetIntegrationRequest.Builder
to create a request.- Returns:
- Result of the GetIntegration operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ServiceUnavailableException
- The service cannot complete the 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
- See Also:
- AWS API Documentation
-
getLogAnomalyDetector
default GetLogAnomalyDetectorResponse getLogAnomalyDetector(GetLogAnomalyDetectorRequest getLogAnomalyDetectorRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves information about the log anomaly detector that you specify.
- Parameters:
getLogAnomalyDetectorRequest
-- Returns:
- Result of the GetLogAnomalyDetector operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
getLogAnomalyDetector
default GetLogAnomalyDetectorResponse getLogAnomalyDetector(Consumer<GetLogAnomalyDetectorRequest.Builder> getLogAnomalyDetectorRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves information about the log anomaly detector that you specify.
This is a convenience which creates an instance of the
GetLogAnomalyDetectorRequest.Builder
avoiding the need to create one manually viaGetLogAnomalyDetectorRequest.builder()
- Parameters:
getLogAnomalyDetectorRequest
- AConsumer
that will call methods onGetLogAnomalyDetectorRequest.Builder
to create a request.- Returns:
- Result of the GetLogAnomalyDetector operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
getLogEvents
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.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can't include both.- Parameters:
getLogEventsRequest
-- Returns:
- Result of the GetLogEvents operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getLogEvents
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.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must include one of these two parameters, but you can't include both.
This is a convenience which creates an instance of the
GetLogEventsRequest.Builder
avoiding the need to create one manually viaGetLogEventsRequest.builder()
- Parameters:
getLogEventsRequest
- AConsumer
that will call methods onGetLogEventsRequest.Builder
to create a request.- Returns:
- Result of the GetLogEvents operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getLogEventsPaginator
default GetLogEventsIterable getLogEventsPaginator(GetLogEventsRequest getLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsIterable responses = client.getLogEventsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getLogEventsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
getLogEventsPaginator
default GetLogEventsIterable getLogEventsPaginator(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsIterable responses = client.getLogEventsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetLogEventsRequest.builder()
- Parameters:
getLogEventsRequest
- AConsumer
that will call methods onGetLogEventsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
getLogGroupFields
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. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must specify one of these parameters, but you can't specify both.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.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
- Parameters:
getLogGroupFieldsRequest
-- Returns:
- Result of the GetLogGroupFields operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getLogGroupFields
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. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
You can specify the log group to search by using either
logGroupIdentifier
orlogGroupName
. You must specify one of these parameters, but you can't specify both.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.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
This is a convenience which creates an instance of the
GetLogGroupFieldsRequest.Builder
avoiding the need to create one manually viaGetLogGroupFieldsRequest.builder()
- Parameters:
getLogGroupFieldsRequest
- AConsumer
that will call methods onGetLogGroupFieldsRequest.Builder
to create a request.- Returns:
- Result of the GetLogGroupFields operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getLogRecord
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
.- Parameters:
getLogRecordRequest
-- Returns:
- Result of the GetLogRecord operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getLogRecord
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 viaGetLogRecordRequest.builder()
- Parameters:
getLogRecordRequest
- AConsumer
that will call methods onGetLogRecordRequest.Builder
to create a request.- Returns:
- Result of the GetLogRecord operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getQueryResults
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 running a query. To run a query, use StartQuery. For more information about how long results of previous queries are available, see CloudWatch Logs quotas.If the value of the
Status
field in the output isRunning
, this operation returns only partial results. If you see a value ofScheduled
orRunning
for the status, you can retry the operation later to see the final results.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
- Parameters:
getQueryResultsRequest
-- Returns:
- Result of the GetQueryResults operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getQueryResults
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 running a query. To run a query, use StartQuery. For more information about how long results of previous queries are available, see CloudWatch Logs quotas.If the value of the
Status
field in the output isRunning
, this operation returns only partial results. If you see a value ofScheduled
orRunning
for the status, you can retry the operation later to see the final results.If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
This is a convenience which creates an instance of the
GetQueryResultsRequest.Builder
avoiding the need to create one manually viaGetQueryResultsRequest.builder()
- Parameters:
getQueryResultsRequest
- AConsumer
that will call methods onGetQueryResultsRequest.Builder
to create a request.- Returns:
- Result of the GetQueryResults operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getTransformer
default GetTransformerResponse getTransformer(GetTransformerRequest getTransformerRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns the information about the log transformer associated with this log group.
This operation returns data only for transformers created at the log group level. To get information for an account-level transformer, use DescribeAccountPolicies.
- Parameters:
getTransformerRequest
-- Returns:
- Result of the GetTransformer operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
getTransformer
default GetTransformerResponse getTransformer(Consumer<GetTransformerRequest.Builder> getTransformerRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns the information about the log transformer associated with this log group.
This operation returns data only for transformers created at the log group level. To get information for an account-level transformer, use DescribeAccountPolicies.
This is a convenience which creates an instance of the
GetTransformerRequest.Builder
avoiding the need to create one manually viaGetTransformerRequest.builder()
- Parameters:
getTransformerRequest
- AConsumer
that will call methods onGetTransformerRequest.Builder
to create a request.- Returns:
- Result of the GetTransformer operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
listAnomalies
default ListAnomaliesResponse listAnomalies(ListAnomaliesRequest listAnomaliesRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.
- Parameters:
listAnomaliesRequest
-- Returns:
- Result of the ListAnomalies operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
listAnomalies
default ListAnomaliesResponse listAnomalies(Consumer<ListAnomaliesRequest.Builder> listAnomaliesRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.
This is a convenience which creates an instance of the
ListAnomaliesRequest.Builder
avoiding the need to create one manually viaListAnomaliesRequest.builder()
- Parameters:
listAnomaliesRequest
- AConsumer
that will call methods onListAnomaliesRequest.Builder
to create a request.- Returns:
- Result of the ListAnomalies operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
listAnomaliesPaginator
default ListAnomaliesIterable listAnomaliesPaginator(ListAnomaliesRequest listAnomaliesRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
listAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesIterable responses = client.listAnomaliesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesIterable responses = client .listAnomaliesPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesIterable responses = client.listAnomaliesPaginator(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
listAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest)
operation.- Parameters:
listAnomaliesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
listAnomaliesPaginator
default ListAnomaliesIterable listAnomaliesPaginator(Consumer<ListAnomaliesRequest.Builder> listAnomaliesRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
listAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesIterable responses = client.listAnomaliesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesIterable responses = client .listAnomaliesPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesIterable responses = client.listAnomaliesPaginator(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
listAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest)
operation.
This is a convenience which creates an instance of the
ListAnomaliesRequest.Builder
avoiding the need to create one manually viaListAnomaliesRequest.builder()
- Parameters:
listAnomaliesRequest
- AConsumer
that will call methods onListAnomaliesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
listIntegrations
default ListIntegrationsResponse listIntegrations(ListIntegrationsRequest listIntegrationsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one integration can be created in an account, and this integration must be with OpenSearch Service.
- Parameters:
listIntegrationsRequest
-- Returns:
- Result of the ListIntegrations operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
listIntegrations
default ListIntegrationsResponse listIntegrations(Consumer<ListIntegrationsRequest.Builder> listIntegrationsRequest) throws InvalidParameterException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one integration can be created in an account, and this integration must be with OpenSearch Service.
This is a convenience which creates an instance of the
ListIntegrationsRequest.Builder
avoiding the need to create one manually viaListIntegrationsRequest.builder()
- Parameters:
listIntegrationsRequest
- AConsumer
that will call methods onListIntegrationsRequest.Builder
to create a request.- Returns:
- Result of the ListIntegrations operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
listLogAnomalyDetectors
default ListLogAnomalyDetectorsResponse listLogAnomalyDetectors(ListLogAnomalyDetectorsRequest listLogAnomalyDetectorsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves a list of the log anomaly detectors in the account.
- Parameters:
listLogAnomalyDetectorsRequest
-- Returns:
- Result of the ListLogAnomalyDetectors operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
listLogAnomalyDetectors
default ListLogAnomalyDetectorsResponse listLogAnomalyDetectors(Consumer<ListLogAnomalyDetectorsRequest.Builder> listLogAnomalyDetectorsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Retrieves a list of the log anomaly detectors in the account.
This is a convenience which creates an instance of the
ListLogAnomalyDetectorsRequest.Builder
avoiding the need to create one manually viaListLogAnomalyDetectorsRequest.builder()
- Parameters:
listLogAnomalyDetectorsRequest
- AConsumer
that will call methods onListLogAnomalyDetectorsRequest.Builder
to create a request.- Returns:
- Result of the ListLogAnomalyDetectors operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
listLogAnomalyDetectorsPaginator
default ListLogAnomalyDetectorsIterable listLogAnomalyDetectorsPaginator(ListLogAnomalyDetectorsRequest listLogAnomalyDetectorsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
listLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsIterable responses = client.listLogAnomalyDetectorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsIterable responses = client .listLogAnomalyDetectorsPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsIterable responses = client.listLogAnomalyDetectorsPaginator(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
listLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest)
operation.- Parameters:
listLogAnomalyDetectorsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
listLogAnomalyDetectorsPaginator
default ListLogAnomalyDetectorsIterable listLogAnomalyDetectorsPaginator(Consumer<ListLogAnomalyDetectorsRequest.Builder> listLogAnomalyDetectorsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
listLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsIterable responses = client.listLogAnomalyDetectorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsIterable responses = client .listLogAnomalyDetectorsPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsIterable responses = client.listLogAnomalyDetectorsPaginator(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
listLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest)
operation.
This is a convenience which creates an instance of the
ListLogAnomalyDetectorsRequest.Builder
avoiding the need to create one manually viaListLogAnomalyDetectorsRequest.builder()
- Parameters:
listLogAnomalyDetectorsRequest
- AConsumer
that will call methods onListLogAnomalyDetectorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
listLogGroupsForQuery
default ListLogGroupsForQueryResponse listLogGroupsForQuery(ListLogGroupsForQueryRequest listLogGroupsForQueryRequest) throws InvalidParameterException, AccessDeniedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query. This can be useful for queries that use log group name prefixes or the
filterIndex
command, because the log groups are dynamically selected in these cases.For more information about field indexes, see Create field indexes to improve query performance and reduce costs.
- Parameters:
listLogGroupsForQueryRequest
-- Returns:
- Result of the ListLogGroupsForQuery operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.AccessDeniedException
- You don't have sufficient permissions to perform this action.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
- See Also:
- AWS API Documentation
-
listLogGroupsForQuery
default ListLogGroupsForQueryResponse listLogGroupsForQuery(Consumer<ListLogGroupsForQueryRequest.Builder> listLogGroupsForQueryRequest) throws InvalidParameterException, AccessDeniedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Returns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query. This can be useful for queries that use log group name prefixes or the
filterIndex
command, because the log groups are dynamically selected in these cases.For more information about field indexes, see Create field indexes to improve query performance and reduce costs.
This is a convenience which creates an instance of the
ListLogGroupsForQueryRequest.Builder
avoiding the need to create one manually viaListLogGroupsForQueryRequest.builder()
- Parameters:
listLogGroupsForQueryRequest
- AConsumer
that will call methods onListLogGroupsForQueryRequest.Builder
to create a request.- Returns:
- Result of the ListLogGroupsForQuery operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.AccessDeniedException
- You don't have sufficient permissions to perform this action.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
- See Also:
- AWS API Documentation
-
listLogGroupsForQueryPaginator
default ListLogGroupsForQueryIterable listLogGroupsForQueryPaginator(ListLogGroupsForQueryRequest listLogGroupsForQueryRequest) throws InvalidParameterException, AccessDeniedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
listLogGroupsForQuery(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogGroupsForQueryRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogGroupsForQueryIterable responses = client.listLogGroupsForQueryPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogGroupsForQueryIterable responses = client .listLogGroupsForQueryPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.ListLogGroupsForQueryResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogGroupsForQueryIterable responses = client.listLogGroupsForQueryPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listLogGroupsForQuery(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogGroupsForQueryRequest)
operation.- Parameters:
listLogGroupsForQueryRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.AccessDeniedException
- You don't have sufficient permissions to perform this action.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
- See Also:
- AWS API Documentation
-
listLogGroupsForQueryPaginator
default ListLogGroupsForQueryIterable listLogGroupsForQueryPaginator(Consumer<ListLogGroupsForQueryRequest.Builder> listLogGroupsForQueryRequest) throws InvalidParameterException, AccessDeniedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
This is a variant of
listLogGroupsForQuery(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogGroupsForQueryRequest)
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 Streamsoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogGroupsForQueryIterable responses = client.listLogGroupsForQueryPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogGroupsForQueryIterable responses = client .listLogGroupsForQueryPaginator(request); for (software.amazon.awssdk.services.cloudwatchlogs.model.ListLogGroupsForQueryResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogGroupsForQueryIterable responses = client.listLogGroupsForQueryPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listLogGroupsForQuery(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogGroupsForQueryRequest)
operation.
This is a convenience which creates an instance of the
ListLogGroupsForQueryRequest.Builder
avoiding the need to create one manually viaListLogGroupsForQueryRequest.builder()
- Parameters:
listLogGroupsForQueryRequest
- AConsumer
that will call methods onListLogGroupsForQueryRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.AccessDeniedException
- You don't have sufficient permissions to perform this action.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
- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
listTagsLogGroup
@Deprecated default ListTagsLogGroupResponse listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest) throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deprecated.Please use the generic tagging API ListTagsForResourceThe ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
Lists the tags for the specified log group.
- Parameters:
listTagsLogGroupRequest
-- Returns:
- Result of the ListTagsLogGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
listTagsLogGroup
@Deprecated default ListTagsLogGroupResponse listTagsLogGroup(Consumer<ListTagsLogGroupRequest.Builder> listTagsLogGroupRequest) throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deprecated.Please use the generic tagging API ListTagsForResourceThe ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
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 viaListTagsLogGroupRequest.builder()
- Parameters:
listTagsLogGroupRequest
- AConsumer
that will call methods onListTagsLogGroupRequest.Builder
to create a request.- Returns:
- Result of the ListTagsLogGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
putAccountPolicy
default PutAccountPolicyResponse putAccountPolicy(PutAccountPolicyRequest putAccountPolicyRequest) throws InvalidParameterException, OperationAbortedException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates an account-level data protection policy, subscription filter policy, or field index policy that applies to all log groups or a subset of log groups in the account.
Data protection policy
A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.
Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.
If you use
PutAccountPolicy
to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the
logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with theunmask
parameter set totrue
to view the unmasked log events. Users with thelogs:Unmask
can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with theunmask
query command.For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
To use the
PutAccountPolicy
operation for a data protection policy, you must be signed on with thelogs:PutDataProtectionPolicy
andlogs:PutAccountPolicy
permissions.The
PutAccountPolicy
operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.Subscription filter policy
A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. 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 Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
-
An Firehose data stream in the same account as the subscription policy, for same-account delivery.
-
A Lambda function in the same account as the subscription policy, for same-account delivery.
-
A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
Each account can have one account-level subscription filter policy per Region. If you are updating an existing filter, you must specify the correct name in
PolicyName
. To perform aPutAccountPolicy
subscription filter operation for any destination except a Lambda function, you must also have theiam:PassRole
permission.Transformer policy
Creates or updates a log transformer policy for your account. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contain relevant, source-specific information. After you have created a transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters.
You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region.
A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. For more information about the available processors to use in a transformer, see Processors that you can use.
Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.
You can create transformers only for the log groups in the Standard log class.
You can have one account-level transformer policy that applies to all log groups in the account. Or you can create as many as 20 account-level transformer policies that are each scoped to a subset of log groups with the
selectionCriteria
parameter. If you have multiple account-level transformer policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start withmy-log
, you can't have another field index policy filtered tomy-logpprod
ormy-logging
.You can also set up a transformer at the log-group level. For more information, see PutTransformer. If there is both a log-group level transformer created with
PutTransformer
and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer.Field index policy
You can use field index policies to create indexes on fields found in log events in the log group. Creating field indexes can help lower the scan volume for CloudWatch Logs Insights queries that reference those fields, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, user IDs, or instance IDs. For more information, see Create field indexes to improve query performance and reduce costs
To find the fields that are in your log group events, use the GetLogGroupFields operation.
For example, suppose you have created a field index for
requestId
. Then, any CloudWatch Logs Insights query on that log group that includesrequestId = value
orrequestId in [value, value, ...]
will attempt to process only the log events where the indexed field matches the specified value.Matches of log events to the names of indexed fields are case-sensitive. For example, an indexed field of
RequestId
won't match a log event containingrequestId
.You can have one account-level field index policy that applies to all log groups in the account. Or you can create as many as 20 account-level field index policies that are each scoped to a subset of log groups with the
selectionCriteria
parameter. If you have multiple account-level index policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start withmy-log
, you can't have another field index policy filtered tomy-logpprod
ormy-logging
.If you create an account-level field index policy in a monitoring account in cross-account observability, the policy is applied only to the monitoring account and not to any source accounts.
If you want to create a field index policy for a single log group, you can use PutIndexPolicy instead of
PutAccountPolicy
. If you do so, that log group will use only that log-group level policy, and will ignore the account-level policy that you create with PutAccountPolicy.- Parameters:
putAccountPolicyRequest
-- Returns:
- Result of the PutAccountPolicy operation returned by the service.
- Throws:
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.LimitExceededException
- You have reached the maximum number of resources that can be created.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
- See Also:
- AWS API Documentation
-
-
putAccountPolicy
default PutAccountPolicyResponse putAccountPolicy(Consumer<PutAccountPolicyRequest.Builder> putAccountPolicyRequest) throws InvalidParameterException, OperationAbortedException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates an account-level data protection policy, subscription filter policy, or field index policy that applies to all log groups or a subset of log groups in the account.
Data protection policy
A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.
Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.
If you use
PutAccountPolicy
to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the
logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with theunmask
parameter set totrue
to view the unmasked log events. Users with thelogs:Unmask
can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with theunmask
query command.For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
To use the
PutAccountPolicy
operation for a data protection policy, you must be signed on with thelogs:PutDataProtectionPolicy
andlogs:PutAccountPolicy
permissions.The
PutAccountPolicy
operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.Subscription filter policy
A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. 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 Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
-
An Firehose data stream in the same account as the subscription policy, for same-account delivery.
-
A Lambda function in the same account as the subscription policy, for same-account delivery.
-
A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
Each account can have one account-level subscription filter policy per Region. If you are updating an existing filter, you must specify the correct name in
PolicyName
. To perform aPutAccountPolicy
subscription filter operation for any destination except a Lambda function, you must also have theiam:PassRole
permission.Transformer policy
Creates or updates a log transformer policy for your account. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contain relevant, source-specific information. After you have created a transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters.
You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region.
A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. For more information about the available processors to use in a transformer, see Processors that you can use.
Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.
You can create transformers only for the log groups in the Standard log class.
You can have one account-level transformer policy that applies to all log groups in the account. Or you can create as many as 20 account-level transformer policies that are each scoped to a subset of log groups with the
selectionCriteria
parameter. If you have multiple account-level transformer policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start withmy-log
, you can't have another field index policy filtered tomy-logpprod
ormy-logging
.You can also set up a transformer at the log-group level. For more information, see PutTransformer. If there is both a log-group level transformer created with
PutTransformer
and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer.Field index policy
You can use field index policies to create indexes on fields found in log events in the log group. Creating field indexes can help lower the scan volume for CloudWatch Logs Insights queries that reference those fields, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, user IDs, or instance IDs. For more information, see Create field indexes to improve query performance and reduce costs
To find the fields that are in your log group events, use the GetLogGroupFields operation.
For example, suppose you have created a field index for
requestId
. Then, any CloudWatch Logs Insights query on that log group that includesrequestId = value
orrequestId in [value, value, ...]
will attempt to process only the log events where the indexed field matches the specified value.Matches of log events to the names of indexed fields are case-sensitive. For example, an indexed field of
RequestId
won't match a log event containingrequestId
.You can have one account-level field index policy that applies to all log groups in the account. Or you can create as many as 20 account-level field index policies that are each scoped to a subset of log groups with the
selectionCriteria
parameter. If you have multiple account-level index policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start withmy-log
, you can't have another field index policy filtered tomy-logpprod
ormy-logging
.If you create an account-level field index policy in a monitoring account in cross-account observability, the policy is applied only to the monitoring account and not to any source accounts.
If you want to create a field index policy for a single log group, you can use PutIndexPolicy instead of
PutAccountPolicy
. If you do so, that log group will use only that log-group level policy, and will ignore the account-level policy that you create with PutAccountPolicy.
This is a convenience which creates an instance of the
PutAccountPolicyRequest.Builder
avoiding the need to create one manually viaPutAccountPolicyRequest.builder()
- Parameters:
putAccountPolicyRequest
- AConsumer
that will call methods onPutAccountPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutAccountPolicy operation returned by the service.
- Throws:
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.LimitExceededException
- You have reached the maximum number of resources that can be created.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
- See Also:
- AWS API Documentation
-
-
putDataProtectionPolicy
default PutDataProtectionPolicyResponse putDataProtectionPolicy(PutDataProtectionPolicyRequest putDataProtectionPolicyRequest) throws InvalidParameterException, LimitExceededException, OperationAbortedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.
Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the
logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with theunmask
parameter set totrue
to view the unmasked log events. Users with thelogs:Unmask
can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with theunmask
query command.For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
The
PutDataProtectionPolicy
operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.- Parameters:
putDataProtectionPolicyRequest
-- Returns:
- Result of the PutDataProtectionPolicy operation returned by the service.
- Throws:
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.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
- See Also:
- AWS API Documentation
-
putDataProtectionPolicy
default PutDataProtectionPolicyResponse putDataProtectionPolicy(Consumer<PutDataProtectionPolicyRequest.Builder> putDataProtectionPolicyRequest) throws InvalidParameterException, LimitExceededException, OperationAbortedException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.
Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the
logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with theunmask
parameter set totrue
to view the unmasked log events. Users with thelogs:Unmask
can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with theunmask
query command.For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
The
PutDataProtectionPolicy
operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.
This is a convenience which creates an instance of the
PutDataProtectionPolicyRequest.Builder
avoiding the need to create one manually viaPutDataProtectionPolicyRequest.builder()
- Parameters:
putDataProtectionPolicyRequest
- AConsumer
that will call methods onPutDataProtectionPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutDataProtectionPolicy operation returned by the service.
- Throws:
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.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
- See Also:
- AWS API Documentation
-
putDeliveryDestination
default PutDeliveryDestinationResponse putDeliveryDestination(PutDeliveryDestinationRequest putDeliveryDestinationRequest) throws ServiceUnavailableException, ConflictException, ValidationException, ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
-
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
-
Use
PutDeliveryDestination
to create a delivery destination, which is a logical object that represents the actual delivery destination. -
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
-
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.
- Parameters:
putDeliveryDestinationRequest
-- Returns:
- Result of the PutDeliveryDestination operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
-
putDeliveryDestination
default PutDeliveryDestinationResponse putDeliveryDestination(Consumer<PutDeliveryDestinationRequest.Builder> putDeliveryDestinationRequest) throws ServiceUnavailableException, ConflictException, ValidationException, ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
-
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
-
Use
PutDeliveryDestination
to create a delivery destination, which is a logical object that represents the actual delivery destination. -
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
-
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.
This is a convenience which creates an instance of the
PutDeliveryDestinationRequest.Builder
avoiding the need to create one manually viaPutDeliveryDestinationRequest.builder()
- Parameters:
putDeliveryDestinationRequest
- AConsumer
that will call methods onPutDeliveryDestinationRequest.Builder
to create a request.- Returns:
- Result of the PutDeliveryDestination operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
-
putDeliveryDestinationPolicy
default PutDeliveryDestinationPolicyResponse putDeliveryDestinationPolicy(PutDeliveryDestinationPolicyRequest putDeliveryDestinationPolicyRequest) throws ServiceUnavailableException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:
-
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
-
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
-
Use this operation in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
-
Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies.
- Parameters:
putDeliveryDestinationPolicyRequest
-- Returns:
- Result of the PutDeliveryDestinationPolicy operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ResourceNotFoundException
- The specified resource does not exist.ConflictException
- This operation attempted to create a resource that 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
- See Also:
- AWS API Documentation
-
-
putDeliveryDestinationPolicy
default PutDeliveryDestinationPolicyResponse putDeliveryDestinationPolicy(Consumer<PutDeliveryDestinationPolicyRequest.Builder> putDeliveryDestinationPolicyRequest) throws ServiceUnavailableException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:
-
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
-
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
-
Use this operation in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
-
Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies.
This is a convenience which creates an instance of the
PutDeliveryDestinationPolicyRequest.Builder
avoiding the need to create one manually viaPutDeliveryDestinationPolicyRequest.builder()
- Parameters:
putDeliveryDestinationPolicyRequest
- AConsumer
that will call methods onPutDeliveryDestinationPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutDeliveryDestinationPolicy operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ValidationException
- One of the parameters for the request is not valid.ResourceNotFoundException
- The specified resource does not exist.ConflictException
- This operation attempted to create a resource that 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
- See Also:
- AWS API Documentation
-
-
putDeliverySource
default PutDeliverySourceResponse putDeliverySource(PutDeliverySourceRequest putDeliverySourceRequest) throws ServiceUnavailableException, ConflictException, ValidationException, ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:
-
Use
PutDeliverySource
to create a delivery source, which is a logical object that represents the resource that is actually sending the logs. -
Use
PutDeliveryDestination
to create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination. -
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
-
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify.
- Parameters:
putDeliverySourceRequest
-- Returns:
- Result of the PutDeliverySource operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
-
putDeliverySource
default PutDeliverySourceResponse putDeliverySource(Consumer<PutDeliverySourceRequest.Builder> putDeliverySourceRequest) throws ServiceUnavailableException, ConflictException, ValidationException, ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:
-
Use
PutDeliverySource
to create a delivery source, which is a logical object that represents the resource that is actually sending the logs. -
Use
PutDeliveryDestination
to create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination. -
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
-
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify.
This is a convenience which creates an instance of the
PutDeliverySourceRequest.Builder
avoiding the need to create one manually viaPutDeliverySourceRequest.builder()
- Parameters:
putDeliverySourceRequest
- AConsumer
that will call methods onPutDeliverySourceRequest.Builder
to create a request.- Returns:
- Result of the PutDeliverySource operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ValidationException
- One of the parameters for the request is not valid.ServiceQuotaExceededException
- This request exceeds a service quota.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
-
putDestination
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). With a destination, you can 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 afterPutDestination
.To perform a
PutDestination
operation, you must also have theiam:PassRole
permission.- Parameters:
putDestinationRequest
-- Returns:
- Result of the PutDestination operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
putDestination
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). With a destination, you can 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 afterPutDestination
.To perform a
PutDestination
operation, you must also have theiam:PassRole
permission.
This is a convenience which creates an instance of the
PutDestinationRequest.Builder
avoiding the need to create one manually viaPutDestinationRequest.builder()
- Parameters:
putDestinationRequest
- AConsumer
that will call methods onPutDestinationRequest.Builder
to create a request.- Returns:
- Result of the PutDestination operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
putDestinationPolicy
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.
- Parameters:
putDestinationPolicyRequest
-- Returns:
- Result of the PutDestinationPolicy operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
putDestinationPolicy
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.
This is a convenience which creates an instance of the
PutDestinationPolicyRequest.Builder
avoiding the need to create one manually viaPutDestinationPolicyRequest.builder()
- Parameters:
putDestinationPolicyRequest
- AConsumer
that will call methods onPutDestinationPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutDestinationPolicy operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
putIndexPolicy
default PutIndexPolicyResponse putIndexPolicy(PutIndexPolicyRequest putIndexPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a field index policy for the specified log group. Only log groups in the Standard log class support field index policies. For more information about log classes, see Log classes.
You can use field index policies to create field indexes on fields found in log events in the log group. Creating field indexes speeds up and lowers the costs for CloudWatch Logs Insights queries that reference those field indexes, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, userID, and instance IDs. For more information, see Create field indexes to improve query performance and reduce costs.
To find the fields that are in your log group events, use the GetLogGroupFields operation.
For example, suppose you have created a field index for
requestId
. Then, any CloudWatch Logs Insights query on that log group that includesrequestId = value
orrequestId IN [value, value, ...]
will process fewer log events to reduce costs, and have improved performance.Each index policy has the following quotas and restrictions:
-
As many as 20 fields can be included in the policy.
-
Each field name can include as many as 100 characters.
Matches of log events to the names of indexed fields are case-sensitive. For example, a field index of
RequestId
won't match a log event containingrequestId
.Log group-level field index policies created with
PutIndexPolicy
override account-level field index policies created with PutAccountPolicy. If you usePutIndexPolicy
to create a field index policy for a log group, that log group uses only that policy. The log group ignores any account-wide field index policy that you might have created.- Parameters:
putIndexPolicyRequest
-- Returns:
- Result of the PutIndexPolicy operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.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
- See Also:
- AWS API Documentation
-
-
putIndexPolicy
default PutIndexPolicyResponse putIndexPolicy(Consumer<PutIndexPolicyRequest.Builder> putIndexPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a field index policy for the specified log group. Only log groups in the Standard log class support field index policies. For more information about log classes, see Log classes.
You can use field index policies to create field indexes on fields found in log events in the log group. Creating field indexes speeds up and lowers the costs for CloudWatch Logs Insights queries that reference those field indexes, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, userID, and instance IDs. For more information, see Create field indexes to improve query performance and reduce costs.
To find the fields that are in your log group events, use the GetLogGroupFields operation.
For example, suppose you have created a field index for
requestId
. Then, any CloudWatch Logs Insights query on that log group that includesrequestId = value
orrequestId IN [value, value, ...]
will process fewer log events to reduce costs, and have improved performance.Each index policy has the following quotas and restrictions:
-
As many as 20 fields can be included in the policy.
-
Each field name can include as many as 100 characters.
Matches of log events to the names of indexed fields are case-sensitive. For example, a field index of
RequestId
won't match a log event containingrequestId
.Log group-level field index policies created with
PutIndexPolicy
override account-level field index policies created with PutAccountPolicy. If you usePutIndexPolicy
to create a field index policy for a log group, that log group uses only that policy. The log group ignores any account-wide field index policy that you might have created.
This is a convenience which creates an instance of the
PutIndexPolicyRequest.Builder
avoiding the need to create one manually viaPutIndexPolicyRequest.builder()
- Parameters:
putIndexPolicyRequest
- AConsumer
that will call methods onPutIndexPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutIndexPolicy operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.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
- See Also:
- AWS API Documentation
-
-
putIntegration
default PutIntegrationResponse putIntegration(PutIntegrationRequest putIntegrationRequest) throws InvalidParameterException, LimitExceededException, ServiceUnavailableException, ValidationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with OpenSearch Service are supported, and currently you can have only one integration in your account.
Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered by OpenSearch Service analytics. For more information, see Vended log dashboards powered by Amazon OpenSearch Service.
You can use this operation only to create a new integration. You can't modify an existing integration.
- Parameters:
putIntegrationRequest
-- Returns:
- Result of the PutIntegration operation returned by the service.
- Throws:
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.ValidationException
- One of the parameters for the request is not valid.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
- See Also:
- AWS API Documentation
-
putIntegration
default PutIntegrationResponse putIntegration(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest) throws InvalidParameterException, LimitExceededException, ServiceUnavailableException, ValidationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with OpenSearch Service are supported, and currently you can have only one integration in your account.
Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered by OpenSearch Service analytics. For more information, see Vended log dashboards powered by Amazon OpenSearch Service.
You can use this operation only to create a new integration. You can't modify an existing integration.
This is a convenience which creates an instance of the
PutIntegrationRequest.Builder
avoiding the need to create one manually viaPutIntegrationRequest.builder()
- Parameters:
putIntegrationRequest
- AConsumer
that will call methods onPutIntegrationRequest.Builder
to create a request.- Returns:
- Result of the PutIntegration operation returned by the service.
- Throws:
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.ValidationException
- One of the parameters for the request is not valid.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
- See Also:
- AWS API Documentation
-
putLogEvents
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.
The sequence token is now ignored in
PutLogEvents
actions.PutLogEvents
actions are always accepted and never returnInvalidSequenceTokenException
orDataAlreadyAcceptedException
even if the sequence token is not valid. You can use parallelPutLogEvents
actions on the same log stream.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 more than 14 days in the past. Also, none of the log events can be from earlier 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 that 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.
-
Each log event can be no larger than 256 KB.
-
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead,
PutLogEvents
actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.
If a call to
PutLogEvents
returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.- Parameters:
putLogEventsRequest
-- Returns:
- Result of the PutLogEvents operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.InvalidSequenceTokenException
- The sequence token is not valid. You can get the correct sequence token in theexpectedSequenceToken
field in theInvalidSequenceTokenException
message.PutLogEvents
actions are now always accepted and never returnInvalidSequenceTokenException
regardless of receiving an invalid sequence token.DataAlreadyAcceptedException
- The event was already logged.PutLogEvents
actions are now always accepted and never returnDataAlreadyAcceptedException
regardless of whether a given batch of log events has already been accepted.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.UnrecognizedClientException
- The most likely cause is an Amazon Web Services access key ID or secret key that's not valid.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
- See Also:
- AWS API Documentation
-
-
putLogEvents
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.
The sequence token is now ignored in
PutLogEvents
actions.PutLogEvents
actions are always accepted and never returnInvalidSequenceTokenException
orDataAlreadyAcceptedException
even if the sequence token is not valid. You can use parallelPutLogEvents
actions on the same log stream.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 more than 14 days in the past. Also, none of the log events can be from earlier 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 that 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.
-
Each log event can be no larger than 256 KB.
-
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead,
PutLogEvents
actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.
If a call to
PutLogEvents
returns "UnrecognizedClientException" the most likely cause is a non-valid 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 viaPutLogEventsRequest.builder()
- Parameters:
putLogEventsRequest
- AConsumer
that will call methods onPutLogEventsRequest.Builder
to create a request.- Returns:
- Result of the PutLogEvents operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.InvalidSequenceTokenException
- The sequence token is not valid. You can get the correct sequence token in theexpectedSequenceToken
field in theInvalidSequenceTokenException
message.PutLogEvents
actions are now always accepted and never returnInvalidSequenceTokenException
regardless of receiving an invalid sequence token.DataAlreadyAcceptedException
- The event was already logged.PutLogEvents
actions are now always accepted and never returnDataAlreadyAcceptedException
regardless of whether a given batch of log events has already been accepted.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.UnrecognizedClientException
- The most likely cause is an Amazon Web Services access key ID or secret key that's not valid.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
- See Also:
- AWS API Documentation
-
-
putMetricFilter
default PutMetricFilterResponse putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, LimitExceededException, ServiceUnavailableException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can 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.
Using regular expressions to create metric filters is supported. For these filters, there is a quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in metric filters, see Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
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
orrequestID
as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.
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.
- Parameters:
putMetricFilterRequest
-- Returns:
- Result of the PutMetricFilter operation returned by the service.
- Throws:
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.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
putMetricFilter
default PutMetricFilterResponse putMetricFilter(Consumer<PutMetricFilterRequest.Builder> putMetricFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, LimitExceededException, ServiceUnavailableException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can 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.
Using regular expressions to create metric filters is supported. For these filters, there is a quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in metric filters, see Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
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
orrequestID
as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.
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 viaPutMetricFilterRequest.builder()
- Parameters:
putMetricFilterRequest
- AConsumer
that will call methods onPutMetricFilterRequest.Builder
to create a request.- Returns:
- Result of the PutMetricFilter operation returned by the service.
- Throws:
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.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
putQueryDefinition
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 ofname
,queryString
, andlogGroupNames
are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify thelogGroupNames
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.- Parameters:
putQueryDefinitionRequest
-- Returns:
- Result of the PutQueryDefinition operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
putQueryDefinition
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 ofname
,queryString
, andlogGroupNames
are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify thelogGroupNames
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 viaPutQueryDefinitionRequest.builder()
- Parameters:
putQueryDefinitionRequest
- AConsumer
that will call methods onPutQueryDefinitionRequest.Builder
to create a request.- Returns:
- Result of the PutQueryDefinition operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
putResourcePolicy
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.
- Parameters:
putResourcePolicyRequest
-- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
putResourcePolicy
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 viaPutResourcePolicyRequest.builder()
- Parameters:
putResourcePolicyRequest
- AConsumer
that will call methods onPutResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
putRetentionPolicy
default PutRetentionPolicyResponse putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
CloudWatch Logs doesn't immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven't been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
When log events reach their retention setting they are marked for deletion. After they are marked for deletion, they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These log events marked for deletion are also not included when you use an API to retrieve the
storedBytes
value to see how many bytes a log group is storing.- Parameters:
putRetentionPolicyRequest
-- Returns:
- Result of the PutRetentionPolicy operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
putRetentionPolicy
default PutRetentionPolicyResponse putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
CloudWatch Logs doesn't immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven't been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
When log events reach their retention setting they are marked for deletion. After they are marked for deletion, they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These log events marked for deletion are also not included when you use an API to retrieve the
storedBytes
value to see how many bytes a log group is storing.
This is a convenience which creates an instance of the
PutRetentionPolicyRequest.Builder
avoiding the need to create one manually viaPutRetentionPolicyRequest.builder()
- Parameters:
putRetentionPolicyRequest
- AConsumer
that will call methods onPutRetentionPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutRetentionPolicy operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
putSubscriptionFilter
default PutSubscriptionFilterResponse putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, LimitExceededException, ServiceUnavailableException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can 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 data stream belonging to the same account as the subscription filter, for same-account delivery.
-
A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.
-
An Amazon Kinesis Data 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
.Using regular expressions to create subscription filters is supported. For these filters, there is a quotas of quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in subscription filters, see Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
To perform a
PutSubscriptionFilter
operation for any destination except a Lambda function, you must also have theiam:PassRole
permission.- Parameters:
putSubscriptionFilterRequest
-- Returns:
- Result of the PutSubscriptionFilter operation returned by the service.
- Throws:
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.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
-
putSubscriptionFilter
default PutSubscriptionFilterResponse putSubscriptionFilter(Consumer<PutSubscriptionFilterRequest.Builder> putSubscriptionFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, LimitExceededException, ServiceUnavailableException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can 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 data stream belonging to the same account as the subscription filter, for same-account delivery.
-
A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.
-
An Amazon Kinesis Data 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
.Using regular expressions to create subscription filters is supported. For these filters, there is a quotas of quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in subscription filters, see Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
To perform a
PutSubscriptionFilter
operation for any destination except a Lambda function, you must also have theiam:PassRole
permission.
This is a convenience which creates an instance of the
PutSubscriptionFilterRequest.Builder
avoiding the need to create one manually viaPutSubscriptionFilterRequest.builder()
- Parameters:
putSubscriptionFilterRequest
- AConsumer
that will call methods onPutSubscriptionFilterRequest.Builder
to create a request.- Returns:
- Result of the PutSubscriptionFilter operation returned by the service.
- Throws:
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.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
-
putTransformer
default PutTransformerResponse putTransformer(PutTransformerRequest putTransformerRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, LimitExceededException, OperationAbortedException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a log transformer for a single log group. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contains relevant, source-specific information.
After you have created a transformer, CloudWatch Logs performs the transformations at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filers.
You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region.
A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. The processors work one after another, in the order that you list them, like a pipeline. For more information about the available processors to use in a transformer, see Processors that you can use.
Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.
You can create transformers only for the log groups in the Standard log class.
You can also set up a transformer at the account level. For more information, see PutAccountPolicy. If there is both a log-group level transformer created with
PutTransformer
and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer.- Parameters:
putTransformerRequest
-- Returns:
- Result of the PutTransformer operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.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.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
putTransformer
default PutTransformerResponse putTransformer(Consumer<PutTransformerRequest.Builder> putTransformerRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, LimitExceededException, OperationAbortedException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Creates or updates a log transformer for a single log group. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contains relevant, source-specific information.
After you have created a transformer, CloudWatch Logs performs the transformations at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filers.
You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region.
A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. The processors work one after another, in the order that you list them, like a pipeline. For more information about the available processors to use in a transformer, see Processors that you can use.
Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.
You can create transformers only for the log groups in the Standard log class.
You can also set up a transformer at the account level. For more information, see PutAccountPolicy. If there is both a log-group level transformer created with
PutTransformer
and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer.
This is a convenience which creates an instance of the
PutTransformerRequest.Builder
avoiding the need to create one manually viaPutTransformerRequest.builder()
- Parameters:
putTransformerRequest
- AConsumer
that will call methods onPutTransformerRequest.Builder
to create a request.- Returns:
- Result of the PutTransformer operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.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.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
startQuery
default StartQueryResponse startQuery(StartQueryRequest startQueryRequest) throws MalformedQueryException, InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Starts a query of one or more log groups using CloudWatch Logs Insights. You specify the log groups and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
After you run a query using
StartQuery
, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using thequeryId
thatStartQuery
returns.To specify the log groups to query, a
StartQuery
operation must include one of the following:-
Either exactly one of the following parameters:
logGroupName
,logGroupNames
, orlogGroupIdentifiers
-
Or the
queryString
must include aSOURCE
command to select log groups for the query. TheSOURCE
command can select log groups based on log group name prefix, account ID, and log class.For more information about the
SOURCE
command, see SOURCE.
If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.
Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account
StartQuery
operation, the query definition must be defined in the monitoring account.You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
- Parameters:
startQueryRequest
-- Returns:
- Result of the StartQuery operation returned by the service.
- Throws:
MalformedQueryException
- The query string is not valid. Details about this error are displayed in aQueryCompileError
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
- See Also:
- AWS API Documentation
-
-
startQuery
default StartQueryResponse startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest) throws MalformedQueryException, InvalidParameterException, LimitExceededException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Starts a query of one or more log groups using CloudWatch Logs Insights. You specify the log groups and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
After you run a query using
StartQuery
, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using thequeryId
thatStartQuery
returns.To specify the log groups to query, a
StartQuery
operation must include one of the following:-
Either exactly one of the following parameters:
logGroupName
,logGroupNames
, orlogGroupIdentifiers
-
Or the
queryString
must include aSOURCE
command to select log groups for the query. TheSOURCE
command can select log groups based on log group name prefix, account ID, and log class.For more information about the
SOURCE
command, see SOURCE.
If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.
Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account
StartQuery
operation, the query definition must be defined in the monitoring account.You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
This is a convenience which creates an instance of the
StartQueryRequest.Builder
avoiding the need to create one manually viaStartQueryRequest.builder()
- Parameters:
startQueryRequest
- AConsumer
that will call methods onStartQueryRequest.Builder
to create a request.- Returns:
- Result of the StartQuery operation returned by the service.
- Throws:
MalformedQueryException
- The query string is not valid. Details about this error are displayed in aQueryCompileError
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
- See Also:
- AWS API Documentation
-
-
stopQuery
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.
- Parameters:
stopQueryRequest
-- Returns:
- Result of the StopQuery operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
stopQuery
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 viaStopQueryRequest.builder()
- Parameters:
stopQueryRequest
- AConsumer
that will call methods onStopQueryRequest.Builder
to create a request.- Returns:
- Result of the StopQuery operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
tagLogGroup
@Deprecated default TagLogGroupResponse tagLogGroup(TagLogGroupRequest tagLogGroupRequest) throws ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deprecated.Please use the generic tagging API TagResourceThe TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
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
oraws:TagKeys
condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.- Parameters:
tagLogGroupRequest
-- Returns:
- Result of the TagLogGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
tagLogGroup
@Deprecated default TagLogGroupResponse tagLogGroup(Consumer<TagLogGroupRequest.Builder> tagLogGroupRequest) throws ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deprecated.Please use the generic tagging API TagResourceThe TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
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
oraws: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 viaTagLogGroupRequest.builder()
- Parameters:
tagLogGroupRequest
- AConsumer
that will call methods onTagLogGroupRequest.Builder
to create a request.- Returns:
- Result of the TagLogGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, TooManyTagsException, AwsServiceException, SdkClientException, CloudWatchLogsException
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the
TagResource
action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a CloudWatch Logs resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.TooManyTagsException
- A resource can have no more than 50 tags.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
- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, TooManyTagsException, AwsServiceException, SdkClientException, CloudWatchLogsException
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the
TagResource
action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a CloudWatch Logs resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.TooManyTagsException
- A resource can have no more than 50 tags.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
- See Also:
- AWS API Documentation
-
testMetricFilter
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.
- Parameters:
testMetricFilterRequest
-- Returns:
- Result of the TestMetricFilter operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
testMetricFilter
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 viaTestMetricFilterRequest.builder()
- Parameters:
testMetricFilterRequest
- AConsumer
that will call methods onTestMetricFilterRequest.Builder
to create a request.- Returns:
- Result of the TestMetricFilter operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
testTransformer
default TestTransformerResponse testTransformer(TestTransformerRequest testTransformerRequest) throws InvalidParameterException, ServiceUnavailableException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Use this operation to test a log transformer. You enter the transformer configuration and a set of log events to test with. The operation responds with an array that includes the original log events and the transformed versions.
- Parameters:
testTransformerRequest
-- Returns:
- Result of the TestTransformer operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ServiceUnavailableException
- The service cannot complete the request.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
testTransformer
default TestTransformerResponse testTransformer(Consumer<TestTransformerRequest.Builder> testTransformerRequest) throws InvalidParameterException, ServiceUnavailableException, InvalidOperationException, AwsServiceException, SdkClientException, CloudWatchLogsException
Use this operation to test a log transformer. You enter the transformer configuration and a set of log events to test with. The operation responds with an array that includes the original log events and the transformed versions.
This is a convenience which creates an instance of the
TestTransformerRequest.Builder
avoiding the need to create one manually viaTestTransformerRequest.builder()
- Parameters:
testTransformerRequest
- AConsumer
that will call methods onTestTransformerRequest.Builder
to create a request.- Returns:
- Result of the TestTransformer operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ServiceUnavailableException
- The service cannot complete the request.InvalidOperationException
- The operation is not valid on the specified resource.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
- See Also:
- AWS API Documentation
-
untagLogGroup
@Deprecated default UntagLogGroupResponse untagLogGroup(UntagLogGroupRequest untagLogGroupRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deprecated.Please use the generic tagging API UntagResourceThe UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.
CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to log groups using the
aws:Resource/key-name
oraws:TagKeys
condition keys.- Parameters:
untagLogGroupRequest
-- Returns:
- Result of the UntagLogGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
untagLogGroup
@Deprecated default UntagLogGroupResponse untagLogGroup(Consumer<UntagLogGroupRequest.Builder> untagLogGroupRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchLogsException
Deprecated.Please use the generic tagging API UntagResourceThe UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.
CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to log groups using the
aws:Resource/key-name
oraws:TagKeys
condition keys.
This is a convenience which creates an instance of the
UntagLogGroupRequest.Builder
avoiding the need to create one manually viaUntagLogGroupRequest.builder()
- Parameters:
untagLogGroupRequest
- AConsumer
that will call methods onUntagLogGroupRequest.Builder
to create a request.- Returns:
- Result of the UntagLogGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Removes one or more tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, CloudWatchLogsException
Removes one or more tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
updateAnomaly
default UpdateAnomalyResponse updateAnomaly(UpdateAnomalyRequest updateAnomalyRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won't report new occurrences of that anomaly and won't update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won't report any anomalies related to that pattern.
You must specify either
anomalyId
orpatternId
, but you can't specify both parameters in the same operation.If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to stop suppressing, and omit the
suppressionType
andsuppressionPeriod
parameters.- Parameters:
updateAnomalyRequest
-- Returns:
- Result of the UpdateAnomaly operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
updateAnomaly
default UpdateAnomalyResponse updateAnomaly(Consumer<UpdateAnomalyRequest.Builder> updateAnomalyRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won't report new occurrences of that anomaly and won't update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won't report any anomalies related to that pattern.
You must specify either
anomalyId
orpatternId
, but you can't specify both parameters in the same operation.If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to stop suppressing, and omit the
suppressionType
andsuppressionPeriod
parameters.
This is a convenience which creates an instance of the
UpdateAnomalyRequest.Builder
avoiding the need to create one manually viaUpdateAnomalyRequest.builder()
- Parameters:
updateAnomalyRequest
- AConsumer
that will call methods onUpdateAnomalyRequest.Builder
to create a request.- Returns:
- Result of the UpdateAnomaly operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
updateDeliveryConfiguration
default UpdateDeliveryConfigurationResponse updateDeliveryConfiguration(UpdateDeliveryConfigurationRequest updateDeliveryConfigurationRequest) throws ServiceUnavailableException, ConflictException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Use this operation to update the configuration of a delivery to change either the S3 path pattern or the format of the delivered logs. You can't use this operation to change the source or destination of the delivery.
- Parameters:
updateDeliveryConfigurationRequest
-- Returns:
- Result of the UpdateDeliveryConfiguration operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ResourceNotFoundException
- The specified resource does not exist.ValidationException
- One of the parameters for the request is not valid.AccessDeniedException
- You don't have sufficient permissions to perform this action.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
updateDeliveryConfiguration
default UpdateDeliveryConfigurationResponse updateDeliveryConfiguration(Consumer<UpdateDeliveryConfigurationRequest.Builder> updateDeliveryConfigurationRequest) throws ServiceUnavailableException, ConflictException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, CloudWatchLogsException
Use this operation to update the configuration of a delivery to change either the S3 path pattern or the format of the delivered logs. You can't use this operation to change the source or destination of the delivery.
This is a convenience which creates an instance of the
UpdateDeliveryConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateDeliveryConfigurationRequest.builder()
- Parameters:
updateDeliveryConfigurationRequest
- AConsumer
that will call methods onUpdateDeliveryConfigurationRequest.Builder
to create a request.- Returns:
- Result of the UpdateDeliveryConfiguration operation returned by the service.
- Throws:
ServiceUnavailableException
- The service cannot complete the request.ConflictException
- This operation attempted to create a resource that already exists.ResourceNotFoundException
- The specified resource does not exist.ValidationException
- One of the parameters for the request is not valid.AccessDeniedException
- You don't have sufficient permissions to perform this action.ThrottlingException
- The request was throttled because of quota limits.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
- See Also:
- AWS API Documentation
-
updateLogAnomalyDetector
default UpdateLogAnomalyDetectorResponse updateLogAnomalyDetector(UpdateLogAnomalyDetectorRequest updateLogAnomalyDetectorRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Updates an existing log anomaly detector.
- Parameters:
updateLogAnomalyDetectorRequest
-- Returns:
- Result of the UpdateLogAnomalyDetector operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
updateLogAnomalyDetector
default UpdateLogAnomalyDetectorResponse updateLogAnomalyDetector(Consumer<UpdateLogAnomalyDetectorRequest.Builder> updateLogAnomalyDetectorRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, OperationAbortedException, AwsServiceException, SdkClientException, CloudWatchLogsException
Updates an existing log anomaly detector.
This is a convenience which creates an instance of the
UpdateLogAnomalyDetectorRequest.Builder
avoiding the need to create one manually viaUpdateLogAnomalyDetectorRequest.builder()
- Parameters:
updateLogAnomalyDetectorRequest
- AConsumer
that will call methods onUpdateLogAnomalyDetectorRequest.Builder
to create a request.- Returns:
- Result of the UpdateLogAnomalyDetector operation returned by the service.
- Throws:
InvalidParameterException
- A parameter is specified incorrectly.ResourceNotFoundException
- The specified resource does not exist.ServiceUnavailableException
- The service cannot complete the request.OperationAbortedException
- Multiple concurrent requests to update the same resource were in conflict.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
- See Also:
- AWS API Documentation
-
create
static CloudWatchLogsClient create()
Create aCloudWatchLogsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.
-
builder
static CloudWatchLogsClientBuilder builder()
Create a builder that can be used to configure and create aCloudWatchLogsClient
.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default CloudWatchLogsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
-
-