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.
Name | Description | |
---|---|---|
CancelExportTaskRequest |
Container for the parameters to the CancelExportTask operation.
Cancels an export task if it is in PENDING or RUNNING state.
|
|
CancelExportTaskResponse | ||
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, 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. |
|
CreateExportTaskResponse | Configuration for accessing Amazon CreateExportTask service | |
CreateExportTaskResult | ||
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:
|
|
CreateLogGroupResponse | ||
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:
|
|
CreateLogStreamResponse | ||
DataAlreadyAcceptedException | CloudWatchLogs exception | |
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. | |
DeleteDestinationResponse | ||
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. | |
DeleteLogGroupResponse | ||
DeleteLogStreamRequest | Container for the parameters to the DeleteLogStream operation. Deletes a log stream and permanently deletes all the archived log events associated with it. | |
DeleteLogStreamResponse | ||
DeleteMetricFilterRequest | Container for the parameters to the DeleteMetricFilter operation. Deletes a metric filter associated with the specified log group. | |
DeleteMetricFilterResponse | ||
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. | |
DeleteRetentionPolicyResponse | ||
DeleteSubscriptionFilterRequest | Container for the parameters to the DeleteSubscriptionFilter operation. Deletes a subscription filter associated with the specified log group. | |
DeleteSubscriptionFilterResponse | ||
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 |
|
DescribeDestinationsResponse | Configuration for accessing Amazon DescribeDestinations service | |
DescribeDestinationsResult | ||
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 |
|
DescribeExportTasksResponse | Configuration for accessing Amazon DescribeExportTasks service | |
DescribeExportTasksResult | ||
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 |
|
DescribeLogGroupsResponse | Configuration for accessing Amazon DescribeLogGroups service | |
DescribeLogGroupsResult | ||
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 |
|
DescribeLogStreamsResponse | Configuration for accessing Amazon DescribeLogStreams service | |
DescribeLogStreamsResult | ||
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 |
|
DescribeMetricFiltersResponse | Configuration for accessing Amazon DescribeMetricFilters service | |
DescribeMetricFiltersResult | ||
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 |
|
DescribeSubscriptionFiltersResponse | Configuration for accessing Amazon DescribeSubscriptionFilters service | |
DescribeSubscriptionFiltersResult | ||
Destination | A cross account destination that is the recipient of subscription log events. | |
ExportTask | Represents an export task. | |
ExportTaskExecutionInfo | Represents the status of an export task. | |
ExportTaskStatus | Represents the status of an export task. | |
FilteredLogEvent |
Represents a matched event from a FilterLogEvents request.
|
|
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 |
|
FilterLogEventsResponse | Configuration for accessing Amazon FilterLogEvents service | |
FilterLogEventsResult | ||
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 |
|
GetLogEventsResponse | Configuration for accessing Amazon GetLogEvents service | |
GetLogEventsResult | ||
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. | |
InvalidOperationException | CloudWatchLogs exception | |
InvalidParameterException | CloudWatchLogs exception | |
InvalidSequenceTokenException | CloudWatchLogs exception | |
LimitExceededException | CloudWatchLogs exception | |
LogGroup | ||
LogStream | A log stream is sequence of log events from a single emitter of logs. | |
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. | |
MetricFilterMatchRecord | ||
MetricTransformation | ||
OperationAbortedException | CloudWatchLogs exception | |
OutputLogEvent | ||
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.
|
|
PutDestinationPolicyResponse | ||
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 |
|
PutDestinationResponse | Configuration for accessing Amazon PutDestination service | |
PutDestinationResult | ||
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 The batch of events must satisfy the following constraints:
|
|
PutLogEventsResponse | Configuration for accessing Amazon PutLogEvents service | |
PutLogEventsResult | ||
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. |
|
PutMetricFilterResponse | ||
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. | |
PutRetentionPolicyResponse | ||
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:
Currently there can only be one subscription filter associated with a log group. |
|
PutSubscriptionFilterResponse | ||
RejectedLogEventsInfo | ||
ResourceAlreadyExistsException | CloudWatchLogs exception | |
ResourceNotFoundException | CloudWatchLogs exception | |
SearchedLogStream |
An object indicating the search status of a log stream in a FilterLogEvents
request.
|
|
ServiceUnavailableException | CloudWatchLogs exception | |
SubscriptionFilter | ||
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. | |
TestMetricFilterResponse | Configuration for accessing Amazon TestMetricFilter service | |
TestMetricFilterResult |