Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

@aws-sdk/client-cloudwatch-logs

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.

Index

Enumerations

Classes

$Command AssociateKmsKeyCommand CancelExportTaskCommand CloudWatchLogs CloudWatchLogsClient CloudWatchLogsServiceException CreateExportTaskCommand CreateLogGroupCommand CreateLogStreamCommand DataAlreadyAcceptedException DeleteAccountPolicyCommand DeleteDataProtectionPolicyCommand DeleteDestinationCommand DeleteLogGroupCommand DeleteLogStreamCommand DeleteMetricFilterCommand DeleteQueryDefinitionCommand DeleteResourcePolicyCommand DeleteRetentionPolicyCommand DeleteSubscriptionFilterCommand DescribeAccountPoliciesCommand DescribeDestinationsCommand DescribeExportTasksCommand DescribeLogGroupsCommand DescribeLogStreamsCommand DescribeMetricFiltersCommand DescribeQueriesCommand DescribeQueryDefinitionsCommand DescribeResourcePoliciesCommand DescribeSubscriptionFiltersCommand DisassociateKmsKeyCommand FilterLogEventsCommand GetDataProtectionPolicyCommand GetLogEventsCommand GetLogGroupFieldsCommand GetLogRecordCommand GetQueryResultsCommand InvalidOperationException InvalidParameterException InvalidSequenceTokenException LimitExceededException ListTagsForResourceCommand ListTagsLogGroupCommand MalformedQueryException OperationAbortedException PutAccountPolicyCommand PutDataProtectionPolicyCommand PutDestinationCommand PutDestinationPolicyCommand PutLogEventsCommand PutMetricFilterCommand PutQueryDefinitionCommand PutResourcePolicyCommand PutRetentionPolicyCommand PutSubscriptionFilterCommand ResourceAlreadyExistsException ResourceNotFoundException ServiceUnavailableException StartQueryCommand StopQueryCommand TagLogGroupCommand TagResourceCommand TestMetricFilterCommand TooManyTagsException UnrecognizedClientException UntagLogGroupCommand UntagResourceCommand __Client

Interfaces

