AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AssociateKmsKeyRequest

Container for the parameters to the AssociateKmsKey operation. Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.

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

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

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

Class AssociateKmsKeyResponse

This is the response object from the AssociateKmsKey operation.

Class CancelExportTaskRequest

Container for the parameters to the CancelExportTask operation. Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

Class CancelExportTaskResponse

This is the response object from the CancelExportTask operation.

Class CreateExportTaskRequest

Container for the parameters to the CreateExportTask operation. Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.

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

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

Class CreateExportTaskResponse

This is the response object from the CreateExportTask operation.

Class CreateLogGroupRequest

Container for the parameters to the CreateLogGroup operation. Creates a log group with the specified name.

You can create up to 5000 log groups per account.

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

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

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

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

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

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

Class CreateLogGroupResponse

This is the response object from the CreateLogGroup operation.

Class CreateLogStreamRequest

Container for the parameters to the CreateLogStream operation. 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.

Class CreateLogStreamResponse

This is the response object from the CreateLogStream operation.

Class DataAlreadyAcceptedException

CloudWatchLogs exception

Class DeleteDestinationRequest

Container for the parameters to the DeleteDestination operation. 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.

Class DeleteDestinationResponse

This is the response object from the DeleteDestination operation.

Class DeleteLogGroupRequest

Container for the parameters to the DeleteLogGroup operation. Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

Class DeleteLogGroupResponse

This is the response object from the DeleteLogGroup operation.

Class DeleteLogStreamRequest

Container for the parameters to the DeleteLogStream operation. Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

Class DeleteLogStreamResponse

This is the response object from the DeleteLogStream operation.

Class DeleteMetricFilterRequest

Container for the parameters to the DeleteMetricFilter operation. Deletes the specified metric filter.

Class DeleteMetricFilterResponse

This is the response object from the DeleteMetricFilter operation.

Class DeleteResourcePolicyRequest

Container for the parameters to the DeleteResourcePolicy operation. Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.

Class DeleteResourcePolicyResponse

This is the response object from the DeleteResourcePolicy operation.

Class DeleteRetentionPolicyRequest

Container for the parameters to the DeleteRetentionPolicy operation. Deletes the specified retention policy.

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

Class DeleteRetentionPolicyResponse

This is the response object from the DeleteRetentionPolicy operation.

Class DeleteSubscriptionFilterRequest

Container for the parameters to the DeleteSubscriptionFilter operation. Deletes the specified subscription filter.

Class DeleteSubscriptionFilterResponse

This is the response object from the DeleteSubscriptionFilter operation.

Class DescribeDestinationsRequest

Container for the parameters to the DescribeDestinations operation. Lists all your destinations. The results are ASCII-sorted by destination name.

Class DescribeDestinationsResponse

This is the response object from the DescribeDestinations operation.

Class DescribeExportTasksRequest

Container for the parameters to the DescribeExportTasks operation. Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

Class DescribeExportTasksResponse

This is the response object from the DescribeExportTasks operation.

Class DescribeLogGroupsRequest

Container for the parameters to the DescribeLogGroups operation. 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.

Class DescribeLogGroupsResponse

This is the response object from the DescribeLogGroups operation.

Class DescribeLogStreamsRequest

Container for the parameters to the DescribeLogStreams operation. 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.

Class DescribeLogStreamsResponse

This is the response object from the DescribeLogStreams operation.

Class DescribeMetricFiltersRequest

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

Class DescribeMetricFiltersResponse

This is the response object from the DescribeMetricFilters operation.

Class DescribeResourcePoliciesRequest

Container for the parameters to the DescribeResourcePolicies operation. Lists the resource policies in this account.

Class DescribeResourcePoliciesResponse

This is the response object from the DescribeResourcePolicies operation.

Class DescribeSubscriptionFiltersRequest

Container for the parameters to the DescribeSubscriptionFilters operation. 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.

Class DescribeSubscriptionFiltersResponse

This is the response object from the DescribeSubscriptionFilters operation.

Class Destination

Represents a cross-account destination that receives subscription log events.

