Struct rusoto_logs::CloudWatchLogsClient

pub struct CloudWatchLogsClient { /* fields omitted */ }

A client for the Amazon CloudWatch Logs API.

Methods

impl CloudWatchLogsClient

pub fn new(region: Region) -> CloudWatchLogsClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> CloudWatchLogsClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    P::Future: Send,
    D: DispatchSignedRequest + Send + Sync + 'static,
    D::Future: Send, 

Trait Implementations

impl CloudWatchLogs for CloudWatchLogsClient

fn associate_kms_key(
    &self,
    input: AssociateKmsKeyRequest
) -> RusotoFuture<(), AssociateKmsKeyError>

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.

fn cancel_export_task(
    &self,
    input: CancelExportTaskRequest
) -> RusotoFuture<(), CancelExportTaskError>

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

fn create_export_task(
    &self,
    input: CreateExportTaskRequest
) -> RusotoFuture<CreateExportTaskResponse, CreateExportTaskError>

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.

fn create_log_group(
    &self,
    input: CreateLogGroupRequest
) -> RusotoFuture<(), CreateLogGroupError>

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.

fn create_log_stream(
    &self,
    input: CreateLogStreamRequest
) -> RusotoFuture<(), CreateLogStreamError>

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.

fn delete_destination(
    &self,
    input: DeleteDestinationRequest
) -> RusotoFuture<(), DeleteDestinationError>

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.

fn delete_log_group(
    &self,
    input: DeleteLogGroupRequest
) -> RusotoFuture<(), DeleteLogGroupError>

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

fn delete_log_stream(
    &self,
    input: DeleteLogStreamRequest
) -> RusotoFuture<(), DeleteLogStreamError>

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

fn delete_metric_filter(
    &self,
    input: DeleteMetricFilterRequest
) -> RusotoFuture<(), DeleteMetricFilterError>

Deletes the specified metric filter.

fn delete_resource_policy(
    &self,
    input: DeleteResourcePolicyRequest
) -> RusotoFuture<(), DeleteResourcePolicyError>

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

fn delete_retention_policy(
    &self,
    input: DeleteRetentionPolicyRequest
) -> RusotoFuture<(), DeleteRetentionPolicyError>

Deletes the specified retention policy.

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

fn delete_subscription_filter(
    &self,
    input: DeleteSubscriptionFilterRequest
) -> RusotoFuture<(), DeleteSubscriptionFilterError>

Deletes the specified subscription filter.

fn describe_destinations(
    &self,
    input: DescribeDestinationsRequest
) -> RusotoFuture<DescribeDestinationsResponse, DescribeDestinationsError>

Lists all your destinations. The results are ASCII-sorted by destination name.

fn describe_export_tasks(
    &self,
    input: DescribeExportTasksRequest
) -> RusotoFuture<DescribeExportTasksResponse, DescribeExportTasksError>

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

fn describe_log_groups(
    &self,
    input: DescribeLogGroupsRequest
) -> RusotoFuture<DescribeLogGroupsResponse, DescribeLogGroupsError>

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.

fn describe_log_streams(
    &self,
    input: DescribeLogStreamsRequest
) -> RusotoFuture<DescribeLogStreamsResponse, DescribeLogStreamsError>

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.

fn describe_metric_filters(
    &self,
    input: DescribeMetricFiltersRequest
) -> RusotoFuture<DescribeMetricFiltersResponse, DescribeMetricFiltersError>

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.

fn describe_queries(
    &self,
    input: DescribeQueriesRequest
) -> RusotoFuture<DescribeQueriesResponse, DescribeQueriesError>

Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all queries, or limit it to queries of a specific log group or queries with a certain status.

fn describe_resource_policies(
    &self,
    input: DescribeResourcePoliciesRequest
) -> RusotoFuture<DescribeResourcePoliciesResponse, DescribeResourcePoliciesError>

Lists the resource policies in this account.

fn describe_subscription_filters(
    &self,
    input: DescribeSubscriptionFiltersRequest
) -> RusotoFuture<DescribeSubscriptionFiltersResponse, DescribeSubscriptionFiltersError>

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.