AccountPolicy AssociateKmsKeyCommandInput AssociateKmsKeyCommandOutput AssociateKmsKeyRequest CancelExportTaskCommandInput CancelExportTaskCommandOutput CancelExportTaskRequest ClientDefaults CloudWatchLogsClientConfig CloudWatchLogsClientResolvedConfig CloudWatchLogsPaginationConfiguration CreateExportTaskCommandInput CreateExportTaskCommandOutput CreateExportTaskRequest CreateExportTaskResponse CreateLogGroupCommandInput CreateLogGroupCommandOutput CreateLogGroupRequest CreateLogStreamCommandInput CreateLogStreamCommandOutput CreateLogStreamRequest DeleteAccountPolicyCommandInput DeleteAccountPolicyCommandOutput DeleteAccountPolicyRequest DeleteDataProtectionPolicyCommandInput DeleteDataProtectionPolicyCommandOutput DeleteDataProtectionPolicyRequest DeleteDestinationCommandInput DeleteDestinationCommandOutput DeleteDestinationRequest DeleteLogGroupCommandInput DeleteLogGroupCommandOutput DeleteLogGroupRequest DeleteLogStreamCommandInput DeleteLogStreamCommandOutput DeleteLogStreamRequest DeleteMetricFilterCommandInput DeleteMetricFilterCommandOutput DeleteMetricFilterRequest DeleteQueryDefinitionCommandInput DeleteQueryDefinitionCommandOutput DeleteQueryDefinitionRequest DeleteQueryDefinitionResponse DeleteResourcePolicyCommandInput DeleteResourcePolicyCommandOutput DeleteResourcePolicyRequest DeleteRetentionPolicyCommandInput DeleteRetentionPolicyCommandOutput DeleteRetentionPolicyRequest DeleteSubscriptionFilterCommandInput DeleteSubscriptionFilterCommandOutput DeleteSubscriptionFilterRequest DescribeAccountPoliciesCommandInput DescribeAccountPoliciesCommandOutput DescribeAccountPoliciesRequest DescribeAccountPoliciesResponse DescribeDestinationsCommandInput DescribeDestinationsCommandOutput DescribeDestinationsRequest DescribeDestinationsResponse DescribeExportTasksCommandInput DescribeExportTasksCommandOutput DescribeExportTasksRequest DescribeExportTasksResponse DescribeLogGroupsCommandInput DescribeLogGroupsCommandOutput DescribeLogGroupsRequest DescribeLogGroupsResponse DescribeLogStreamsCommandInput DescribeLogStreamsCommandOutput DescribeLogStreamsRequest DescribeLogStreamsResponse DescribeMetricFiltersCommandInput DescribeMetricFiltersCommandOutput DescribeMetricFiltersRequest DescribeMetricFiltersResponse DescribeQueriesCommandInput DescribeQueriesCommandOutput DescribeQueriesRequest DescribeQueriesResponse DescribeQueryDefinitionsCommandInput DescribeQueryDefinitionsCommandOutput DescribeQueryDefinitionsRequest DescribeQueryDefinitionsResponse DescribeResourcePoliciesCommandInput DescribeResourcePoliciesCommandOutput DescribeResourcePoliciesRequest DescribeResourcePoliciesResponse DescribeSubscriptionFiltersCommandInput DescribeSubscriptionFiltersCommandOutput DescribeSubscriptionFiltersRequest DescribeSubscriptionFiltersResponse Destination DisassociateKmsKeyCommandInput DisassociateKmsKeyCommandOutput DisassociateKmsKeyRequest ExportTask ExportTaskExecutionInfo ExportTaskStatus FilterLogEventsCommandInput FilterLogEventsCommandOutput FilterLogEventsRequest FilterLogEventsResponse FilteredLogEvent GetDataProtectionPolicyCommandInput GetDataProtectionPolicyCommandOutput GetDataProtectionPolicyRequest GetDataProtectionPolicyResponse GetLogEventsCommandInput GetLogEventsCommandOutput GetLogEventsRequest GetLogEventsResponse GetLogGroupFieldsCommandInput GetLogGroupFieldsCommandOutput GetLogGroupFieldsRequest GetLogGroupFieldsResponse GetLogRecordCommandInput GetLogRecordCommandOutput GetLogRecordRequest GetLogRecordResponse GetQueryResultsCommandInput GetQueryResultsCommandOutput GetQueryResultsRequest GetQueryResultsResponse InputLogEvent ListTagsForResourceCommandInput ListTagsForResourceCommandOutput ListTagsForResourceRequest ListTagsForResourceResponse ListTagsLogGroupCommandInput ListTagsLogGroupCommandOutput ListTagsLogGroupRequest ListTagsLogGroupResponse LogGroup LogGroupField LogStream MetricFilter MetricFilterMatchRecord MetricTransformation OutputLogEvent PutAccountPolicyCommandInput PutAccountPolicyCommandOutput PutAccountPolicyRequest PutAccountPolicyResponse PutDataProtectionPolicyCommandInput PutDataProtectionPolicyCommandOutput PutDataProtectionPolicyRequest PutDataProtectionPolicyResponse PutDestinationCommandInput PutDestinationCommandOutput PutDestinationPolicyCommandInput PutDestinationPolicyCommandOutput PutDestinationPolicyRequest PutDestinationRequest PutDestinationResponse PutLogEventsCommandInput PutLogEventsCommandOutput PutLogEventsRequest PutLogEventsResponse PutMetricFilterCommandInput PutMetricFilterCommandOutput PutMetricFilterRequest PutQueryDefinitionCommandInput PutQueryDefinitionCommandOutput PutQueryDefinitionRequest PutQueryDefinitionResponse PutResourcePolicyCommandInput PutResourcePolicyCommandOutput PutResourcePolicyRequest PutResourcePolicyResponse PutRetentionPolicyCommandInput PutRetentionPolicyCommandOutput PutRetentionPolicyRequest PutSubscriptionFilterCommandInput PutSubscriptionFilterCommandOutput PutSubscriptionFilterRequest QueryCompileError QueryCompileErrorLocation QueryDefinition QueryInfo QueryStatistics RejectedLogEventsInfo ResourcePolicy ResultField SearchedLogStream StartQueryCommandInput StartQueryCommandOutput StartQueryRequest StartQueryResponse StopQueryCommandInput StopQueryCommandOutput StopQueryRequest StopQueryResponse SubscriptionFilter TagLogGroupCommandInput TagLogGroupCommandOutput TagLogGroupRequest TagResourceCommandInput TagResourceCommandOutput TagResourceRequest TestMetricFilterCommandInput TestMetricFilterCommandOutput TestMetricFilterRequest TestMetricFilterResponse UntagLogGroupCommandInput UntagLogGroupCommandOutput UntagLogGroupRequest UntagResourceCommandInput UntagResourceCommandOutput UntagResourceRequest __MetadataBearer

Type Aliases

Functions

SDK - Clients

SDK - Commands

