AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Implementation for accessing CloudWatchLogs 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.
Namespace: Amazon.CloudWatchLogs
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z
public class AmazonCloudWatchLogsClient : AmazonServiceClient IAmazonCloudWatchLogs, IAmazonService, IDisposable
The AmazonCloudWatchLogsClient type exposes the following members
Name | Description | |
---|---|---|
![]() |
AmazonCloudWatchLogsClient() |
Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonCloudWatchLogsClient(RegionEndpoint) |
Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonCloudWatchLogsClient(AmazonCloudWatchLogsConfig) |
Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonCloudWatchLogsClient(AWSCredentials) |
Constructs AmazonCloudWatchLogsClient with AWS Credentials |
![]() |
AmazonCloudWatchLogsClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonCloudWatchLogsClient with AWS Credentials |
![]() |
AmazonCloudWatchLogsClient(AWSCredentials, AmazonCloudWatchLogsConfig) |
Constructs AmazonCloudWatchLogsClient with AWS Credentials and an AmazonCloudWatchLogsClient Configuration object. |
![]() |
AmazonCloudWatchLogsClient(string, string) |
Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonCloudWatchLogsClient(string, string, RegionEndpoint) |
Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonCloudWatchLogsClient(string, string, AmazonCloudWatchLogsConfig) |
Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object. |
![]() |
AmazonCloudWatchLogsClient(string, string, string) |
Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonCloudWatchLogsClient(string, string, string, RegionEndpoint) |
Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonCloudWatchLogsClient(string, string, string, AmazonCloudWatchLogsConfig) |
Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
![]() |
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
Paginators | Amazon.CloudWatchLogs.Model.ICloudWatchLogsPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
![]() |
AssociateKmsKey(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.
When you use
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 |
![]() |
AssociateKmsKeyAsync(AssociateKmsKeyRequest, CancellationToken) |
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
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 |
![]() |
CancelExportTask(CancelExportTaskRequest) |
Cancels the specified export task.
The task must be in the |
![]() |
CancelExportTaskAsync(CancelExportTaskRequest, CancellationToken) |
Cancels the specified export task.
The task must be in the |
![]() |
CreateExportTask(CreateExportTaskRequest) |
Creates an export task so that you can efficiently export data from a log group to
an Amazon S3 bucket. When you perform a 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 ( 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. |
![]() |
CreateExportTaskAsync(CreateExportTaskRequest, CancellationToken) |
Creates an export task so that you can efficiently export data from a log group to
an Amazon S3 bucket. When you perform a 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 ( 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. |
![]() |
CreateLogGroup(CreateLogGroupRequest) |
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:
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 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. |
![]() |
CreateLogGroupAsync(CreateLogGroupRequest, CancellationToken) |
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:
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 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. |
![]() |
CreateLogStream(CreateLogStreamRequest) |
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 You must use the following guidelines when naming a log stream:
|
![]() |
CreateLogStreamAsync(CreateLogStreamRequest, CancellationToken) |
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 You must use the following guidelines when naming a log stream:
|
![]() |
DeleteAccountPolicy(DeleteAccountPolicyRequest) |
Deletes a CloudWatch Logs account policy.
To use this operation, you must be signed on with the |
![]() |
DeleteAccountPolicyAsync(DeleteAccountPolicyRequest, CancellationToken) |
Deletes a CloudWatch Logs account policy.
To use this operation, you must be signed on with the |
![]() |
DeleteDataProtectionPolicy(DeleteDataProtectionPolicyRequest) |
Deletes the data protection policy from the specified log group. For more information about data protection policies, see PutDataProtectionPolicy. |
![]() |
DeleteDataProtectionPolicyAsync(DeleteDataProtectionPolicyRequest, CancellationToken) |
Deletes the data protection policy from the specified log group. For more information about data protection policies, see PutDataProtectionPolicy. |
![]() |
DeleteDestination(DeleteDestinationRequest) |
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. |
![]() |
DeleteDestinationAsync(DeleteDestinationRequest, CancellationToken) |
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. |
![]() |
DeleteLogGroup(DeleteLogGroupRequest) |
Deletes the specified log group and permanently deletes all the archived log events associated with the log group. |
![]() |
DeleteLogGroupAsync(DeleteLogGroupRequest, CancellationToken) |
Deletes the specified log group and permanently deletes all the archived log events associated with the log group. |
![]() |
DeleteLogStream(DeleteLogStreamRequest) |
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream. |
![]() |
DeleteLogStreamAsync(DeleteLogStreamRequest, CancellationToken) |
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream. |
![]() |
DeleteMetricFilter(DeleteMetricFilterRequest) |
Deletes the specified metric filter. |
![]() |
DeleteMetricFilterAsync(DeleteMetricFilterRequest, CancellationToken) |
Deletes the specified metric filter. |
![]() |
DeleteQueryDefinition(DeleteQueryDefinitionRequest) |
Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each
You must have the |
![]() |
DeleteQueryDefinitionAsync(DeleteQueryDefinitionRequest, CancellationToken) |
Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each
You must have the |
![]() |
DeleteResourcePolicy(DeleteResourcePolicyRequest) |
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account. |
![]() |
DeleteResourcePolicyAsync(DeleteResourcePolicyRequest, CancellationToken) |
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account. |
![]() |
DeleteRetentionPolicy(DeleteRetentionPolicyRequest) |
Deletes the specified retention policy. Log events do not expire if they belong to log groups without a retention policy. |
![]() |
DeleteRetentionPolicyAsync(DeleteRetentionPolicyRequest, CancellationToken) |
Deletes the specified retention policy. Log events do not expire if they belong to log groups without a retention policy. |
![]() |
DeleteSubscriptionFilter(DeleteSubscriptionFilterRequest) |
Deletes the specified subscription filter. |
![]() |
DeleteSubscriptionFilterAsync(DeleteSubscriptionFilterRequest, CancellationToken) |
Deletes the specified subscription filter. |
![]() |
DescribeAccountPolicies(DescribeAccountPoliciesRequest) |
Returns a list of all CloudWatch Logs account policies in the account. |
![]() |
DescribeAccountPoliciesAsync(DescribeAccountPoliciesRequest, CancellationToken) |
Returns a list of all CloudWatch Logs account policies in the account. |
![]() |
DescribeDestinations(DescribeDestinationsRequest) |
Lists all your destinations. The results are ASCII-sorted by destination name. |
![]() |
DescribeDestinationsAsync(DescribeDestinationsRequest, CancellationToken) |
Lists all your destinations. The results are ASCII-sorted by destination name. |
![]() |
DescribeExportTasks(DescribeExportTasksRequest) |
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status. |
![]() |
DescribeExportTasksAsync(DescribeExportTasksRequest, CancellationToken) |
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status. |
![]() |
DescribeLogGroups() |
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 aws:ResourceTag/key-namecondition 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. |
![]() |
DescribeLogGroups(DescribeLogGroupsRequest) |
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 aws:ResourceTag/key-namecondition 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. |
![]() |
DescribeLogGroupsAsync(CancellationToken) |
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 aws:ResourceTag/key-namecondition 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. |
![]() |
DescribeLogGroupsAsync(DescribeLogGroupsRequest, CancellationToken) |
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 aws:ResourceTag/key-namecondition 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. |
![]() |
DescribeLogStreams(DescribeLogStreamsRequest) |
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 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. |
![]() |
DescribeLogStreamsAsync(DescribeLogStreamsRequest, CancellationToken) |
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 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. |
![]() |
DescribeMetricFilters(DescribeMetricFiltersRequest) |
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. |
![]() |
DescribeMetricFiltersAsync(DescribeMetricFiltersRequest, CancellationToken) |
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. |
![]() |
DescribeQueries(DescribeQueriesRequest) |
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. |
![]() |
DescribeQueriesAsync(DescribeQueriesRequest, CancellationToken) |
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. |
![]() |
DescribeQueryDefinitions(DescribeQueryDefinitionsRequest) |
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
You can use the |
![]() |
DescribeQueryDefinitionsAsync(DescribeQueryDefinitionsRequest, CancellationToken) |
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
You can use the |
![]() |
DescribeResourcePolicies(DescribeResourcePoliciesRequest) |
Lists the resource policies in this account. |
![]() |
DescribeResourcePoliciesAsync(DescribeResourcePoliciesRequest, CancellationToken) |
Lists the resource policies in this account. |
![]() |
DescribeSubscriptionFilters(DescribeSubscriptionFiltersRequest) |
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. |
![]() |
DescribeSubscriptionFiltersAsync(DescribeSubscriptionFiltersRequest, CancellationToken) |
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. |
![]() |
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
![]() |
DisassociateKmsKey(DisassociateKmsKeyRequest) |
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
When you use
It can take up to 5 minutes for this operation to take effect. |
![]() |
DisassociateKmsKeyAsync(DisassociateKmsKeyRequest, CancellationToken) |
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
When you use
It can take up to 5 minutes for this operation to take effect. |
![]() |
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
FilterLogEvents(FilterLogEventsRequest) |
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
You can specify the log group to search by using either 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 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. |
![]() |
FilterLogEventsAsync(FilterLogEventsRequest, CancellationToken) |
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
You can specify the log group to search by using either 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 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. |
![]() |
GetDataProtectionPolicy(GetDataProtectionPolicyRequest) |
Returns information about a log group data protection policy. |
![]() |
GetDataProtectionPolicyAsync(GetDataProtectionPolicyRequest, CancellationToken) |
Returns information about a log group data protection policy. |
![]() |
GetLogEvents(GetLogEventsRequest) |
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 |
![]() |
GetLogEventsAsync(GetLogEventsRequest, CancellationToken) |
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 |
![]() |
GetLogGroupFields(GetLogGroupFieldsRequest) |
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
In the results, fields that start with 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. |
![]() |
GetLogGroupFieldsAsync(GetLogGroupFieldsRequest, CancellationToken) |
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
In the results, fields that start with 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. |
![]() |
GetLogRecord(GetLogRecordRequest) |
Retrieves all of the fields and values of a single log event. All fields are retrieved,
even if the original query that produced the
The full unparsed log event is returned within |
![]() |
GetLogRecordAsync(GetLogRecordRequest, CancellationToken) |
Retrieves all of the fields and values of a single log event. All fields are retrieved,
even if the original query that produced the
The full unparsed log event is returned within |
![]() |
GetQueryResults(GetQueryResultsRequest) |
Returns the results from the specified query.
Only the fields requested in the query are returned, along with a
If the value of the 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. |
![]() |
GetQueryResultsAsync(GetQueryResultsRequest, CancellationToken) |
Returns the results from the specified query.
Only the fields requested in the query are returned, along with a
If the value of the 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. |
![]() |
ListTagsForResource(ListTagsForResourceRequest) |
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging. |
![]() |
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging. |
![]() |
ListTagsLogGroup(ListTagsLogGroupRequest) |
The ListTagsLogGroup operation is on the path to deprecation. We recommend that you
use ListTagsForResource
instead.
Lists the tags for the specified log group. |
![]() |
ListTagsLogGroupAsync(ListTagsLogGroupRequest, CancellationToken) |
The ListTagsLogGroup operation is on the path to deprecation. We recommend that you
use ListTagsForResource
instead.
Lists the tags for the specified log group. |
![]() |
PutAccountPolicy(PutAccountPolicyRequest) |
Creates an account-level data protection policy that applies to all log groups in
the account. 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 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
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 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
The |
![]() |
PutAccountPolicyAsync(PutAccountPolicyRequest, CancellationToken) |
Creates an account-level data protection policy that applies to all log groups in
the account. 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 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
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 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
The |
![]() |
PutDataProtectionPolicy(PutDataProtectionPolicyRequest) |
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 For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
The |
![]() |
PutDataProtectionPolicyAsync(PutDataProtectionPolicyRequest, CancellationToken) |
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 For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
The |
![]() |
PutDestination(PutDestinationRequest) |
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,
To perform a |
![]() |
PutDestinationAsync(PutDestinationRequest, CancellationToken) |
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,
To perform a |
![]() |
PutDestinationPolicy(PutDestinationPolicyRequest) |
Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination. |
![]() |
PutDestinationPolicyAsync(PutDestinationPolicyRequest, CancellationToken) |
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. |
![]() |
PutLogEvents(PutLogEventsRequest) |
Uploads a batch of log events to the specified log stream.
The sequence token is now ignored in The batch of events must satisfy the following constraints:
If a call to |
![]() |
PutLogEventsAsync(PutLogEventsRequest, CancellationToken) |
Uploads a batch of log events to the specified log stream.
The sequence token is now ignored in The batch of events must satisfy the following constraints:
If a call to |
![]() |
PutMetricFilter(PutMetricFilterRequest) |
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. 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 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. |
![]() |
PutMetricFilterAsync(PutMetricFilterRequest, CancellationToken) |
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. 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 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. |
![]() |
PutQueryDefinition(PutQueryDefinitionRequest) |
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
You must have the |
![]() |
PutQueryDefinitionAsync(PutQueryDefinitionRequest, CancellationToken) |
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
You must have the |
![]() |
PutResourcePolicy(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. An account can have up to 10 resource policies per Amazon Web Services Region. |
![]() |
PutResourcePolicyAsync(PutResourcePolicyRequest, CancellationToken) |
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. |
![]() |
PutRetentionPolicy(PutRetentionPolicyRequest) |
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 |
![]() |
PutRetentionPolicyAsync(PutRetentionPolicyRequest, CancellationToken) |
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 |
![]() |
PutSubscriptionFilter(PutSubscriptionFilterRequest) |
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:
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
To perform a |
![]() |
PutSubscriptionFilterAsync(PutSubscriptionFilterRequest, CancellationToken) |
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:
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
To perform a |
![]() |
StartQuery(StartQueryRequest) |
Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use. For more information, see CloudWatch Logs Insights Query Syntax.
After you run a query using 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 You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards. |
![]() |
StartQueryAsync(StartQueryRequest, CancellationToken) |
Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use. For more information, see CloudWatch Logs Insights Query Syntax.
After you run a query using 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 You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards. |
![]() |
StopQuery(StopQueryRequest) |
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. |
![]() |
StopQueryAsync(StopQueryRequest, CancellationToken) |
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. |
![]() |
TagLogGroup(TagLogGroupRequest) |
The 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 |
![]() |
TagLogGroupAsync(TagLogGroupRequest, CancellationToken) |
The 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 |
![]() |
TagResource(TagResourceRequest) |
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 You can associate as many as 50 tags with a CloudWatch Logs resource. |
![]() |
TagResourceAsync(TagResourceRequest, CancellationToken) |
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 You can associate as many as 50 tags with a CloudWatch Logs resource. |
![]() |
TestMetricFilter(TestMetricFilterRequest) |
Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. |
![]() |
TestMetricFilterAsync(TestMetricFilterRequest, CancellationToken) |
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. |
![]() |
UntagLogGroup(UntagLogGroupRequest) |
The 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 |
![]() |
UntagLogGroupAsync(UntagLogGroupRequest, CancellationToken) |
The 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 |
![]() |
UntagResource(UntagResourceRequest) |
Removes one or more tags from the specified resource. |
![]() |
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Removes one or more tags from the specified resource. |
Name | Description | |
---|---|---|
![]() |
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5