Class DisassociateKmsKeyRequest

Container for the parameters to the DisassociateKmsKey operation. Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.

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

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

Class DisassociateKmsKeyResponse

This is the response object from the DisassociateKmsKey operation.

Class ExportTask

Represents an export task.

Class ExportTaskExecutionInfo

Represents the status of an export task.

Class ExportTaskStatus

Represents the status of an export task.

Class FilteredLogEvent

Represents a matched event.

Class FilterLogEventsRequest

Container for the parameters to the FilterLogEvents operation. Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

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

Class FilterLogEventsResponse

This is the response object from the FilterLogEvents operation.

Class GetLogEventsRequest

Container for the parameters to the GetLogEvents operation. Lists log events from the specified log stream. You can list all the log events or filter using a time range.

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

Class GetLogEventsResponse

This is the response object from the GetLogEvents operation.

Class InputLogEvent

Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.

Class InvalidOperationException

CloudWatchLogs exception

Class InvalidParameterException

CloudWatchLogs exception

Class InvalidSequenceTokenException

CloudWatchLogs exception

Class LimitExceededException

CloudWatchLogs exception

Class ListTagsLogGroupRequest

Container for the parameters to the ListTagsLogGroup operation. Lists the tags for the specified log group.

Class ListTagsLogGroupResponse

This is the response object from the ListTagsLogGroup operation.

Class LogGroup

Represents a log group.

Class LogStream

Represents a log stream, which is a sequence of log events from a single emitter of logs.

Class MetricFilter

Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.

Class MetricFilterMatchRecord

Represents a matched event.

Class MetricTransformation

Indicates how to transform ingested log events in to metric data in a CloudWatch metric.

Class OperationAbortedException

CloudWatchLogs exception

Class OutputLogEvent

Represents a log event.

Class PutDestinationPolicyRequest

Container for the parameters to the PutDestinationPolicy operation. 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.

Class PutDestinationPolicyResponse

This is the response object from the PutDestinationPolicy operation.

Class PutDestinationRequest

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

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

Class PutDestinationResponse

This is the response object from the PutDestination operation.

Class PutLogEventsRequest

Container for the parameters to the PutLogEvents operation. Uploads a batch of log events to the specified log stream.

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

The batch of events must satisfy the following constraints:

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

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

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

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

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

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

Class PutLogEventsResponse

This is the response object from the PutLogEvents operation.

Class PutMetricFilterRequest

Container for the parameters to the PutMetricFilter operation. 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.

Class PutMetricFilterResponse

This is the response object from the PutMetricFilter operation.

Class PutResourcePolicyRequest

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

Class PutResourcePolicyResponse

This is the response object from the PutResourcePolicy operation.

Class PutRetentionPolicyRequest

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

Class PutRetentionPolicyResponse

This is the response object from the PutRetentionPolicy operation.

Class PutSubscriptionFilterRequest

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

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

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

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

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

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

Class PutSubscriptionFilterResponse

This is the response object from the PutSubscriptionFilter operation.

Class RejectedLogEventsInfo

Represents the rejected events.

Class ResourceAlreadyExistsException

CloudWatchLogs exception

Class ResourceNotFoundException

CloudWatchLogs exception

Class ResourcePolicy

A policy enabling one or more entities to put logs to a log group in this account.

Class SearchedLogStream

Represents the search status of a log stream.

Class ServiceUnavailableException

CloudWatchLogs exception

Class SubscriptionFilter

Represents a subscription filter.

Class TagLogGroupRequest

Container for the parameters to the TagLogGroup operation. 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.

Class TagLogGroupResponse

This is the response object from the TagLogGroup operation.

Class TestMetricFilterRequest

Container for the parameters to the TestMetricFilter operation. 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.

Class TestMetricFilterResponse

This is the response object from the TestMetricFilter operation.

Class UntagLogGroupRequest

Container for the parameters to the UntagLogGroup operation. Removes the specified tags from the specified log group.

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

Class UntagLogGroupResponse

This is the response object from the UntagLogGroup operation.