AssociateKmsKeyCommand AssociateKmsKeyCommandInput AssociateKmsKeyCommandOutput CancelExportTaskCommand CancelExportTaskCommandInput CancelExportTaskCommandOutput CreateExportTaskCommand CreateExportTaskCommandInput CreateExportTaskCommandOutput CreateLogGroupCommand CreateLogGroupCommandInput CreateLogGroupCommandOutput CreateLogStreamCommand CreateLogStreamCommandInput CreateLogStreamCommandOutput DeleteAccountPolicyCommand DeleteAccountPolicyCommandInput DeleteAccountPolicyCommandOutput DeleteDataProtectionPolicyCommand DeleteDataProtectionPolicyCommandInput DeleteDataProtectionPolicyCommandOutput DeleteDestinationCommand DeleteDestinationCommandInput DeleteDestinationCommandOutput DeleteLogGroupCommand DeleteLogGroupCommandInput DeleteLogGroupCommandOutput DeleteLogStreamCommand DeleteLogStreamCommandInput DeleteLogStreamCommandOutput DeleteMetricFilterCommand DeleteMetricFilterCommandInput DeleteMetricFilterCommandOutput DeleteQueryDefinitionCommand DeleteQueryDefinitionCommandInput DeleteQueryDefinitionCommandOutput DeleteResourcePolicyCommand DeleteResourcePolicyCommandInput DeleteResourcePolicyCommandOutput DeleteRetentionPolicyCommand DeleteRetentionPolicyCommandInput DeleteRetentionPolicyCommandOutput DeleteSubscriptionFilterCommand DeleteSubscriptionFilterCommandInput DeleteSubscriptionFilterCommandOutput DescribeAccountPoliciesCommand DescribeAccountPoliciesCommandInput DescribeAccountPoliciesCommandOutput DescribeDestinationsCommand DescribeDestinationsCommandInput DescribeDestinationsCommandOutput DescribeExportTasksCommand DescribeExportTasksCommandInput DescribeExportTasksCommandOutput DescribeLogGroupsCommand DescribeLogGroupsCommandInput DescribeLogGroupsCommandOutput DescribeLogStreamsCommand DescribeLogStreamsCommandInput DescribeLogStreamsCommandOutput DescribeMetricFiltersCommand DescribeMetricFiltersCommandInput DescribeMetricFiltersCommandOutput DescribeQueriesCommand DescribeQueriesCommandInput DescribeQueriesCommandOutput DescribeQueryDefinitionsCommand DescribeQueryDefinitionsCommandInput DescribeQueryDefinitionsCommandOutput DescribeResourcePoliciesCommand DescribeResourcePoliciesCommandInput DescribeResourcePoliciesCommandOutput DescribeSubscriptionFiltersCommand DescribeSubscriptionFiltersCommandInput DescribeSubscriptionFiltersCommandOutput DisassociateKmsKeyCommand DisassociateKmsKeyCommandInput DisassociateKmsKeyCommandOutput FilterLogEventsCommand FilterLogEventsCommandInput FilterLogEventsCommandOutput GetDataProtectionPolicyCommand GetDataProtectionPolicyCommandInput GetDataProtectionPolicyCommandOutput GetLogEventsCommand GetLogEventsCommandInput GetLogEventsCommandOutput GetLogGroupFieldsCommand GetLogGroupFieldsCommandInput GetLogGroupFieldsCommandOutput GetLogRecordCommand GetLogRecordCommandInput GetLogRecordCommandOutput GetQueryResultsCommand GetQueryResultsCommandInput GetQueryResultsCommandOutput ListTagsForResourceCommand ListTagsForResourceCommandInput ListTagsForResourceCommandOutput ListTagsLogGroupCommand ListTagsLogGroupCommandInput ListTagsLogGroupCommandOutput PutAccountPolicyCommand PutAccountPolicyCommandInput PutAccountPolicyCommandOutput PutDataProtectionPolicyCommand PutDataProtectionPolicyCommandInput PutDataProtectionPolicyCommandOutput PutDestinationCommand PutDestinationCommandInput PutDestinationCommandOutput PutDestinationPolicyCommand PutDestinationPolicyCommandInput PutDestinationPolicyCommandOutput PutLogEventsCommand PutLogEventsCommandInput PutLogEventsCommandOutput PutMetricFilterCommand PutMetricFilterCommandInput PutMetricFilterCommandOutput PutQueryDefinitionCommand PutQueryDefinitionCommandInput PutQueryDefinitionCommandOutput PutResourcePolicyCommand PutResourcePolicyCommandInput PutResourcePolicyCommandOutput PutRetentionPolicyCommand PutRetentionPolicyCommandInput PutRetentionPolicyCommandOutput PutSubscriptionFilterCommand PutSubscriptionFilterCommandInput PutSubscriptionFilterCommandOutput StartQueryCommand StartQueryCommandInput StartQueryCommandOutput StopQueryCommand StopQueryCommandInput StopQueryCommandOutput TagLogGroupCommand TagLogGroupCommandInput TagLogGroupCommandOutput TagResourceCommand TagResourceCommandInput TagResourceCommandOutput TestMetricFilterCommand TestMetricFilterCommandInput TestMetricFilterCommandOutput UntagLogGroupCommand UntagLogGroupCommandInput UntagLogGroupCommandOutput UntagResourceCommand UntagResourceCommandInput UntagResourceCommandOutput

SDK - Paginators

SDK - Waiters