fn disassociate_kms_key(
    &self,
    input: DisassociateKmsKeyRequest
) -> RusotoFuture<(), DisassociateKmsKeyError>

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.

fn filter_log_events(
    &self,
    input: FilterLogEventsRequest
) -> RusotoFuture<FilterLogEventsResponse, FilterLogEventsError>

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.

fn get_log_events(
    &self,
    input: GetLogEventsRequest
) -> RusotoFuture<GetLogEventsResponse, GetLogEventsError>

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.

fn get_log_group_fields(
    &self,
    input: GetLogGroupFieldsRequest
) -> RusotoFuture<GetLogGroupFieldsResponse, GetLogGroupFieldsError>

Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify.

In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event.

The response results are sorted by the frequency percentage, starting with the highest percentage.

fn get_log_record(
    &self,
    input: GetLogRecordRequest
) -> RusotoFuture<GetLogRecordResponse, GetLogRecordError>

Retrieves all the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.

Additionally, the entire unparsed log event is returned within @message.

fn get_query_results(
    &self,
    input: GetQueryResultsRequest
) -> RusotoFuture<GetQueryResultsResponse, GetQueryResultsError>

Returns the results from the specified query. If the query is in progress, partial results of that current execution are returned.

Only the fields requested in the query are returned, along with a @ptr field which is the identifier for the log record. You can use the value of @ptr in a operation to get the full log record.

GetQueryResults does not start a query execution. To run a query, use .

fn list_tags_log_group(
    &self,
    input: ListTagsLogGroupRequest
) -> RusotoFuture<ListTagsLogGroupResponse, ListTagsLogGroupError>

Lists the tags for the specified log group.

fn put_destination(
    &self,
    input: PutDestinationRequest
) -> RusotoFuture<PutDestinationResponse, PutDestinationError>

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.

fn put_destination_policy(
    &self,
    input: PutDestinationPolicyRequest
) -> RusotoFuture<(), PutDestinationPolicyError>

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.

fn put_log_events(
    &self,
    input: PutLogEventsRequest
) -> RusotoFuture<PutLogEventsResponse, PutLogEventsError>

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 older than the retention period of the log group.

• The log events in the batch must be in chronological ordered by their timestamp. The timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

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

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.

fn put_metric_filter(
    &self,
    input: PutMetricFilterRequest
) -> RusotoFuture<(), PutMetricFilterError>

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.

fn put_resource_policy(
    &self,
    input: PutResourcePolicyRequest
) -> RusotoFuture<PutResourcePolicyResponse, PutResourcePolicyError>

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 10 resource policies per region.

fn put_retention_policy(
    &self,
    input: PutRetentionPolicyRequest
) -> RusotoFuture<(), PutRetentionPolicyError>

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.

fn put_subscription_filter(
    &self,
    input: PutSubscriptionFilterRequest
) -> RusotoFuture<(), PutSubscriptionFilterError>

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.

fn start_query(
    &self,
    input: StartQueryRequest
) -> RusotoFuture<StartQueryResponse, StartQueryError>

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query, and the query string to use.

For more information, see CloudWatch Logs Insights Query Syntax.

Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being searched, or partition your query into a number of queries.

fn stop_query(
    &self,
    input: StopQueryRequest
) -> RusotoFuture<StopQueryResponse, StopQueryError>

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.

fn tag_log_group(
    &self,
    input: TagLogGroupRequest
) -> RusotoFuture<(), TagLogGroupError>

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.

fn test_metric_filter(
    &self,
    input: TestMetricFilterRequest
) -> RusotoFuture<TestMetricFilterResponse, TestMetricFilterError>

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.

fn untag_log_group(
    &self,
    input: UntagLogGroupRequest
) -> RusotoFuture<(), UntagLogGroupError>

Removes the specified tags from the specified log group.

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

impl Clone for CloudWatchLogsClient

fn clone(&self) -> CloudWatchLogsClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.