aws-elixir

v0.0.5

AWS.Logs

Amazon CloudWatch Logs API Reference

This is the Amazon CloudWatch Logs API Reference. Amazon CloudWatch Logs enables you to monitor, store, and access your system, application, and custom log files. This guide provides detailed information about Amazon CloudWatch Logs actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch Logs features and their associated API calls, go to the Amazon CloudWatch Developer Guide.

Use the following links to get started using the Amazon CloudWatch Logs API Reference:

  • [Actions](http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_Operations.html): An alphabetical list of all Amazon CloudWatch Logs actions.
  • [Data Types](http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_Types.html): An alphabetical list of all Amazon CloudWatch Logs data types.
  • [Common Parameters](http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/CommonParameters.html): Parameters that all Query actions can use.
  • [Common Errors](http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/CommonErrors.html): Client and server errors that all actions can return.
  • [Regions and Endpoints](http://docs.aws.amazon.com/general/latest/gr/index.html?rande.html): Itemized regions and endpoints for all AWS products.
In addition to using the Amazon CloudWatch Logs API, you can also use the following SDKs and third-party libraries to access Amazon CloudWatch Logs programmatically.
  • [AWS SDK for Java Documentation](http://aws.amazon.com/documentation/sdkforjava/)
  • [AWS SDK for .NET Documentation](http://aws.amazon.com/documentation/sdkfornet/)
  • [AWS SDK for PHP Documentation](http://aws.amazon.com/documentation/sdkforphp/)
  • [AWS SDK for Ruby Documentation](http://aws.amazon.com/documentation/sdkforruby/)
Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:
  • [AWS Java Developer Center](http://aws.amazon.com/java/)
  • [AWS PHP Developer Center](http://aws.amazon.com/php/)
  • [AWS Python Developer Center](http://aws.amazon.com/python/)
  • [AWS Ruby Developer Center](http://aws.amazon.com/ruby/)
  • [AWS Windows and .NET Developer Center](http://aws.amazon.com/net/)

Summary

Functions

cancel_export_task(client, input, options \\ [])

Cancels an export task if it is in PENDING or RUNNING state

create_export_task(client, input, options \\ [])

Creates an ExportTask which allows you to efficiently export data from a Log Group to your Amazon S3 bucket

create_log_group(client, input, options \\ [])

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

create_log_stream(client, input, options \\ [])

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

delete_destination(client, input, options \\ [])

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

delete_log_group(client, input, options \\ [])

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

delete_log_stream(client, input, options \\ [])

Deletes a log stream and permanently deletes all the archived log events associated with it

delete_metric_filter(client, input, options \\ [])

Deletes a metric filter associated with the specified log group

delete_retention_policy(client, input, options \\ [])

Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy

delete_subscription_filter(client, input, options \\ [])

Deletes a subscription filter associated with the specified log group

describe_destinations(client, input, options \\ [])

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

describe_export_tasks(client, input, options \\ [])

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

describe_log_groups(client, input, options \\ [])

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

describe_log_streams(client, input, options \\ [])

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

describe_metric_filters(client, input, options \\ [])

Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name

describe_subscription_filters(client, input, options \\ [])

Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name

filter_log_events(client, input, options \\ [])

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`

get_log_events(client, input, options \\ [])

Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp`

put_destination(client, input, options \\ [])

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
put_destination_policy(client, input, options \\ [])

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

put_log_events(client, input, options \\ [])

Uploads a batch of log events to the specified log stream

put_metric_filter(client, input, options \\ [])

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

put_retention_policy(client, input, options \\ [])

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

put_subscription_filter(client, input, options \\ [])

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:

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

test_metric_filter(client, input, options \\ [])

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

Functions

cancel_export_task(client, input, options \\ [])

Cancels an export task if it is in PENDING or RUNNING state.

create_export_task(client, input, options \\ [])

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.

create_log_group(client, input, options \\ [])

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

create_log_stream(client, input, options \\ [])

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.

delete_destination(client, input, options \\ [])

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.

delete_log_group(client, input, options \\ [])

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

delete_log_stream(client, input, options \\ [])

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

delete_metric_filter(client, input, options \\ [])

Deletes a metric filter associated with the specified log group.

delete_retention_policy(client, input, options \\ [])

Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.

delete_subscription_filter(client, input, options \\ [])

Deletes a subscription filter associated with the specified log group.

describe_destinations(client, input, options \\ [])

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.

describe_export_tasks(client, input, options \\ [])

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.

describe_log_groups(client, input, options \\ [])

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.

describe_log_streams(client, input, options \\ [])

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.

describe_metric_filters(client, input, options \\ [])

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.

describe_subscription_filters(client, input, options \\ [])

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.
filter_log_events(client, input, options \\ [])

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.

get_log_events(client, input, options \\ [])

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.

put_destination(client, input, options \\ [])

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.
put_destination_policy(client, input, options \\ [])

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.

put_log_events(client, input, options \\ [])

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.
put_metric_filter(client, input, options \\ [])

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.

put_retention_policy(client, input, options \\ [])

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.

put_subscription_filter(client, input, options \\ [])

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:

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

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

test_metric_filter(client, input, options \\ [])

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.