AWS SDK Version 2 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.

.NET Framework 4.5
 

Classes

NameDescription
Class CancelExportTaskRequest Container for the parameters to the CancelExportTask operation. Cancels an export task if it is in PENDING or RUNNING state.
Class CancelExportTaskResponse
Class CreateExportTaskRequest Container for the parameters to the CreateExportTask operation. Creates an ExportTask which allows you to efficiently export data from a Log Group to your Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, DescribeExportTasks can be used to get the status of an export task. You can only have one active (RUNNING or PENDING) export task at a time, per account.

You can export logs from multiple log groups or multiple time ranges to the same Amazon 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.

Class CreateExportTaskResponse Configuration for accessing Amazon CreateExportTask service
Class CreateExportTaskResult
Class CreateLogGroupRequest Container for the parameters to the CreateLogGroup operation. Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.

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

  • Log group names can be between 1 and 512 characters long.
  • Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Class CreateLogGroupResponse
Class CreateLogStreamRequest Container for the parameters to the CreateLogStream operation. Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.

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

  • Log stream names can be between 1 and 512 characters long.
  • The ':' colon character is not allowed.

Class CreateLogStreamResponse
Class DataAlreadyAcceptedException CloudWatchLogs exception
Class DeleteDestinationRequest Container for the parameters to the DeleteDestination operation. Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination.
Class DeleteDestinationResponse
Class DeleteLogGroupRequest Container for the parameters to the DeleteLogGroup operation. Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
Class DeleteLogGroupResponse
Class DeleteLogStreamRequest Container for the parameters to the DeleteLogStream operation. Deletes a log stream and permanently deletes all the archived log events associated with it.
Class DeleteLogStreamResponse
Class DeleteMetricFilterRequest Container for the parameters to the DeleteMetricFilter operation. Deletes a metric filter associated with the specified log group.
Class DeleteMetricFilterResponse
Class DeleteRetentionPolicyRequest Container for the parameters to the DeleteRetentionPolicy operation. Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.
Class DeleteRetentionPolicyResponse
Class DeleteSubscriptionFilterRequest Container for the parameters to the DeleteSubscriptionFilter operation. Deletes a subscription filter associated with the specified log group.
Class DeleteSubscriptionFilterResponse
Class DescribeDestinationsRequest Container for the parameters to the DescribeDestinations operation. Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name.

By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a nextToken value in the response body. You can also limit the number of destinations returned in the response by specifying the limit parameter in the request.

Class DescribeDestinationsResponse Configuration for accessing Amazon DescribeDestinations service
Class DescribeDestinationsResult
Class DescribeExportTasksRequest Container for the parameters to the DescribeExportTasks operation. Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on TaskId or TaskStatus.

By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a nextToken value in the response body. You can also limit the number of export tasks returned in the response by specifying the limit parameter in the request.

Class DescribeExportTasksResponse Configuration for accessing Amazon DescribeExportTasks service
Class DescribeExportTasksResult
Class DescribeLogGroupsRequest Container for the parameters to the DescribeLogGroups operation. Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.

By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a nextToken value in the response body. You can also limit the number of log groups returned in the response by specifying the limit parameter in the request.

Class DescribeLogGroupsResponse Configuration for accessing Amazon DescribeLogGroups service
Class DescribeLogGroupsResult
Class DescribeLogStreamsRequest Container for the parameters to the DescribeLogStreams operation. Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.

By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled.

Class DescribeLogStreamsResponse Configuration for accessing Amazon DescribeLogStreams service
Class DescribeLogStreamsResult
Class DescribeMetricFiltersRequest Container for the parameters to the DescribeMetricFilters operation. Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a nextToken value in the response body. You can also limit the number of metric filters returned in the response by specifying the limit parameter in the request.

Class DescribeMetricFiltersResponse Configuration for accessing Amazon DescribeMetricFilters service
Class DescribeMetricFiltersResult
Class DescribeSubscriptionFiltersRequest Container for the parameters to the DescribeSubscriptionFilters operation. Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

By default, this operation returns up to 50 subscription filters. If there are more subscription filters to list, the response would contain a nextToken value in the response body. You can also limit the number of subscription filters returned in the response by specifying the limit parameter in the request.

Class DescribeSubscriptionFiltersResponse Configuration for accessing Amazon DescribeSubscriptionFilters service
Class DescribeSubscriptionFiltersResult
Class Destination A cross account destination that is the recipient of subscription log events.
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 from a FilterLogEvents request.
Class FilterLogEventsRequest Container for the parameters to the FilterLogEvents operation. Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event timestamp. You can limit the streams searched to an explicit list of logStreamNames.

By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a nextToken, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of searchedLogStreams that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The limit parameter in the request. can be used to specify the maximum number of events to return in a page.

Class FilterLogEventsResponse Configuration for accessing Amazon FilterLogEvents service
Class FilterLogEventsResult
Class GetLogEventsRequest Container for the parameters to the GetLogEvents operation. Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp.

By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.

Class GetLogEventsResponse Configuration for accessing Amazon GetLogEvents service
Class GetLogEventsResult
Class InputLogEvent A log event is a record of some activity that was recorded by the application or resource being monitored. The log event record that CloudWatch Logs understands contains two properties: the timestamp of when the event occurred, and the raw event message.
Class InvalidOperationException CloudWatchLogs exception
Class InvalidParameterException CloudWatchLogs exception
Class InvalidSequenceTokenException CloudWatchLogs exception
Class LimitExceededException CloudWatchLogs exception
Class LogGroup
Class LogStream A log stream is sequence of log events from a single emitter of logs.
Class MetricFilter Metric filters can be used to express how CloudWatch Logs would extract metric observations from ingested log events and transform them to metric data in a CloudWatch metric.
Class MetricFilterMatchRecord
Class MetricTransformation
Class OperationAbortedException CloudWatchLogs exception
Class OutputLogEvent
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
Class PutDestinationRequest Container for the parameters to the PutDestination operation. Creates or updates a Destination. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through PutLogEvents requests. 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 will not be able to call PutSubscriptionFilter against this destination. To enable that, the destination owner must call PutDestinationPolicy after PutDestination.

Class PutDestinationResponse Configuration for accessing Amazon PutDestination service
Class PutDestinationResult
Class PutLogEventsRequest Container for the parameters to the PutLogEvents operation. Uploads a batch of log events to the specified log stream.

Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request. An upload in a newly created log stream does not require a sequenceToken.

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 maximum number of log events in a batch is 10,000.
  • A batch of log events in a single PutLogEvents request cannot span more than 24 hours. Otherwise, the PutLogEvents operation will fail.

Class PutLogEventsResponse Configuration for accessing Amazon PutLogEvents service
Class PutLogEventsResult
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 requests.

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

Class PutMetricFilterResponse
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 you want to retain log events in the specified log group.
Class PutRetentionPolicyResponse
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 requests 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 (used via an ARN of Destination) belonging to a different account, for cross-account delivery.
  • An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery.
  • An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

Currently there can only be one subscription filter associated with a log group.

Class PutSubscriptionFilterResponse
Class RejectedLogEventsInfo
Class ResourceAlreadyExistsException CloudWatchLogs exception
Class ResourceNotFoundException CloudWatchLogs exception
Class SearchedLogStream An object indicating the search status of a log stream in a FilterLogEvents request.
Class ServiceUnavailableException CloudWatchLogs exception
Class SubscriptionFilter
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 Configuration for accessing Amazon TestMetricFilter service
Class TestMetricFilterResult