AWS SDK Version 3 for .NET
API Reference

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 Amazon EC2 instances, AWS CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.

You can use CloudWatch Logs to:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient

Namespace: Amazon.CloudWatchLogs
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonCloudWatchLogsClient : AmazonServiceClient
         IAmazonCloudWatchLogs, IAmazonService, IDisposable

The AmazonCloudWatchLogsClient type exposes the following members

Constructors

NameDescription
Public Method 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.



    
        
    

             

Public Method 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.



    
        
    

             

Public Method 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.



    
        
    

             

Public Method AmazonCloudWatchLogsClient(AWSCredentials)

Constructs AmazonCloudWatchLogsClient with AWS Credentials

Public Method AmazonCloudWatchLogsClient(AWSCredentials, RegionEndpoint)

Constructs AmazonCloudWatchLogsClient with AWS Credentials

Public Method AmazonCloudWatchLogsClient(AWSCredentials, AmazonCloudWatchLogsConfig)

Constructs AmazonCloudWatchLogsClient with AWS Credentials and an AmazonCloudWatchLogsClient Configuration object.

Public Method AmazonCloudWatchLogsClient(string, string)

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudWatchLogsClient(string, string, RegionEndpoint)

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudWatchLogsClient(string, string, AmazonCloudWatchLogsConfig)

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object.

Public Method AmazonCloudWatchLogsClient(string, string, string)

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudWatchLogsClient(string, string, string, RegionEndpoint)

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudWatchLogsClient(string, string, string, AmazonCloudWatchLogsConfig)

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateKmsKey(AssociateKmsKeyRequest)

Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.

Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

Note that it can take up to 5 minutes for this operation to take effect.

If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

