C# Class Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient

Implementation for accessing CloudWatchLogs You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK.

You can use CloudWatch Logs to:

  • Monitor Logs from Amazon EC2 Instances in Real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify.

  • Monitor Amazon CloudTrail Logged Events: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.

  • Archive Log Data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

Inheritance: AmazonServiceClient, IAmazonCloudWatchLogs
Show file Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method Description
AmazonCloudWatchLogsClient ( ) : System

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 credentials ) : System

Constructs AmazonCloudWatchLogsClient with AWS Credentials
AmazonCloudWatchLogsClient ( AWSCredentials credentials, AmazonCloudWatchLogsConfig clientConfig ) : System

Constructs AmazonCloudWatchLogsClient with AWS Credentials and an AmazonCloudWatchLogsClient Configuration object.
AmazonCloudWatchLogsClient ( AWSCredentials credentials, RegionEndpoint region ) : System

Constructs AmazonCloudWatchLogsClient with AWS Credentials
AmazonCloudWatchLogsClient ( AmazonCloudWatchLogsConfig config ) : System

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 region ) : System

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 ( string awsAccessKeyId, string awsSecretAccessKey ) : System

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key
AmazonCloudWatchLogsClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonCloudWatchLogsConfig clientConfig ) : System

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object.
AmazonCloudWatchLogsClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key
AmazonCloudWatchLogsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key
AmazonCloudWatchLogsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonCloudWatchLogsConfig clientConfig ) : System

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object.
AmazonCloudWatchLogsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key
BeginCancelExportTask ( CancelExportTaskRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CancelExportTask operation.
BeginCreateExportTask ( CreateExportTaskRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateExportTask operation.
BeginCreateLogGroup ( CreateLogGroupRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateLogGroup operation.
BeginCreateLogStream ( CreateLogStreamRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateLogStream operation.
BeginDeleteDestination ( DeleteDestinationRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteDestination operation.
BeginDeleteLogGroup ( DeleteLogGroupRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteLogGroup operation.
BeginDeleteLogStream ( DeleteLogStreamRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteLogStream operation.
BeginDeleteMetricFilter ( DeleteMetricFilterRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteMetricFilter operation.
BeginDeleteRetentionPolicy ( DeleteRetentionPolicyRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteRetentionPolicy operation.
BeginDeleteSubscriptionFilter ( DeleteSubscriptionFilterRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteSubscriptionFilter operation.
BeginDescribeDestinations ( DescribeDestinationsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeDestinations operation.
BeginDescribeExportTasks ( DescribeExportTasksRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeExportTasks operation.
BeginDescribeLogGroups ( DescribeLogGroupsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeLogGroups operation.
BeginDescribeLogStreams ( DescribeLogStreamsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeLogStreams operation.
BeginDescribeMetricFilters ( DescribeMetricFiltersRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeMetricFilters operation.
BeginDescribeSubscriptionFilters ( DescribeSubscriptionFiltersRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeSubscriptionFilters operation.
BeginFilterLogEvents ( FilterLogEventsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the FilterLogEvents operation.
BeginGetLogEvents ( GetLogEventsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetLogEvents operation.
BeginListTagsLogGroup ( ListTagsLogGroupRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListTagsLogGroup operation.
BeginPutDestination ( PutDestinationRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the PutDestination operation.
BeginPutDestinationPolicy ( PutDestinationPolicyRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the PutDestinationPolicy operation.
BeginPutLogEvents ( PutLogEventsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the PutLogEvents operation.
BeginPutMetricFilter ( PutMetricFilterRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the PutMetricFilter operation.
BeginPutRetentionPolicy ( PutRetentionPolicyRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the PutRetentionPolicy operation.
BeginPutSubscriptionFilter ( PutSubscriptionFilterRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the PutSubscriptionFilter operation.
BeginTagLogGroup ( TagLogGroupRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the TagLogGroup operation.
BeginTestMetricFilter ( TestMetricFilterRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the TestMetricFilter operation.
BeginUntagLogGroup ( UntagLogGroupRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the UntagLogGroup operation.
CancelExportTask ( CancelExportTaskRequest request ) : CancelExportTaskResponse

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

CancelExportTaskAsync ( CancelExportTaskRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CancelExportTask operation.
CreateExportTask ( CreateExportTaskRequest request ) : CreateExportTaskResponse

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 that will be used as the Amazon S3 key prefix for all exported objects.

CreateExportTaskAsync ( CreateExportTaskRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateExportTask operation.
CreateLogGroup ( CreateLogGroupRequest request ) : Amazon.CloudWatchLogs.Model.CreateLogGroupResponse

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).

CreateLogGroupAsync ( CreateLogGroupRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateLogGroup operation.
CreateLogStream ( CreateLogStreamRequest request ) : Amazon.CloudWatchLogs.Model.CreateLogStreamResponse

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.

CreateLogStreamAsync ( CreateLogStreamRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateLogStream operation.
DeleteDestination ( DeleteDestinationRequest request ) : DeleteDestinationResponse

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 request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteDestination operation.
DeleteLogGroup ( DeleteLogGroupRequest request ) : Amazon.CloudWatchLogs.Model.DeleteLogGroupResponse

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
DeleteLogGroupAsync ( DeleteLogGroupRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteLogGroup operation.
DeleteLogStream ( DeleteLogStreamRequest request ) : Amazon.CloudWatchLogs.Model.DeleteLogStreamResponse

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
DeleteLogStreamAsync ( DeleteLogStreamRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteLogStream operation.
DeleteMetricFilter ( DeleteMetricFilterRequest request ) : Amazon.CloudWatchLogs.Model.DeleteMetricFilterResponse

Deletes the specified metric filter.
DeleteMetricFilterAsync ( DeleteMetricFilterRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteMetricFilter operation.
DeleteRetentionPolicy ( DeleteRetentionPolicyRequest request ) : Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyResponse

Deletes the specified retention policy.

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

DeleteRetentionPolicyAsync ( DeleteRetentionPolicyRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteRetentionPolicy operation.
DeleteSubscriptionFilter ( DeleteSubscriptionFilterRequest request ) : DeleteSubscriptionFilterResponse

Deletes the specified subscription filter.
DeleteSubscriptionFilterAsync ( DeleteSubscriptionFilterRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteSubscriptionFilter operation.
DescribeDestinations ( DescribeDestinationsRequest request ) : DescribeDestinationsResponse

Lists all your destinations. The results are ASCII-sorted by destination name.
DescribeDestinationsAsync ( DescribeDestinationsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeDestinations operation.
DescribeExportTasks ( DescribeExportTasksRequest request ) : DescribeExportTasksResponse

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 request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeExportTasks operation.
DescribeLogGroups ( ) : DescribeLogGroupsResponse

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.
DescribeLogGroups ( DescribeLogGroupsRequest request ) : DescribeLogGroupsResponse

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.
DescribeLogGroupsAsync ( DescribeLogGroupsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeLogGroups operation.
DescribeLogGroupsAsync ( System cancellationToken = default(CancellationToken) ) : Task

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.
DescribeLogStreams ( DescribeLogStreamsRequest request ) : DescribeLogStreamsResponse

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.

DescribeLogStreamsAsync ( DescribeLogStreamsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeLogStreams operation.
DescribeMetricFilters ( DescribeMetricFiltersRequest request ) : DescribeMetricFiltersResponse

Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, and metric namespace. The results are ASCII-sorted by filter name.
DescribeMetricFiltersAsync ( DescribeMetricFiltersRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeMetricFilters operation.
DescribeSubscriptionFilters ( DescribeSubscriptionFiltersRequest request ) : DescribeSubscriptionFiltersResponse

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 request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeSubscriptionFilters operation.
EndCancelExportTask ( IAsyncResult asyncResult ) : CancelExportTaskResponse

Finishes the asynchronous execution of the CancelExportTask operation.
EndCreateExportTask ( IAsyncResult asyncResult ) : CreateExportTaskResponse

Finishes the asynchronous execution of the CreateExportTask operation.
EndCreateLogGroup ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.CreateLogGroupResponse

Finishes the asynchronous execution of the CreateLogGroup operation.
EndCreateLogStream ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.CreateLogStreamResponse

Finishes the asynchronous execution of the CreateLogStream operation.
EndDeleteDestination ( IAsyncResult asyncResult ) : DeleteDestinationResponse

Finishes the asynchronous execution of the DeleteDestination operation.
EndDeleteLogGroup ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.DeleteLogGroupResponse

Finishes the asynchronous execution of the DeleteLogGroup operation.
EndDeleteLogStream ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.DeleteLogStreamResponse

Finishes the asynchronous execution of the DeleteLogStream operation.
EndDeleteMetricFilter ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.DeleteMetricFilterResponse

Finishes the asynchronous execution of the DeleteMetricFilter operation.
EndDeleteRetentionPolicy ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyResponse

Finishes the asynchronous execution of the DeleteRetentionPolicy operation.
EndDeleteSubscriptionFilter ( IAsyncResult asyncResult ) : DeleteSubscriptionFilterResponse

Finishes the asynchronous execution of the DeleteSubscriptionFilter operation.
EndDescribeDestinations ( IAsyncResult asyncResult ) : DescribeDestinationsResponse

Finishes the asynchronous execution of the DescribeDestinations operation.
EndDescribeExportTasks ( IAsyncResult asyncResult ) : DescribeExportTasksResponse

Finishes the asynchronous execution of the DescribeExportTasks operation.
EndDescribeLogGroups ( IAsyncResult asyncResult ) : DescribeLogGroupsResponse

Finishes the asynchronous execution of the DescribeLogGroups operation.
EndDescribeLogStreams ( IAsyncResult asyncResult ) : DescribeLogStreamsResponse

Finishes the asynchronous execution of the DescribeLogStreams operation.
EndDescribeMetricFilters ( IAsyncResult asyncResult ) : DescribeMetricFiltersResponse

Finishes the asynchronous execution of the DescribeMetricFilters operation.
EndDescribeSubscriptionFilters ( IAsyncResult asyncResult ) : DescribeSubscriptionFiltersResponse

Finishes the asynchronous execution of the DescribeSubscriptionFilters operation.
EndFilterLogEvents ( IAsyncResult asyncResult ) : FilterLogEventsResponse

Finishes the asynchronous execution of the FilterLogEvents operation.
EndGetLogEvents ( IAsyncResult asyncResult ) : GetLogEventsResponse

Finishes the asynchronous execution of the GetLogEvents operation.
EndListTagsLogGroup ( IAsyncResult asyncResult ) : ListTagsLogGroupResponse

Finishes the asynchronous execution of the ListTagsLogGroup operation.
EndPutDestination ( IAsyncResult asyncResult ) : PutDestinationResponse

Finishes the asynchronous execution of the PutDestination operation.
EndPutDestinationPolicy ( IAsyncResult asyncResult ) : PutDestinationPolicyResponse

Finishes the asynchronous execution of the PutDestinationPolicy operation.
EndPutLogEvents ( IAsyncResult asyncResult ) : PutLogEventsResponse

Finishes the asynchronous execution of the PutLogEvents operation.
EndPutMetricFilter ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.PutMetricFilterResponse

Finishes the asynchronous execution of the PutMetricFilter operation.
EndPutRetentionPolicy ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.PutRetentionPolicyResponse

Finishes the asynchronous execution of the PutRetentionPolicy operation.
EndPutSubscriptionFilter ( IAsyncResult asyncResult ) : PutSubscriptionFilterResponse

Finishes the asynchronous execution of the PutSubscriptionFilter operation.
EndTagLogGroup ( IAsyncResult asyncResult ) : TagLogGroupResponse

Finishes the asynchronous execution of the TagLogGroup operation.
EndTestMetricFilter ( IAsyncResult asyncResult ) : TestMetricFilterResponse

Finishes the asynchronous execution of the TestMetricFilter operation.
EndUntagLogGroup ( IAsyncResult asyncResult ) : UntagLogGroupResponse

Finishes the asynchronous execution of the UntagLogGroup operation.
FilterLogEvents ( FilterLogEventsRequest request ) : FilterLogEventsResponse

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 1MB (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.

FilterLogEventsAsync ( FilterLogEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the FilterLogEvents operation.
GetLogEvents ( GetLogEventsRequest request ) : GetLogEventsResponse

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). If the results include tokens, there are more log events available. You can get additional log events by specifying one of the tokens in a subsequent call.

GetLogEventsAsync ( GetLogEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetLogEvents operation.
ListTagsLogGroup ( ListTagsLogGroupRequest request ) : ListTagsLogGroupResponse

Lists the tags for the specified log group.

To add tags, use TagLogGroup. To remove tags, use UntagLogGroup.

ListTagsLogGroupAsync ( ListTagsLogGroupRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListTagsLogGroup operation.
PutDestination ( PutDestinationRequest request ) : PutDestinationResponse

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

A destination controls what is written to its Amazon Kinesis stream through an access policy. 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.

PutDestinationAsync ( PutDestinationRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the PutDestination operation.
PutDestinationPolicy ( PutDestinationPolicyRequest request ) : PutDestinationPolicyResponse

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 request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the PutDestinationPolicy operation.
PutLogEvents ( PutLogEventsRequest request ) : PutLogEventsResponse

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.

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 timestamp (the time the event occurred, expressed as the number of milliseconds since 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.

PutLogEventsAsync ( PutLogEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the PutLogEvents operation.
PutMetricFilter ( PutMetricFilterRequest request ) : Amazon.CloudWatchLogs.Model.PutMetricFilterResponse

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.

PutMetricFilterAsync ( PutMetricFilterRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the PutMetricFilter operation.
PutRetentionPolicy ( PutRetentionPolicyRequest request ) : Amazon.CloudWatchLogs.Model.PutRetentionPolicyResponse

Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.
PutRetentionPolicyAsync ( PutRetentionPolicyRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the PutRetentionPolicy operation.
PutSubscriptionFilter ( PutSubscriptionFilterRequest request ) : PutSubscriptionFilterResponse

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

PutSubscriptionFilterAsync ( PutSubscriptionFilterRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the PutSubscriptionFilter operation.
TagLogGroup ( TagLogGroupRequest request ) : TagLogGroupResponse

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.

TagLogGroupAsync ( TagLogGroupRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the TagLogGroup operation.
TestMetricFilter ( TestMetricFilterRequest request ) : TestMetricFilterResponse

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 request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the TestMetricFilter operation.
UntagLogGroup ( UntagLogGroupRequest request ) : UntagLogGroupResponse

Removes the specified tags from the specified log group.

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

UntagLogGroupAsync ( UntagLogGroupRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UntagLogGroup operation.

Protected Methods

Method Description
CreateSigner ( ) : AbstractAWSSigner

Creates the signer for the service.
Dispose ( bool disposing ) : void

Disposes the service client.

Method Details

AmazonCloudWatchLogsClient() public method

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>
public AmazonCloudWatchLogsClient ( ) : System
return System

AmazonCloudWatchLogsClient() public method

Constructs AmazonCloudWatchLogsClient with AWS Credentials
public AmazonCloudWatchLogsClient ( AWSCredentials credentials ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
return System

AmazonCloudWatchLogsClient() public method

Constructs AmazonCloudWatchLogsClient with AWS Credentials and an AmazonCloudWatchLogsClient Configuration object.
public AmazonCloudWatchLogsClient ( AWSCredentials credentials, AmazonCloudWatchLogsConfig clientConfig ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
clientConfig AmazonCloudWatchLogsConfig The AmazonCloudWatchLogsClient Configuration Object
return System

AmazonCloudWatchLogsClient() public method

Constructs AmazonCloudWatchLogsClient with AWS Credentials
public AmazonCloudWatchLogsClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
region RegionEndpoint The region to connect.
return System

AmazonCloudWatchLogsClient() public method

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>
public AmazonCloudWatchLogsClient ( AmazonCloudWatchLogsConfig config ) : System
config AmazonCloudWatchLogsConfig The AmazonCloudWatchLogsClient Configuration Object
return System

AmazonCloudWatchLogsClient() public method

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>
public AmazonCloudWatchLogsClient ( RegionEndpoint region ) : System
region RegionEndpoint The region to connect.
return System

AmazonCloudWatchLogsClient() public method

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key
public AmazonCloudWatchLogsClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
return System

AmazonCloudWatchLogsClient() public method

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object.
public AmazonCloudWatchLogsClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonCloudWatchLogsConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
clientConfig AmazonCloudWatchLogsConfig The AmazonCloudWatchLogsClient Configuration Object
return System

AmazonCloudWatchLogsClient() public method

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key
public AmazonCloudWatchLogsClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
region RegionEndpoint The region to connect.
return System

AmazonCloudWatchLogsClient() public method

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key
public AmazonCloudWatchLogsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
return System

AmazonCloudWatchLogsClient() public method

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object.
public AmazonCloudWatchLogsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonCloudWatchLogsConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
clientConfig AmazonCloudWatchLogsConfig The AmazonCloudWatchLogsClient Configuration Object
return System

AmazonCloudWatchLogsClient() public method

Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key
public AmazonCloudWatchLogsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
region RegionEndpoint The region to connect.
return System

BeginCancelExportTask() public method

Initiates the asynchronous execution of the CancelExportTask operation.
public BeginCancelExportTask ( CancelExportTaskRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.CancelExportTaskRequest Container for the necessary parameters to execute the CancelExportTask operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateExportTask() public method

Initiates the asynchronous execution of the CreateExportTask operation.
public BeginCreateExportTask ( CreateExportTaskRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.CreateExportTaskRequest Container for the necessary parameters to execute the CreateExportTask operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateLogGroup() public method

Initiates the asynchronous execution of the CreateLogGroup operation.
public BeginCreateLogGroup ( CreateLogGroupRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.CreateLogGroupRequest Container for the necessary parameters to execute the CreateLogGroup operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateLogStream() public method

Initiates the asynchronous execution of the CreateLogStream operation.
public BeginCreateLogStream ( CreateLogStreamRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.CreateLogStreamRequest Container for the necessary parameters to execute the CreateLogStream operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteDestination() public method

Initiates the asynchronous execution of the DeleteDestination operation.
public BeginDeleteDestination ( DeleteDestinationRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DeleteDestinationRequest Container for the necessary parameters to execute the DeleteDestination operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteLogGroup() public method

Initiates the asynchronous execution of the DeleteLogGroup operation.
public BeginDeleteLogGroup ( DeleteLogGroupRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest Container for the necessary parameters to execute the DeleteLogGroup operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteLogStream() public method

Initiates the asynchronous execution of the DeleteLogStream operation.
public BeginDeleteLogStream ( DeleteLogStreamRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest Container for the necessary parameters to execute the DeleteLogStream operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteMetricFilter() public method

Initiates the asynchronous execution of the DeleteMetricFilter operation.
public BeginDeleteMetricFilter ( DeleteMetricFilterRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest Container for the necessary parameters to execute the DeleteMetricFilter operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteRetentionPolicy() public method

Initiates the asynchronous execution of the DeleteRetentionPolicy operation.
public BeginDeleteRetentionPolicy ( DeleteRetentionPolicyRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest Container for the necessary parameters to execute the DeleteRetentionPolicy operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteSubscriptionFilter() public method

Initiates the asynchronous execution of the DeleteSubscriptionFilter operation.
public BeginDeleteSubscriptionFilter ( DeleteSubscriptionFilterRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest Container for the necessary parameters to execute the DeleteSubscriptionFilter operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeDestinations() public method

Initiates the asynchronous execution of the DescribeDestinations operation.
public BeginDescribeDestinations ( DescribeDestinationsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest Container for the necessary parameters to execute the DescribeDestinations operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeExportTasks() public method

Initiates the asynchronous execution of the DescribeExportTasks operation.
public BeginDescribeExportTasks ( DescribeExportTasksRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest Container for the necessary parameters to execute the DescribeExportTasks operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeLogGroups() public method

Initiates the asynchronous execution of the DescribeLogGroups operation.
public BeginDescribeLogGroups ( DescribeLogGroupsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest Container for the necessary parameters to execute the DescribeLogGroups operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeLogStreams() public method

Initiates the asynchronous execution of the DescribeLogStreams operation.
public BeginDescribeLogStreams ( DescribeLogStreamsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest Container for the necessary parameters to execute the DescribeLogStreams operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeMetricFilters() public method

Initiates the asynchronous execution of the DescribeMetricFilters operation.
public BeginDescribeMetricFilters ( DescribeMetricFiltersRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest Container for the necessary parameters to execute the DescribeMetricFilters operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeSubscriptionFilters() public method

Initiates the asynchronous execution of the DescribeSubscriptionFilters operation.
public BeginDescribeSubscriptionFilters ( DescribeSubscriptionFiltersRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest Container for the necessary parameters to execute the DescribeSubscriptionFilters operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginFilterLogEvents() public method

Initiates the asynchronous execution of the FilterLogEvents operation.
public BeginFilterLogEvents ( FilterLogEventsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.FilterLogEventsRequest Container for the necessary parameters to execute the FilterLogEvents operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetLogEvents() public method

Initiates the asynchronous execution of the GetLogEvents operation.
public BeginGetLogEvents ( GetLogEventsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.GetLogEventsRequest Container for the necessary parameters to execute the GetLogEvents operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListTagsLogGroup() public method

Initiates the asynchronous execution of the ListTagsLogGroup operation.
public BeginListTagsLogGroup ( ListTagsLogGroupRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.ListTagsLogGroupRequest Container for the necessary parameters to execute the ListTagsLogGroup operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginPutDestination() public method

Initiates the asynchronous execution of the PutDestination operation.
public BeginPutDestination ( PutDestinationRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.PutDestinationRequest Container for the necessary parameters to execute the PutDestination operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginPutDestinationPolicy() public method

Initiates the asynchronous execution of the PutDestinationPolicy operation.
public BeginPutDestinationPolicy ( PutDestinationPolicyRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest Container for the necessary parameters to execute the PutDestinationPolicy operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginPutLogEvents() public method

Initiates the asynchronous execution of the PutLogEvents operation.
public BeginPutLogEvents ( PutLogEventsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.PutLogEventsRequest Container for the necessary parameters to execute the PutLogEvents operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginPutMetricFilter() public method

Initiates the asynchronous execution of the PutMetricFilter operation.
public BeginPutMetricFilter ( PutMetricFilterRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.PutMetricFilterRequest Container for the necessary parameters to execute the PutMetricFilter operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginPutRetentionPolicy() public method

Initiates the asynchronous execution of the PutRetentionPolicy operation.
public BeginPutRetentionPolicy ( PutRetentionPolicyRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest Container for the necessary parameters to execute the PutRetentionPolicy operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginPutSubscriptionFilter() public method

Initiates the asynchronous execution of the PutSubscriptionFilter operation.
public BeginPutSubscriptionFilter ( PutSubscriptionFilterRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest Container for the necessary parameters to execute the PutSubscriptionFilter operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginTagLogGroup() public method

Initiates the asynchronous execution of the TagLogGroup operation.
public BeginTagLogGroup ( TagLogGroupRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.TagLogGroupRequest Container for the necessary parameters to execute the TagLogGroup operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginTestMetricFilter() public method

Initiates the asynchronous execution of the TestMetricFilter operation.
public BeginTestMetricFilter ( TestMetricFilterRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.TestMetricFilterRequest Container for the necessary parameters to execute the TestMetricFilter operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginUntagLogGroup() public method

Initiates the asynchronous execution of the UntagLogGroup operation.
public BeginUntagLogGroup ( UntagLogGroupRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudWatchLogs.Model.UntagLogGroupRequest Container for the necessary parameters to execute the UntagLogGroup operation on AmazonCloudWatchLogsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

CancelExportTask() public method

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

/// The operation is not valid on the specified resource. /// /// A parameter is specified incorrectly. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public CancelExportTask ( CancelExportTaskRequest request ) : CancelExportTaskResponse
request Amazon.CloudWatchLogs.Model.CancelExportTaskRequest Container for the necessary parameters to execute the CancelExportTask service method.
return CancelExportTaskResponse

CancelExportTaskAsync() public method

Initiates the asynchronous execution of the CancelExportTask operation.
public CancelExportTaskAsync ( CancelExportTaskRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.CancelExportTaskRequest Container for the necessary parameters to execute the CancelExportTask operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateExportTask() public method

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 that will be used as the Amazon S3 key prefix for all exported objects.

/// A parameter is specified incorrectly. /// /// You have reached the maximum number of resources that can be created. /// /// Multiple requests to update the same resource were in conflict. /// /// The specified resource already exists. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public CreateExportTask ( CreateExportTaskRequest request ) : CreateExportTaskResponse
request Amazon.CloudWatchLogs.Model.CreateExportTaskRequest Container for the necessary parameters to execute the CreateExportTask service method.
return Amazon.CloudWatchLogs.Model.CreateExportTaskResponse

CreateExportTaskAsync() public method

Initiates the asynchronous execution of the CreateExportTask operation.
public CreateExportTaskAsync ( CreateExportTaskRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.CreateExportTaskRequest Container for the necessary parameters to execute the CreateExportTask operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateLogGroup() public method

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).

/// A parameter is specified incorrectly. /// /// You have reached the maximum number of resources that can be created. /// /// Multiple requests to update the same resource were in conflict. /// /// The specified resource already exists. /// /// The service cannot complete the request. ///
public CreateLogGroup ( CreateLogGroupRequest request ) : Amazon.CloudWatchLogs.Model.CreateLogGroupResponse
request Amazon.CloudWatchLogs.Model.CreateLogGroupRequest Container for the necessary parameters to execute the CreateLogGroup service method.
return Amazon.CloudWatchLogs.Model.CreateLogGroupResponse

CreateLogGroupAsync() public method

Initiates the asynchronous execution of the CreateLogGroup operation.
public CreateLogGroupAsync ( CreateLogGroupRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.CreateLogGroupRequest Container for the necessary parameters to execute the CreateLogGroup operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateLogStream() public method

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.

/// A parameter is specified incorrectly. /// /// The specified resource already exists. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public CreateLogStream ( CreateLogStreamRequest request ) : Amazon.CloudWatchLogs.Model.CreateLogStreamResponse
request Amazon.CloudWatchLogs.Model.CreateLogStreamRequest Container for the necessary parameters to execute the CreateLogStream service method.
return Amazon.CloudWatchLogs.Model.CreateLogStreamResponse

CreateLogStreamAsync() public method

Initiates the asynchronous execution of the CreateLogStream operation.
public CreateLogStreamAsync ( CreateLogStreamRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.CreateLogStreamRequest Container for the necessary parameters to execute the CreateLogStream operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateSigner() protected method

Creates the signer for the service.
protected CreateSigner ( ) : AbstractAWSSigner
return Amazon.Runtime.Internal.Auth.AbstractAWSSigner

DeleteDestination() public method

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.
/// A parameter is specified incorrectly. /// /// Multiple requests to update the same resource were in conflict. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public DeleteDestination ( DeleteDestinationRequest request ) : DeleteDestinationResponse
request Amazon.CloudWatchLogs.Model.DeleteDestinationRequest Container for the necessary parameters to execute the DeleteDestination service method.
return DeleteDestinationResponse

DeleteDestinationAsync() public method

Initiates the asynchronous execution of the DeleteDestination operation.
public DeleteDestinationAsync ( DeleteDestinationRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DeleteDestinationRequest Container for the necessary parameters to execute the DeleteDestination operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteLogGroup() public method

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
/// A parameter is specified incorrectly. /// /// Multiple requests to update the same resource were in conflict. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public DeleteLogGroup ( DeleteLogGroupRequest request ) : Amazon.CloudWatchLogs.Model.DeleteLogGroupResponse
request Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest Container for the necessary parameters to execute the DeleteLogGroup service method.
return Amazon.CloudWatchLogs.Model.DeleteLogGroupResponse

DeleteLogGroupAsync() public method

Initiates the asynchronous execution of the DeleteLogGroup operation.
public DeleteLogGroupAsync ( DeleteLogGroupRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest Container for the necessary parameters to execute the DeleteLogGroup operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteLogStream() public method

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
/// A parameter is specified incorrectly. /// /// Multiple requests to update the same resource were in conflict. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public DeleteLogStream ( DeleteLogStreamRequest request ) : Amazon.CloudWatchLogs.Model.DeleteLogStreamResponse
request Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest Container for the necessary parameters to execute the DeleteLogStream service method.
return Amazon.CloudWatchLogs.Model.DeleteLogStreamResponse

DeleteLogStreamAsync() public method

Initiates the asynchronous execution of the DeleteLogStream operation.
public DeleteLogStreamAsync ( DeleteLogStreamRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest Container for the necessary parameters to execute the DeleteLogStream operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteMetricFilter() public method

Deletes the specified metric filter.
/// A parameter is specified incorrectly. /// /// Multiple requests to update the same resource were in conflict. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public DeleteMetricFilter ( DeleteMetricFilterRequest request ) : Amazon.CloudWatchLogs.Model.DeleteMetricFilterResponse
request Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest Container for the necessary parameters to execute the DeleteMetricFilter service method.
return Amazon.CloudWatchLogs.Model.DeleteMetricFilterResponse

DeleteMetricFilterAsync() public method

Initiates the asynchronous execution of the DeleteMetricFilter operation.
public DeleteMetricFilterAsync ( DeleteMetricFilterRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest Container for the necessary parameters to execute the DeleteMetricFilter operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteRetentionPolicy() public method

Deletes the specified retention policy.

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

/// A parameter is specified incorrectly. /// /// Multiple requests to update the same resource were in conflict. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public DeleteRetentionPolicy ( DeleteRetentionPolicyRequest request ) : Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyResponse
request Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest Container for the necessary parameters to execute the DeleteRetentionPolicy service method.
return Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyResponse

DeleteRetentionPolicyAsync() public method

Initiates the asynchronous execution of the DeleteRetentionPolicy operation.
public DeleteRetentionPolicyAsync ( DeleteRetentionPolicyRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest Container for the necessary parameters to execute the DeleteRetentionPolicy operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteSubscriptionFilter() public method

Deletes the specified subscription filter.
/// A parameter is specified incorrectly. /// /// Multiple requests to update the same resource were in conflict. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public DeleteSubscriptionFilter ( DeleteSubscriptionFilterRequest request ) : DeleteSubscriptionFilterResponse
request Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest Container for the necessary parameters to execute the DeleteSubscriptionFilter service method.
return DeleteSubscriptionFilterResponse

DeleteSubscriptionFilterAsync() public method

Initiates the asynchronous execution of the DeleteSubscriptionFilter operation.
public DeleteSubscriptionFilterAsync ( DeleteSubscriptionFilterRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest Container for the necessary parameters to execute the DeleteSubscriptionFilter operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeDestinations() public method

Lists all your destinations. The results are ASCII-sorted by destination name.
/// A parameter is specified incorrectly. /// /// The service cannot complete the request. ///
public DescribeDestinations ( DescribeDestinationsRequest request ) : DescribeDestinationsResponse
request Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest Container for the necessary parameters to execute the DescribeDestinations service method.
return Amazon.CloudWatchLogs.Model.DescribeDestinationsResponse

DescribeDestinationsAsync() public method

Initiates the asynchronous execution of the DescribeDestinations operation.
public DescribeDestinationsAsync ( DescribeDestinationsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest Container for the necessary parameters to execute the DescribeDestinations operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeExportTasks() public method

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
/// A parameter is specified incorrectly. /// /// The service cannot complete the request. ///
public DescribeExportTasks ( DescribeExportTasksRequest request ) : DescribeExportTasksResponse
request Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest Container for the necessary parameters to execute the DescribeExportTasks service method.
return Amazon.CloudWatchLogs.Model.DescribeExportTasksResponse

DescribeExportTasksAsync() public method

Initiates the asynchronous execution of the DescribeExportTasks operation.
public DescribeExportTasksAsync ( DescribeExportTasksRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest Container for the necessary parameters to execute the DescribeExportTasks operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeLogGroups() public method

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.
/// A parameter is specified incorrectly. /// /// The service cannot complete the request. ///
public DescribeLogGroups ( ) : DescribeLogGroupsResponse
return Amazon.CloudWatchLogs.Model.DescribeLogGroupsResponse

DescribeLogGroups() public method

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.
/// A parameter is specified incorrectly. /// /// The service cannot complete the request. ///
public DescribeLogGroups ( DescribeLogGroupsRequest request ) : DescribeLogGroupsResponse
request Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest Container for the necessary parameters to execute the DescribeLogGroups service method.
return Amazon.CloudWatchLogs.Model.DescribeLogGroupsResponse

DescribeLogGroupsAsync() public method

Initiates the asynchronous execution of the DescribeLogGroups operation.
public DescribeLogGroupsAsync ( DescribeLogGroupsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest Container for the necessary parameters to execute the DescribeLogGroups operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeLogGroupsAsync() public method

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.
/// A parameter is specified incorrectly. /// /// The service cannot complete the request. ///
public DescribeLogGroupsAsync ( System cancellationToken = default(CancellationToken) ) : Task
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeLogStreams() public method

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.

/// A parameter is specified incorrectly. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public DescribeLogStreams ( DescribeLogStreamsRequest request ) : DescribeLogStreamsResponse
request Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest Container for the necessary parameters to execute the DescribeLogStreams service method.
return Amazon.CloudWatchLogs.Model.DescribeLogStreamsResponse

DescribeLogStreamsAsync() public method

Initiates the asynchronous execution of the DescribeLogStreams operation.
public DescribeLogStreamsAsync ( DescribeLogStreamsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest Container for the necessary parameters to execute the DescribeLogStreams operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeMetricFilters() public method

Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, and metric namespace. The results are ASCII-sorted by filter name.
/// A parameter is specified incorrectly. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public DescribeMetricFilters ( DescribeMetricFiltersRequest request ) : DescribeMetricFiltersResponse
request Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest Container for the necessary parameters to execute the DescribeMetricFilters service method.
return Amazon.CloudWatchLogs.Model.DescribeMetricFiltersResponse

DescribeMetricFiltersAsync() public method

Initiates the asynchronous execution of the DescribeMetricFilters operation.
public DescribeMetricFiltersAsync ( DescribeMetricFiltersRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest Container for the necessary parameters to execute the DescribeMetricFilters operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeSubscriptionFilters() public method

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.
/// A parameter is specified incorrectly. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public DescribeSubscriptionFilters ( DescribeSubscriptionFiltersRequest request ) : DescribeSubscriptionFiltersResponse
request Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest Container for the necessary parameters to execute the DescribeSubscriptionFilters service method.
return Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersResponse

DescribeSubscriptionFiltersAsync() public method

Initiates the asynchronous execution of the DescribeSubscriptionFilters operation.
public DescribeSubscriptionFiltersAsync ( DescribeSubscriptionFiltersRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest Container for the necessary parameters to execute the DescribeSubscriptionFilters operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

Dispose() protected method

Disposes the service client.
protected Dispose ( bool disposing ) : void
disposing bool
return void

EndCancelExportTask() public method

Finishes the asynchronous execution of the CancelExportTask operation.
public EndCancelExportTask ( IAsyncResult asyncResult ) : CancelExportTaskResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCancelExportTask.
return CancelExportTaskResponse

EndCreateExportTask() public method

Finishes the asynchronous execution of the CreateExportTask operation.
public EndCreateExportTask ( IAsyncResult asyncResult ) : CreateExportTaskResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateExportTask.
return Amazon.CloudWatchLogs.Model.CreateExportTaskResponse

EndCreateLogGroup() public method

Finishes the asynchronous execution of the CreateLogGroup operation.
public EndCreateLogGroup ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.CreateLogGroupResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateLogGroup.
return Amazon.CloudWatchLogs.Model.CreateLogGroupResponse

EndCreateLogStream() public method

Finishes the asynchronous execution of the CreateLogStream operation.
public EndCreateLogStream ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.CreateLogStreamResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateLogStream.
return Amazon.CloudWatchLogs.Model.CreateLogStreamResponse

EndDeleteDestination() public method

Finishes the asynchronous execution of the DeleteDestination operation.
public EndDeleteDestination ( IAsyncResult asyncResult ) : DeleteDestinationResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteDestination.
return DeleteDestinationResponse

EndDeleteLogGroup() public method

Finishes the asynchronous execution of the DeleteLogGroup operation.
public EndDeleteLogGroup ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.DeleteLogGroupResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteLogGroup.
return Amazon.CloudWatchLogs.Model.DeleteLogGroupResponse

EndDeleteLogStream() public method

Finishes the asynchronous execution of the DeleteLogStream operation.
public EndDeleteLogStream ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.DeleteLogStreamResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteLogStream.
return Amazon.CloudWatchLogs.Model.DeleteLogStreamResponse

EndDeleteMetricFilter() public method

Finishes the asynchronous execution of the DeleteMetricFilter operation.
public EndDeleteMetricFilter ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.DeleteMetricFilterResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteMetricFilter.
return Amazon.CloudWatchLogs.Model.DeleteMetricFilterResponse

EndDeleteRetentionPolicy() public method

Finishes the asynchronous execution of the DeleteRetentionPolicy operation.
public EndDeleteRetentionPolicy ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteRetentionPolicy.
return Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyResponse

EndDeleteSubscriptionFilter() public method

Finishes the asynchronous execution of the DeleteSubscriptionFilter operation.
public EndDeleteSubscriptionFilter ( IAsyncResult asyncResult ) : DeleteSubscriptionFilterResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteSubscriptionFilter.
return DeleteSubscriptionFilterResponse

EndDescribeDestinations() public method

Finishes the asynchronous execution of the DescribeDestinations operation.
public EndDescribeDestinations ( IAsyncResult asyncResult ) : DescribeDestinationsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeDestinations.
return Amazon.CloudWatchLogs.Model.DescribeDestinationsResponse

EndDescribeExportTasks() public method

Finishes the asynchronous execution of the DescribeExportTasks operation.
public EndDescribeExportTasks ( IAsyncResult asyncResult ) : DescribeExportTasksResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeExportTasks.
return Amazon.CloudWatchLogs.Model.DescribeExportTasksResponse

EndDescribeLogGroups() public method

Finishes the asynchronous execution of the DescribeLogGroups operation.
public EndDescribeLogGroups ( IAsyncResult asyncResult ) : DescribeLogGroupsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeLogGroups.
return Amazon.CloudWatchLogs.Model.DescribeLogGroupsResponse

EndDescribeLogStreams() public method

Finishes the asynchronous execution of the DescribeLogStreams operation.
public EndDescribeLogStreams ( IAsyncResult asyncResult ) : DescribeLogStreamsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeLogStreams.
return Amazon.CloudWatchLogs.Model.DescribeLogStreamsResponse

EndDescribeMetricFilters() public method

Finishes the asynchronous execution of the DescribeMetricFilters operation.
public EndDescribeMetricFilters ( IAsyncResult asyncResult ) : DescribeMetricFiltersResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeMetricFilters.
return Amazon.CloudWatchLogs.Model.DescribeMetricFiltersResponse

EndDescribeSubscriptionFilters() public method

Finishes the asynchronous execution of the DescribeSubscriptionFilters operation.
public EndDescribeSubscriptionFilters ( IAsyncResult asyncResult ) : DescribeSubscriptionFiltersResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeSubscriptionFilters.
return Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersResponse

EndFilterLogEvents() public method

Finishes the asynchronous execution of the FilterLogEvents operation.
public EndFilterLogEvents ( IAsyncResult asyncResult ) : FilterLogEventsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginFilterLogEvents.
return Amazon.CloudWatchLogs.Model.FilterLogEventsResponse

EndGetLogEvents() public method

Finishes the asynchronous execution of the GetLogEvents operation.
public EndGetLogEvents ( IAsyncResult asyncResult ) : GetLogEventsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetLogEvents.
return Amazon.CloudWatchLogs.Model.GetLogEventsResponse

EndListTagsLogGroup() public method

Finishes the asynchronous execution of the ListTagsLogGroup operation.
public EndListTagsLogGroup ( IAsyncResult asyncResult ) : ListTagsLogGroupResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListTagsLogGroup.
return Amazon.CloudWatchLogs.Model.ListTagsLogGroupResponse

EndPutDestination() public method

Finishes the asynchronous execution of the PutDestination operation.
public EndPutDestination ( IAsyncResult asyncResult ) : PutDestinationResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginPutDestination.
return Amazon.CloudWatchLogs.Model.PutDestinationResponse

EndPutDestinationPolicy() public method

Finishes the asynchronous execution of the PutDestinationPolicy operation.
public EndPutDestinationPolicy ( IAsyncResult asyncResult ) : PutDestinationPolicyResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginPutDestinationPolicy.
return PutDestinationPolicyResponse

EndPutLogEvents() public method

Finishes the asynchronous execution of the PutLogEvents operation.
public EndPutLogEvents ( IAsyncResult asyncResult ) : PutLogEventsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginPutLogEvents.
return Amazon.CloudWatchLogs.Model.PutLogEventsResponse

EndPutMetricFilter() public method

Finishes the asynchronous execution of the PutMetricFilter operation.
public EndPutMetricFilter ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.PutMetricFilterResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginPutMetricFilter.
return Amazon.CloudWatchLogs.Model.PutMetricFilterResponse

EndPutRetentionPolicy() public method

Finishes the asynchronous execution of the PutRetentionPolicy operation.
public EndPutRetentionPolicy ( IAsyncResult asyncResult ) : Amazon.CloudWatchLogs.Model.PutRetentionPolicyResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginPutRetentionPolicy.
return Amazon.CloudWatchLogs.Model.PutRetentionPolicyResponse

EndPutSubscriptionFilter() public method

Finishes the asynchronous execution of the PutSubscriptionFilter operation.
public EndPutSubscriptionFilter ( IAsyncResult asyncResult ) : PutSubscriptionFilterResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginPutSubscriptionFilter.
return PutSubscriptionFilterResponse

EndTagLogGroup() public method

Finishes the asynchronous execution of the TagLogGroup operation.
public EndTagLogGroup ( IAsyncResult asyncResult ) : TagLogGroupResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginTagLogGroup.
return TagLogGroupResponse

EndTestMetricFilter() public method

Finishes the asynchronous execution of the TestMetricFilter operation.
public EndTestMetricFilter ( IAsyncResult asyncResult ) : TestMetricFilterResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginTestMetricFilter.
return Amazon.CloudWatchLogs.Model.TestMetricFilterResponse

EndUntagLogGroup() public method

Finishes the asynchronous execution of the UntagLogGroup operation.
public EndUntagLogGroup ( IAsyncResult asyncResult ) : UntagLogGroupResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginUntagLogGroup.
return UntagLogGroupResponse

FilterLogEvents() public method

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 1MB (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.

/// A parameter is specified incorrectly. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public FilterLogEvents ( FilterLogEventsRequest request ) : FilterLogEventsResponse
request Amazon.CloudWatchLogs.Model.FilterLogEventsRequest Container for the necessary parameters to execute the FilterLogEvents service method.
return Amazon.CloudWatchLogs.Model.FilterLogEventsResponse

FilterLogEventsAsync() public method

Initiates the asynchronous execution of the FilterLogEvents operation.
public FilterLogEventsAsync ( FilterLogEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.FilterLogEventsRequest Container for the necessary parameters to execute the FilterLogEvents operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetLogEvents() public method

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). If the results include tokens, there are more log events available. You can get additional log events by specifying one of the tokens in a subsequent call.

/// A parameter is specified incorrectly. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public GetLogEvents ( GetLogEventsRequest request ) : GetLogEventsResponse
request Amazon.CloudWatchLogs.Model.GetLogEventsRequest Container for the necessary parameters to execute the GetLogEvents service method.
return Amazon.CloudWatchLogs.Model.GetLogEventsResponse

GetLogEventsAsync() public method

Initiates the asynchronous execution of the GetLogEvents operation.
public GetLogEventsAsync ( GetLogEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.GetLogEventsRequest Container for the necessary parameters to execute the GetLogEvents operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListTagsLogGroup() public method

Lists the tags for the specified log group.

To add tags, use TagLogGroup. To remove tags, use UntagLogGroup.

/// The specified resource does not exist. /// /// The service cannot complete the request. ///
public ListTagsLogGroup ( ListTagsLogGroupRequest request ) : ListTagsLogGroupResponse
request Amazon.CloudWatchLogs.Model.ListTagsLogGroupRequest Container for the necessary parameters to execute the ListTagsLogGroup service method.
return Amazon.CloudWatchLogs.Model.ListTagsLogGroupResponse

ListTagsLogGroupAsync() public method

Initiates the asynchronous execution of the ListTagsLogGroup operation.
public ListTagsLogGroupAsync ( ListTagsLogGroupRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.ListTagsLogGroupRequest Container for the necessary parameters to execute the ListTagsLogGroup operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

PutDestination() public method

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

A destination controls what is written to its Amazon Kinesis stream through an access policy. 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.

/// A parameter is specified incorrectly. /// /// Multiple requests to update the same resource were in conflict. /// /// The service cannot complete the request. ///
public PutDestination ( PutDestinationRequest request ) : PutDestinationResponse
request Amazon.CloudWatchLogs.Model.PutDestinationRequest Container for the necessary parameters to execute the PutDestination service method.
return Amazon.CloudWatchLogs.Model.PutDestinationResponse

PutDestinationAsync() public method

Initiates the asynchronous execution of the PutDestination operation.
public PutDestinationAsync ( PutDestinationRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.PutDestinationRequest Container for the necessary parameters to execute the PutDestination operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

PutDestinationPolicy() public method

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.
/// A parameter is specified incorrectly. /// /// Multiple requests to update the same resource were in conflict. /// /// The service cannot complete the request. ///
public PutDestinationPolicy ( PutDestinationPolicyRequest request ) : PutDestinationPolicyResponse
request Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest Container for the necessary parameters to execute the PutDestinationPolicy service method.
return PutDestinationPolicyResponse

PutDestinationPolicyAsync() public method

Initiates the asynchronous execution of the PutDestinationPolicy operation.
public PutDestinationPolicyAsync ( PutDestinationPolicyRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest Container for the necessary parameters to execute the PutDestinationPolicy operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

PutLogEvents() public method

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.

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 timestamp (the time the event occurred, expressed as the number of milliseconds since 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.

/// The event was already logged. /// /// A parameter is specified incorrectly. /// /// The sequence token is not valid. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public PutLogEvents ( PutLogEventsRequest request ) : PutLogEventsResponse
request Amazon.CloudWatchLogs.Model.PutLogEventsRequest Container for the necessary parameters to execute the PutLogEvents service method.
return Amazon.CloudWatchLogs.Model.PutLogEventsResponse

PutLogEventsAsync() public method

Initiates the asynchronous execution of the PutLogEvents operation.
public PutLogEventsAsync ( PutLogEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.PutLogEventsRequest Container for the necessary parameters to execute the PutLogEvents operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

PutMetricFilter() public method

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.

/// A parameter is specified incorrectly. /// /// You have reached the maximum number of resources that can be created. /// /// Multiple requests to update the same resource were in conflict. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public PutMetricFilter ( PutMetricFilterRequest request ) : Amazon.CloudWatchLogs.Model.PutMetricFilterResponse
request Amazon.CloudWatchLogs.Model.PutMetricFilterRequest Container for the necessary parameters to execute the PutMetricFilter service method.
return Amazon.CloudWatchLogs.Model.PutMetricFilterResponse

PutMetricFilterAsync() public method

Initiates the asynchronous execution of the PutMetricFilter operation.
public PutMetricFilterAsync ( PutMetricFilterRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.PutMetricFilterRequest Container for the necessary parameters to execute the PutMetricFilter operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

PutRetentionPolicy() public method

Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.
/// A parameter is specified incorrectly. /// /// Multiple requests to update the same resource were in conflict. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public PutRetentionPolicy ( PutRetentionPolicyRequest request ) : Amazon.CloudWatchLogs.Model.PutRetentionPolicyResponse
request Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest Container for the necessary parameters to execute the PutRetentionPolicy service method.
return Amazon.CloudWatchLogs.Model.PutRetentionPolicyResponse

PutRetentionPolicyAsync() public method

Initiates the asynchronous execution of the PutRetentionPolicy operation.
public PutRetentionPolicyAsync ( PutRetentionPolicyRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest Container for the necessary parameters to execute the PutRetentionPolicy operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

PutSubscriptionFilter() public method

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

/// A parameter is specified incorrectly. /// /// You have reached the maximum number of resources that can be created. /// /// Multiple requests to update the same resource were in conflict. /// /// The specified resource does not exist. /// /// The service cannot complete the request. ///
public PutSubscriptionFilter ( PutSubscriptionFilterRequest request ) : PutSubscriptionFilterResponse
request Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest Container for the necessary parameters to execute the PutSubscriptionFilter service method.
return PutSubscriptionFilterResponse

PutSubscriptionFilterAsync() public method

Initiates the asynchronous execution of the PutSubscriptionFilter operation.
public PutSubscriptionFilterAsync ( PutSubscriptionFilterRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest Container for the necessary parameters to execute the PutSubscriptionFilter operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

TagLogGroup() public method

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.

/// A parameter is specified incorrectly. /// /// The specified resource does not exist. ///
public TagLogGroup ( TagLogGroupRequest request ) : TagLogGroupResponse
request Amazon.CloudWatchLogs.Model.TagLogGroupRequest Container for the necessary parameters to execute the TagLogGroup service method.
return TagLogGroupResponse

TagLogGroupAsync() public method

Initiates the asynchronous execution of the TagLogGroup operation.
public TagLogGroupAsync ( TagLogGroupRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.TagLogGroupRequest Container for the necessary parameters to execute the TagLogGroup operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

TestMetricFilter() public method

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.
/// A parameter is specified incorrectly. /// /// The service cannot complete the request. ///
public TestMetricFilter ( TestMetricFilterRequest request ) : TestMetricFilterResponse
request Amazon.CloudWatchLogs.Model.TestMetricFilterRequest Container for the necessary parameters to execute the TestMetricFilter service method.
return Amazon.CloudWatchLogs.Model.TestMetricFilterResponse

TestMetricFilterAsync() public method

Initiates the asynchronous execution of the TestMetricFilter operation.
public TestMetricFilterAsync ( TestMetricFilterRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.TestMetricFilterRequest Container for the necessary parameters to execute the TestMetricFilter operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UntagLogGroup() public method

Removes the specified tags from the specified log group.

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

/// The specified resource does not exist. ///
public UntagLogGroup ( UntagLogGroupRequest request ) : UntagLogGroupResponse
request Amazon.CloudWatchLogs.Model.UntagLogGroupRequest Container for the necessary parameters to execute the UntagLogGroup service method.
return UntagLogGroupResponse

UntagLogGroupAsync() public method

Initiates the asynchronous execution of the UntagLogGroup operation.
public UntagLogGroupAsync ( UntagLogGroupRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudWatchLogs.Model.UntagLogGroupRequest Container for the necessary parameters to execute the UntagLogGroup operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task