CloudWatchLogsClient Class

Member Function Documentation

CloudWatchLogsClient::CloudWatchLogsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a CloudWatchLogsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

CloudWatchLogsClient::CloudWatchLogsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads CloudWatchLogsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AssociateKmsKeyResponse *CloudWatchLogsClient::associateKmsKey(const AssociateKmsKeyRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an AssociateKmsKeyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>InvalidParameterException</code> error.

[slot] CancelExportTaskResponse *CloudWatchLogsClient::cancelExportTask(const CancelExportTaskRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an CancelExportTaskResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Cancels the specified export

task>

The task must be in the <code>PENDING</code> or <code>RUNNING</code>

[slot] CreateExportTaskResponse *CloudWatchLogsClient::createExportTask(const CreateExportTaskRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an CreateExportTaskResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>DescribeExportTasks</a> to get the status of the export task. Each account can only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time. To cancel an export task, use

<a>CancelExportTask</a>>

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

[slot] CreateLogGroupResponse *CloudWatchLogsClient::createLogGroup(const CreateLogGroupRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an CreateLogGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <ul> <li>

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

account> </li> <li>

Log group names can be between 1 and 512 characters

long> </li> <li>

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

(period)> </li> </ul>

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 <code>InvalidParameterException</code> error.

[slot] CreateLogStreamResponse *CloudWatchLogsClient::createLogStream(const CreateLogStreamRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an CreateLogStreamResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <ul> <li>

Log stream names must be unique within the log

group> </li> <li>

Log stream names can be between 1 and 512 characters

long> </li> <li>

The ':' (colon) and '*' (asterisk) characters are not

[slot] DeleteDestinationResponse *CloudWatchLogsClient::deleteDestination(const DeleteDestinationRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DeleteDestinationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteLogGroupResponse *CloudWatchLogsClient::deleteLogGroup(const DeleteLogGroupRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DeleteLogGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteLogStreamResponse *CloudWatchLogsClient::deleteLogStream(const DeleteLogStreamRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DeleteLogStreamResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteMetricFilterResponse *CloudWatchLogsClient::deleteMetricFilter(const DeleteMetricFilterRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DeleteMetricFilterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified metric

[slot] DeleteResourcePolicyResponse *CloudWatchLogsClient::deleteResourcePolicy(const DeleteResourcePolicyRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DeleteResourcePolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteRetentionPolicyResponse *CloudWatchLogsClient::deleteRetentionPolicy(const DeleteRetentionPolicyRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DeleteRetentionPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified retention

policy>

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

[slot] DeleteSubscriptionFilterResponse *CloudWatchLogsClient::deleteSubscriptionFilter(const DeleteSubscriptionFilterRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DeleteSubscriptionFilterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified subscription

[slot] DescribeDestinationsResponse *CloudWatchLogsClient::describeDestinations(const DescribeDestinationsRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DescribeDestinationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeExportTasksResponse *CloudWatchLogsClient::describeExportTasks(const DescribeExportTasksRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DescribeExportTasksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeLogGroupsResponse *CloudWatchLogsClient::describeLogGroups(const DescribeLogGroupsRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DescribeLogGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeLogStreamsResponse *CloudWatchLogsClient::describeLogStreams(const DescribeLogStreamsRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DescribeLogStreamsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeMetricFiltersResponse *CloudWatchLogsClient::describeMetricFilters(const DescribeMetricFiltersRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DescribeMetricFiltersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeResourcePoliciesResponse *CloudWatchLogsClient::describeResourcePolicies(const DescribeResourcePoliciesRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DescribeResourcePoliciesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the resource policies in this

[slot] DescribeSubscriptionFiltersResponse *CloudWatchLogsClient::describeSubscriptionFilters(const DescribeSubscriptionFiltersRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DescribeSubscriptionFiltersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DisassociateKmsKeyResponse *CloudWatchLogsClient::disassociateKmsKey(const DisassociateKmsKeyRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an DisassociateKmsKeyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] FilterLogEventsResponse *CloudWatchLogsClient::filterLogEvents(const FilterLogEventsRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an FilterLogEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetLogEventsResponse *CloudWatchLogsClient::getLogEvents(const GetLogEventsRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an GetLogEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListTagsLogGroupResponse *CloudWatchLogsClient::listTagsLogGroup(const ListTagsLogGroupRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an ListTagsLogGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the tags for the specified log

[slot] PutDestinationResponse *CloudWatchLogsClient::putDestination(const PutDestinationRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an PutDestinationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>PutLogEvents</a>. 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, <code>PutDestination</code> does not set any access policy with the destination, which means a cross-account user cannot call <a>PutSubscriptionFilter</a> against this destination. To enable this, the destination owner must call <a>PutDestinationPolicy</a> after

[slot] PutDestinationPolicyResponse *CloudWatchLogsClient::putDestinationPolicy(const PutDestinationPolicyRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an PutDestinationPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates or updates an access policy associated with an existing destination. An access policy is an <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used to authorize claims to register a subscription filter against a given

[slot] PutLogEventsResponse *CloudWatchLogsClient::putLogEvents(const PutLogEventsRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an PutLogEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>DescribeLogStreams</a>. If you call <code>PutLogEvents</code> twice within a narrow time period using the same value for <code>sequenceToken</code>, both calls may be successful, or one may be

rejected>

The batch of events must satisfy the following

constraints> <ul> <li>

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> </li> <li>

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

future> </li> <li>

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

group> </li> <li>

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)> </li> <li>

The maximum number of log events in a batch is

10,000> </li> <li>

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

[slot] PutMetricFilterResponse *CloudWatchLogsClient::putMetricFilter(const PutMetricFilterRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an PutMetricFilterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

<a>PutLogEvents</a>>

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

[slot] PutResourcePolicyResponse *CloudWatchLogsClient::putResourcePolicy(const PutResourcePolicyRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an PutResourcePolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] PutRetentionPolicyResponse *CloudWatchLogsClient::putRetentionPolicy(const PutRetentionPolicyRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an PutRetentionPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] PutSubscriptionFilterResponse *CloudWatchLogsClient::putSubscriptionFilter(const PutSubscriptionFilterRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an PutSubscriptionFilterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>PutLogEvents</a> and have them delivered to a specific destination. Currently, the supported destinations

are> <ul> <li>

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

delivery> </li> <li>

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

delivery> </li> <li>

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

delivery> </li> <li>

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

delivery> </li> </ul>

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 <code>filterName</code>. Otherwise, the call fails because you cannot associate a second filter with a log

[slot] TagLogGroupResponse *CloudWatchLogsClient::tagLogGroup(const TagLogGroupRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an TagLogGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds or updates the specified tags for the specified log

group>

To list the tags for a log group, use <a>ListTagsLogGroup</a>. To remove tags, use

<a>UntagLogGroup</a>>

For more information about tags, see <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/log-group-tagging.html">Tag Log Groups in Amazon CloudWatch Logs</a> in the <i>Amazon CloudWatch Logs User

[slot] TestMetricFilterResponse *CloudWatchLogsClient::testMetricFilter(const TestMetricFilterRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an TestMetricFilterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UntagLogGroupResponse *CloudWatchLogsClient::untagLogGroup(const UntagLogGroupRequest &request)

Sends request to the CloudWatchLogsClient service, and returns a pointer to an UntagLogGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes the specified tags from the specified log

group>

To list the tags for a log group, use <a>ListTagsLogGroup</a>. To add tags, use