Public Method AssociateKmsKeyAsync(AssociateKmsKeyRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateKmsKey operation.

Public Method CancelExportTask(CancelExportTaskRequest)

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

Public Method CancelExportTaskAsync(CancelExportTaskRequest, CancellationToken)

Initiates the asynchronous execution of the CancelExportTask operation.

Public Method CreateExportTask(CreateExportTaskRequest)

Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

Public Method CreateExportTaskAsync(CreateExportTaskRequest, CancellationToken)

Initiates the asynchronous execution of the CreateExportTask operation.

Public Method CreateLogGroup(CreateLogGroupRequest)

Creates a log group with the specified name.

You can create up to 5000 log groups per account.

You must use the following guidelines when naming a log group:

  • Log group names must be unique within a region for an AWS account.

  • Log group names can be between 1 and 512 characters long.

  • Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

Public Method CreateLogGroupAsync(CreateLogGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateLogGroup operation.

Public Method CreateLogStream(CreateLogStreamRequest)

Creates a log stream for the specified log group.

There is no limit on the number of log streams that you can create for a log group.

You must use the following guidelines when naming a log stream:

  • Log stream names must be unique within the log group.

  • Log stream names can be between 1 and 512 characters long.

  • The ':' (colon) and '*' (asterisk) characters are not allowed.

Public Method CreateLogStreamAsync(CreateLogStreamRequest, CancellationToken)

Initiates the asynchronous execution of the CreateLogStream operation.

Public Method 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.

Public Method DeleteDestinationAsync(DeleteDestinationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDestination operation.

Public Method DeleteLogGroup(DeleteLogGroupRequest)

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

Public Method DeleteLogGroupAsync(DeleteLogGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteLogGroup operation.

Public Method DeleteLogStream(DeleteLogStreamRequest)

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

Public Method DeleteLogStreamAsync(DeleteLogStreamRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteLogStream operation.

Public Method DeleteMetricFilter(DeleteMetricFilterRequest)

Deletes the specified metric filter.

Public Method DeleteMetricFilterAsync(DeleteMetricFilterRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteMetricFilter operation.

Public Method 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.

Public Method DeleteResourcePolicyAsync(DeleteResourcePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteResourcePolicy operation.

Public Method DeleteRetentionPolicy(DeleteRetentionPolicyRequest)

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

Public Method DeleteRetentionPolicyAsync(DeleteRetentionPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRetentionPolicy operation.

Public Method DeleteSubscriptionFilter(DeleteSubscriptionFilterRequest)

Deletes the specified subscription filter.

Public Method DeleteSubscriptionFilterAsync(DeleteSubscriptionFilterRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSubscriptionFilter operation.

Public Method DescribeDestinations(DescribeDestinationsRequest)

Lists all your destinations. The results are ASCII-sorted by destination name.

Public Method DescribeDestinationsAsync(DescribeDestinationsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDestinations operation.

Public Method 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.

Public Method DescribeExportTasksAsync(DescribeExportTasksRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeExportTasks operation.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method DescribeLogGroupsAsync(DescribeLogGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeLogGroups operation.

Public Method 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.

This operation has a limit of five transactions per second, after which transactions are throttled.

Public Method DescribeLogStreamsAsync(DescribeLogStreamsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeLogStreams operation.

Public Method DescribeMetricFilters(DescribeMetricFiltersRequest)

Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

Public Method DescribeMetricFiltersAsync(DescribeMetricFiltersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeMetricFilters operation.

Public Method DescribeResourcePolicies(DescribeResourcePoliciesRequest)

Lists the resource policies in this account.

Public Method DescribeResourcePoliciesAsync(DescribeResourcePoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeResourcePolicies operation.

Public Method 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.

Public Method DescribeSubscriptionFiltersAsync(DescribeSubscriptionFiltersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeSubscriptionFilters operation.

Public Method DisassociateKmsKey(DisassociateKmsKeyRequest)

Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.

After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.

Note that it can take up to 5 minutes for this operation to take effect.

Public Method DisassociateKmsKeyAsync(DisassociateKmsKeyRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateKmsKey operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method 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.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

Public Method FilterLogEventsAsync(FilterLogEventsRequest, CancellationToken)

Initiates the asynchronous execution of the FilterLogEvents operation.

Public Method GetLogEvents(GetLogEventsRequest)

Lists log events from the specified log stream. You can list all the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.

Public Method GetLogEventsAsync(GetLogEventsRequest, CancellationToken)

Initiates the asynchronous execution of the GetLogEvents operation.

Public Method ListTagsLogGroup(ListTagsLogGroupRequest)

Lists the tags for the specified log group.

Public Method ListTagsLogGroupAsync(ListTagsLogGroupRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsLogGroup operation.

Public Method PutDestination(PutDestinationRequest)

Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination.

Through an access policy, a destination controls what is written to its Kinesis stream. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

Public Method PutDestinationAsync(PutDestinationRequest, CancellationToken)

Initiates the asynchronous execution of the PutDestination operation.

Public Method 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.

Public Method PutDestinationPolicyAsync(PutDestinationPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the PutDestinationPolicy operation.

Public Method PutLogEvents(PutLogEventsRequest)

Uploads a batch of log events to the specified log stream.

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

  • None of the log events in the batch can be more than 2 hours in the future.

  • None of the log events in the batch can be older than 14 days or the retention period of the log group.

  • The log events in the batch must be in chronological ordered by their time stamp (the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC).

  • The maximum number of log events in a batch is 10,000.

  • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

Public Method PutLogEventsAsync(PutLogEventsRequest, CancellationToken)

Initiates the asynchronous execution of the PutLogEvents operation.

Public Method PutMetricFilter(PutMetricFilterRequest)

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

Public Method PutMetricFilterAsync(PutMetricFilterRequest, CancellationToken)

Initiates the asynchronous execution of the PutMetricFilter operation.

Public Method PutResourcePolicy(PutResourcePolicyRequest)

Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 50 resource policies per region.

Public Method PutResourcePolicyAsync(PutResourcePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the PutResourcePolicy operation.

Public Method PutRetentionPolicy(PutRetentionPolicyRequest)

Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.

Public Method PutRetentionPolicyAsync(PutRetentionPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the PutRetentionPolicy operation.

Public Method PutSubscriptionFilter(PutSubscriptionFilterRequest)

Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination that belongs to a different account, for cross-account delivery.

  • An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

  • An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group.

Public Method PutSubscriptionFilterAsync(PutSubscriptionFilterRequest, CancellationToken)

Initiates the asynchronous execution of the PutSubscriptionFilter operation.

Public Method TagLogGroup(TagLogGroupRequest)

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

Public Method TagLogGroupAsync(TagLogGroupRequest, CancellationToken)

Initiates the asynchronous execution of the TagLogGroup operation.

Public Method 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.

Public Method TestMetricFilterAsync(TestMetricFilterRequest, CancellationToken)

Initiates the asynchronous execution of the TestMetricFilter operation.

Public Method UntagLogGroup(UntagLogGroupRequest)

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.

Public Method UntagLogGroupAsync(UntagLogGroupRequest, CancellationToken)

Initiates the asynchronous execution of the UntagLogGroup operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms