AWS SDK for PHP 3.x

Client: Aws\CloudWatchLogs\CloudWatchLogsClient

Service ID: logs

Version: 2014-03-28

This page describes the parameters and results for the operations of the Amazon CloudWatch Logs (2014-03-28), and shows how to use the Aws\CloudWatchLogs\CloudWatchLogsClient object to call the described operations. This documentation is specific to the 2014-03-28 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateKmsKey ( array $params = [] )
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.
CancelExportTask ( array $params = [] )
Cancels the specified export task.
CreateExportTask ( array $params = [] )
Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
CreateLogGroup ( array $params = [] )
Creates a log group with the specified name.
CreateLogStream ( array $params = [] )
Creates a log stream for the specified log group.
DeleteDestination ( array $params = [] )
Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
DeleteLogGroup ( array $params = [] )
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
DeleteLogStream ( array $params = [] )
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
DeleteMetricFilter ( array $params = [] )
Deletes the specified metric filter.
DeleteResourcePolicy ( array $params = [] )
Deletes a resource policy from this account.
DeleteRetentionPolicy ( array $params = [] )
Deletes the specified retention policy.
DeleteSubscriptionFilter ( array $params = [] )
Deletes the specified subscription filter.
DescribeDestinations ( array $params = [] )
Lists all your destinations.
DescribeExportTasks ( array $params = [] )
Lists the specified export tasks.
DescribeLogGroups ( array $params = [] )
Lists the specified log groups.
DescribeLogStreams ( array $params = [] )
Lists the log streams for the specified log group.
DescribeMetricFilters ( array $params = [] )
Lists the specified metric filters.
DescribeQueries ( array $params = [] )
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account.
DescribeResourcePolicies ( array $params = [] )
Lists the resource policies in this account.
DescribeSubscriptionFilters ( array $params = [] )
Lists the subscription filters for the specified log group.
DisassociateKmsKey ( array $params = [] )
Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.
FilterLogEvents ( array $params = [] )
Lists log events from the specified log group.
GetLogEvents ( array $params = [] )
Lists log events from the specified log stream.
GetLogGroupFields ( array $params = [] )
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.
GetLogRecord ( array $params = [] )
Retrieves all the fields and values of a single log event.
GetQueryResults ( array $params = [] )
Returns the results from the specified query.
ListTagsLogGroup ( array $params = [] )
Lists the tags for the specified log group.
PutDestination ( array $params = [] )
Creates or updates a destination.
PutDestinationPolicy ( array $params = [] )
Creates or updates an access policy associated with an existing destination.
PutLogEvents ( array $params = [] )
Uploads a batch of log events to the specified log stream.
PutMetricFilter ( array $params = [] )
Creates or updates a metric filter and associates it with the specified log group.
PutResourcePolicy ( array $params = [] )
Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53.
PutRetentionPolicy ( array $params = [] )
Sets the retention of the specified log group.
PutSubscriptionFilter ( array $params = [] )
Creates or updates a subscription filter and associates it with the specified log group.
StartQuery ( array $params = [] )
Schedules a query of a log group using CloudWatch Logs Insights.
StopQuery ( array $params = [] )
Stops a CloudWatch Logs Insights query that is in progress.
TagLogGroup ( array $params = [] )
Adds or updates the specified tags for the specified log group.
TestMetricFilter ( array $params = [] )
Tests the filter pattern of a metric filter against a sample of log event messages.
UntagLogGroup ( array $params = [] )
Removes the specified tags from the specified log group.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeDestinations
DescribeLogGroups
DescribeLogStreams
DescribeMetricFilters
DescribeSubscriptionFilters
FilterLogEvents
GetLogEvents

Operations

AssociateKmsKey

$result = $client->associateKmsKey([/* ... */]);
$promise = $client->associateKmsKeyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateKmsKey([
    'kmsKeyId' => '<string>', // REQUIRED
    'logGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members

kmsKeyId

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).

logGroupName

Required: Yes
Type: string

The name of the log group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

CancelExportTask

$result = $client->cancelExportTask([/* ... */]);
$promise = $client->cancelExportTaskAsync([/* ... */]);

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

Parameter Syntax

$result = $client->cancelExportTask([
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Members

taskId

Required: Yes
Type: string

The ID of the export task.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
InvalidOperationException:
The operation is not valid on the specified resource.
ServiceUnavailableException:
The service cannot complete the request.

CreateExportTask

$result = $client->createExportTask([/* ... */]);
$promise = $client->createExportTaskAsync([/* ... */]);

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.

Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets encrypted with SSE-KMS is not supported.

Parameter Syntax

$result = $client->createExportTask([
    'destination' => '<string>', // REQUIRED
    'destinationPrefix' => '<string>',
    'from' => <integer>, // REQUIRED
    'logGroupName' => '<string>', // REQUIRED
    'logStreamNamePrefix' => '<string>',
    'taskName' => '<string>',
    'to' => <integer>, // REQUIRED
]);

Parameter Details

Members

destination

Required: Yes
Type: string

The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.

destinationPrefix

Type: string

The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.

from

Required: Yes
Type: long (int|float)

The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported.

logGroupName

Required: Yes
Type: string

The name of the log group.

logStreamNamePrefix

Type: string

Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.

taskName

Type: string

The name of the export task.

to

Required: Yes
Type: long (int|float)

The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

Result Syntax

[
    'taskId' => '<string>',
]

Result Details

Members

taskId

Type: string

The ID of the export task.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
LimitExceededException:
You have reached the maximum number of resources that can be created.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.
ResourceNotFoundException:
The specified resource does not exist.
ResourceAlreadyExistsException:
The specified resource already exists.

CreateLogGroup

$result = $client->createLogGroup([/* ... */]);
$promise = $client->createLogGroupAsync([/* ... */]);

Creates a log group with the specified name.

You can create up to 20,000 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), '.' (period), and '#' (number sign)

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.

Parameter Syntax

$result = $client->createLogGroup([
    'kmsKeyId' => '<string>',
    'logGroupName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

kmsKeyId

Type: string

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).

logGroupName

Required: Yes
Type: string

The name of the log group.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The key-value pairs to use for the tags.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceAlreadyExistsException:
The specified resource already exists.
LimitExceededException:
You have reached the maximum number of resources that can be created.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

CreateLogStream

$result = $client->createLogStream([/* ... */]);
$promise = $client->createLogStreamAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createLogStream([
    'logGroupName' => '<string>', // REQUIRED
    'logStreamName' => '<string>', // REQUIRED
]);

Parameter Details

Members

logGroupName

Required: Yes
Type: string

The name of the log group.

logStreamName

Required: Yes
Type: string

The name of the log stream.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceAlreadyExistsException:
The specified resource already exists.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

DeleteDestination

$result = $client->deleteDestination([/* ... */]);
$promise = $client->deleteDestinationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteDestination([
    'destinationName' => '<string>', // REQUIRED
]);

Parameter Details

Members

destinationName

Required: Yes
Type: string

The name of the destination.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

DeleteLogGroup

$result = $client->deleteLogGroup([/* ... */]);
$promise = $client->deleteLogGroupAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteLogGroup([
    'logGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members

logGroupName

Required: Yes
Type: string

The name of the log group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

DeleteLogStream

$result = $client->deleteLogStream([/* ... */]);
$promise = $client->deleteLogStreamAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteLogStream([
    'logGroupName' => '<string>', // REQUIRED
    'logStreamName' => '<string>', // REQUIRED
]);

Parameter Details

Members

logGroupName

Required: Yes
Type: string

The name of the log group.

logStreamName

Required: Yes
Type: string

The name of the log stream.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

DeleteMetricFilter

$result = $client->deleteMetricFilter([/* ... */]);
$promise = $client->deleteMetricFilterAsync([/* ... */]);

Deletes the specified metric filter.

Parameter Syntax

$result = $client->deleteMetricFilter([
    'filterName' => '<string>', // REQUIRED
    'logGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members

filterName

Required: Yes
Type: string

The name of the metric filter.

logGroupName

Required: Yes
Type: string

The name of the log group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'policyName' => '<string>',
]);

Parameter Details

Members

policyName

Type: string

The name of the policy to be revoked. This parameter is required.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

DeleteRetentionPolicy

$result = $client->deleteRetentionPolicy([/* ... */]);
$promise = $client->deleteRetentionPolicyAsync([/* ... */]);

Deletes the specified retention policy.

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

Parameter Syntax

$result = $client->deleteRetentionPolicy([
    'logGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members

logGroupName

Required: Yes
Type: string

The name of the log group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

DeleteSubscriptionFilter

$result = $client->deleteSubscriptionFilter([/* ... */]);
$promise = $client->deleteSubscriptionFilterAsync([/* ... */]);

Deletes the specified subscription filter.

Parameter Syntax

$result = $client->deleteSubscriptionFilter([
    'filterName' => '<string>', // REQUIRED
    'logGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members

filterName

Required: Yes
Type: string

The name of the subscription filter.

logGroupName

Required: Yes
Type: string

The name of the log group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

DescribeDestinations

$result = $client->describeDestinations([/* ... */]);
$promise = $client->describeDestinationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDestinations([
    'DestinationNamePrefix' => '<string>',
    'limit' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

DestinationNamePrefix

Type: string

The prefix to match. If you don't specify a value, no prefix filter is applied.

limit

Type: int

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

nextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'destinations' => [
        [
            'accessPolicy' => '<string>',
            'arn' => '<string>',
            'creationTime' => <integer>,
            'destinationName' => '<string>',
            'roleArn' => '<string>',
            'targetArn' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

destinations

Type: Array of Destination structures

The destinations.

nextToken

Type: string

The token for the next set of items to return. The token expires after 24 hours.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ServiceUnavailableException:
The service cannot complete the request.

DescribeExportTasks

$result = $client->describeExportTasks([/* ... */]);
$promise = $client->describeExportTasksAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeExportTasks([
    'limit' => <integer>,
    'nextToken' => '<string>',
    'statusCode' => 'CANCELLED|COMPLETED|FAILED|PENDING|PENDING_CANCEL|RUNNING',
    'taskId' => '<string>',
]);

Parameter Details

Members

limit

Type: int

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

nextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

statusCode

Type: string

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

taskId

Type: string

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

Result Syntax

[
    'exportTasks' => [
        [
            'destination' => '<string>',
            'destinationPrefix' => '<string>',
            'executionInfo' => [
                'completionTime' => <integer>,
                'creationTime' => <integer>,
            ],
            'from' => <integer>,
            'logGroupName' => '<string>',
            'status' => [
                'code' => 'CANCELLED|COMPLETED|FAILED|PENDING|PENDING_CANCEL|RUNNING',
                'message' => '<string>',
            ],
            'taskId' => '<string>',
            'taskName' => '<string>',
            'to' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

exportTasks

Type: Array of ExportTask structures

The export tasks.

nextToken

Type: string

The token for the next set of items to return. The token expires after 24 hours.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ServiceUnavailableException:
The service cannot complete the request.

DescribeLogGroups

$result = $client->describeLogGroups([/* ... */]);
$promise = $client->describeLogGroupsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeLogGroups([
    'limit' => <integer>,
    'logGroupNamePrefix' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Members

limit

Type: int

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

logGroupNamePrefix

Type: string

The prefix to match.

nextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'logGroups' => [
        [
            'arn' => '<string>',
            'creationTime' => <integer>,
            'kmsKeyId' => '<string>',
            'logGroupName' => '<string>',
            'metricFilterCount' => <integer>,
            'retentionInDays' => <integer>,
            'storedBytes' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

logGroups

Type: Array of LogGroup structures

The log groups.

nextToken

Type: string

The token for the next set of items to return. The token expires after 24 hours.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ServiceUnavailableException:
The service cannot complete the request.

DescribeLogStreams

$result = $client->describeLogStreams([/* ... */]);
$promise = $client->describeLogStreamsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeLogStreams([
    'descending' => true || false,
    'limit' => <integer>,
    'logGroupName' => '<string>', // REQUIRED
    'logStreamNamePrefix' => '<string>',
    'nextToken' => '<string>',
    'orderBy' => 'LogStreamName|LastEventTime',
]);

Parameter Details

Members

descending

Type: boolean

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

limit

Type: int

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

logGroupName

Required: Yes
Type: string

The name of the log group.

logStreamNamePrefix

Type: string

The prefix to match.

If orderBy is LastEventTime,you cannot specify this parameter.

nextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

orderBy

Type: string

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

Result Syntax

[
    'logStreams' => [
        [
            'arn' => '<string>',
            'creationTime' => <integer>,
            'firstEventTimestamp' => <integer>,
            'lastEventTimestamp' => <integer>,
            'lastIngestionTime' => <integer>,
            'logStreamName' => '<string>',
            'storedBytes' => <integer>,
            'uploadSequenceToken' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

logStreams

Type: Array of LogStream structures

The log streams.

nextToken

Type: string

The token for the next set of items to return. The token expires after 24 hours.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

DescribeMetricFilters

$result = $client->describeMetricFilters([/* ... */]);
$promise = $client->describeMetricFiltersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeMetricFilters([
    'filterNamePrefix' => '<string>',
    'limit' => <integer>,
    'logGroupName' => '<string>',
    'metricName' => '<string>',
    'metricNamespace' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Members

filterNamePrefix

Type: string

The prefix to match.

limit

Type: int

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

logGroupName

Type: string

The name of the log group.

metricName

Type: string

Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the metricNamespace parameter.

metricNamespace

Type: string

Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the metricName parameter.

nextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'metricFilters' => [
        [
            'creationTime' => <integer>,
            'filterName' => '<string>',
            'filterPattern' => '<string>',
            'logGroupName' => '<string>',
            'metricTransformations' => [
                [
                    'defaultValue' => <float>,
                    'metricName' => '<string>',
                    'metricNamespace' => '<string>',
                    'metricValue' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

metricFilters

Type: Array of MetricFilter structures

The metric filters.

nextToken

Type: string

The token for the next set of items to return. The token expires after 24 hours.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

DescribeQueries

$result = $client->describeQueries([/* ... */]);
$promise = $client->describeQueriesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeQueries([
    'logGroupName' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'Scheduled|Running|Complete|Failed|Cancelled',
]);

Parameter Details

Members

logGroupName

Type: string

Limits the returned queries to only those for the specified log group.

maxResults

Type: int

Limits the number of returned queries to the specified number.

nextToken

Type: string

The token for the next set of items to return. The token expires after 24 hours.

status

Type: string

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

Result Syntax

[
    'nextToken' => '<string>',
    'queries' => [
        [
            'createTime' => <integer>,
            'logGroupName' => '<string>',
            'queryId' => '<string>',
            'queryString' => '<string>',
            'status' => 'Scheduled|Running|Complete|Failed|Cancelled',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

The token for the next set of items to return. The token expires after 24 hours.

queries

Type: Array of QueryInfo structures

The list of queries that match the request.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

DescribeResourcePolicies

$result = $client->describeResourcePolicies([/* ... */]);
$promise = $client->describeResourcePoliciesAsync([/* ... */]);

Lists the resource policies in this account.

Parameter Syntax

$result = $client->describeResourcePolicies([
    'limit' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

limit

Type: int

The maximum number of resource policies to be displayed with one call of this API.

nextToken

Type: string

The token for the next set of items to return. The token expires after 24 hours.

Result Syntax

[
    'nextToken' => '<string>',
    'resourcePolicies' => [
        [
            'lastUpdatedTime' => <integer>,
            'policyDocument' => '<string>',
            'policyName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

The token for the next set of items to return. The token expires after 24 hours.

resourcePolicies

Type: Array of ResourcePolicy structures

The resource policies that exist in this account.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ServiceUnavailableException:
The service cannot complete the request.

DescribeSubscriptionFilters

$result = $client->describeSubscriptionFilters([/* ... */]);
$promise = $client->describeSubscriptionFiltersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeSubscriptionFilters([
    'filterNamePrefix' => '<string>',
    'limit' => <integer>,
    'logGroupName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Members

filterNamePrefix

Type: string

The prefix to match. If you don't specify a value, no prefix filter is applied.

limit

Type: int

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

logGroupName

Required: Yes
Type: string

The name of the log group.

nextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'nextToken' => '<string>',
    'subscriptionFilters' => [
        [
            'creationTime' => <integer>,
            'destinationArn' => '<string>',
            'distribution' => 'Random|ByLogStream',
            'filterName' => '<string>',
            'filterPattern' => '<string>',
            'logGroupName' => '<string>',
            'roleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

The token for the next set of items to return. The token expires after 24 hours.

subscriptionFilters

Type: Array of SubscriptionFilter structures

The subscription filters.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

DisassociateKmsKey

$result = $client->disassociateKmsKey([/* ... */]);
$promise = $client->disassociateKmsKeyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disassociateKmsKey([
    'logGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members

logGroupName

Required: Yes
Type: string

The name of the log group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

FilterLogEvents

$result = $client->filterLogEvents([/* ... */]);
$promise = $client->filterLogEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->filterLogEvents([
    'endTime' => <integer>,
    'filterPattern' => '<string>',
    'interleaved' => true || false,
    'limit' => <integer>,
    'logGroupName' => '<string>', // REQUIRED
    'logStreamNamePrefix' => '<string>',
    'logStreamNames' => ['<string>', ...],
    'nextToken' => '<string>',
    'startTime' => <integer>,
]);

Parameter Details

Members

endTime

Type: long (int|float)

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

filterPattern

Type: string

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

interleaved

Type: boolean

If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

IMPORTANT: Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group.

limit

Type: int

The maximum number of events to return. The default is 10,000 events.

logGroupName

Required: Yes
Type: string

The name of the log group to search.

logStreamNamePrefix

Type: string

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

logStreamNames

Type: Array of strings

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

nextToken

Type: string

The token for the next set of events to return. (You received this token from a previous call.)

startTime

Type: long (int|float)

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

Result Syntax

[
    'events' => [
        [
            'eventId' => '<string>',
            'ingestionTime' => <integer>,
            'logStreamName' => '<string>',
            'message' => '<string>',
            'timestamp' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'searchedLogStreams' => [
        [
            'logStreamName' => '<string>',
            'searchedCompletely' => true || false,
        ],
        // ...
    ],
]

Result Details

Members

events

Type: Array of FilteredLogEvent structures

The matched events.

nextToken

Type: string

The token to use when requesting the next set of items. The token expires after 24 hours.

searchedLogStreams

Type: Array of SearchedLogStream structures

Indicates which log streams have been searched and whether each has been searched completely.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

GetLogEvents

$result = $client->getLogEvents([/* ... */]);
$promise = $client->getLogEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getLogEvents([
    'endTime' => <integer>,
    'limit' => <integer>,
    'logGroupName' => '<string>', // REQUIRED
    'logStreamName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'startFromHead' => true || false,
    'startTime' => <integer>,
]);

Parameter Details

Members

endTime

Type: long (int|float)

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.

limit

Type: int

The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.

logGroupName

Required: Yes
Type: string

The name of the log group.

logStreamName

Required: Yes
Type: string

The name of the log stream.

nextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Using this token works only when you specify true for startFromHead.

startFromHead

Type: boolean

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

If you are using nextToken in this operation, you must specify true for startFromHead.

startTime

Type: long (int|float)

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

Result Syntax

[
    'events' => [
        [
            'ingestionTime' => <integer>,
            'message' => '<string>',
            'timestamp' => <integer>,
        ],
        // ...
    ],
    'nextBackwardToken' => '<string>',
    'nextForwardToken' => '<string>',
]

Result Details

Members

events

Type: Array of OutputLogEvent structures

The events.

nextBackwardToken

Type: string

The token for the next set of items in the backward direction. The token expires after 24 hours. This token will never be null. If you have reached the end of the stream, it will return the same token you passed in.

nextForwardToken

Type: string

The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it will return the same token you passed in.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

GetLogGroupFields

$result = $client->getLogGroupFields([/* ... */]);
$promise = $client->getLogGroupFieldsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getLogGroupFields([
    'logGroupName' => '<string>', // REQUIRED
    'time' => <integer>,
]);

Parameter Details

Members

logGroupName

Required: Yes
Type: string

The name of the log group to search.

time

Type: long (int|float)

The time to set as the center of the query. If you specify time, the 8 minutes before and 8 minutes after this time are searched. If you omit time, the past 15 minutes are queried.

The time value is specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Result Syntax

[
    'logGroupFields' => [
        [
            'name' => '<string>',
            'percent' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members

logGroupFields

Type: Array of LogGroupField structures

The array of fields found in the query. Each object in the array contains the name of the field, along with the percentage of time it appeared in the log events that were queried.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
LimitExceededException:
You have reached the maximum number of resources that can be created.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

GetLogRecord

$result = $client->getLogRecord([/* ... */]);
$promise = $client->getLogRecordAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getLogRecord([
    'logRecordPointer' => '<string>', // REQUIRED
]);

Parameter Details

Members

logRecordPointer

Required: Yes
Type: string

The pointer corresponding to the log event record you want to retrieve. You get this from the response of a GetQueryResults operation. In that response, the value of the @ptr field for a log event is the value to use as logRecordPointer to retrieve that complete log event record.

Result Syntax

[
    'logRecord' => ['<string>', ...],
]

Result Details

Members

logRecord

Type: Associative array of custom strings keys (Field) to strings

The requested log event, as a JSON string.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
LimitExceededException:
You have reached the maximum number of resources that can be created.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

GetQueryResults

$result = $client->getQueryResults([/* ... */]);
$promise = $client->getQueryResultsAsync([/* ... */]);

Returns the results from the specified query.

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 .

If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.

Parameter Syntax

$result = $client->getQueryResults([
    'queryId' => '<string>', // REQUIRED
]);

Parameter Details

Members

queryId

Required: Yes
Type: string

The ID number of the query.

Result Syntax

[
    'results' => [
        [
            [
                'field' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'statistics' => [
        'bytesScanned' => <float>,
        'recordsMatched' => <float>,
        'recordsScanned' => <float>,
    ],
    'status' => 'Scheduled|Running|Complete|Failed|Cancelled',
]

Result Details

Members

results

Type: Array of ResultField structuress

The log events that matched the query criteria during the most recent time it ran.

The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

statistics

Type: QueryStatistics structure

Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned.

status

Type: string

The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

Queries time out after 15 minutes of execution. To avoid having your queries time out, reduce the time range being searched, or partition your query into a number of queries.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

ListTagsLogGroup

$result = $client->listTagsLogGroup([/* ... */]);
$promise = $client->listTagsLogGroupAsync([/* ... */]);

Lists the tags for the specified log group.

Parameter Syntax

$result = $client->listTagsLogGroup([
    'logGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members

logGroupName

Required: Yes
Type: string

The name of the log group.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags for the log group.

Errors

ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

PutDestination

$result = $client->putDestination([/* ... */]);
$promise = $client->putDestinationAsync([/* ... */]);

Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

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.

Through an access policy, a destination controls what is written to it. 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.

Parameter Syntax

$result = $client->putDestination([
    'destinationName' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'targetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

destinationName

Required: Yes
Type: string

A name for the destination.

roleArn

Required: Yes
Type: string

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

targetArn

Required: Yes
Type: string

The ARN of an Amazon Kinesis stream to which to deliver matching log events.

Result Syntax

[
    'destination' => [
        'accessPolicy' => '<string>',
        'arn' => '<string>',
        'creationTime' => <integer>,
        'destinationName' => '<string>',
        'roleArn' => '<string>',
        'targetArn' => '<string>',
    ],
]

Result Details

Members

destination

Type: Destination structure

The destination.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

PutDestinationPolicy

$result = $client->putDestinationPolicy([/* ... */]);
$promise = $client->putDestinationPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putDestinationPolicy([
    'accessPolicy' => '<string>', // REQUIRED
    'destinationName' => '<string>', // REQUIRED
]);

Parameter Details

Members

accessPolicy

Required: Yes
Type: string

An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination.

destinationName

Required: Yes
Type: string

A name for an existing destination.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

PutLogEvents

$result = $client->putLogEvents([/* ... */]);
$promise = $client->putLogEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putLogEvents([
    'logEvents' => [ // REQUIRED
        [
            'message' => '<string>', // REQUIRED
            'timestamp' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'logGroupName' => '<string>', // REQUIRED
    'logStreamName' => '<string>', // REQUIRED
    'sequenceToken' => '<string>',
]);

Parameter Details

Members

logEvents

Required: Yes
Type: Array of InputLogEvent structures

The log events.

logGroupName

Required: Yes
Type: string

The name of the log group.

logStreamName

Required: Yes
Type: string

The name of the log stream.

sequenceToken

Type: string

The sequence token obtained from the response of the previous PutLogEvents 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.

Result Syntax

[
    'nextSequenceToken' => '<string>',
    'rejectedLogEventsInfo' => [
        'expiredLogEventEndIndex' => <integer>,
        'tooNewLogEventStartIndex' => <integer>,
        'tooOldLogEventEndIndex' => <integer>,
    ],
]

Result Details

Members

nextSequenceToken

Type: string

The next sequence token.

rejectedLogEventsInfo

Type: RejectedLogEventsInfo structure

The rejected events.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
InvalidSequenceTokenException:
The sequence token is not valid.
DataAlreadyAcceptedException:
The event was already logged.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.
UnrecognizedClientException:
The most likely cause is an invalid AWS access key ID or secret key.

PutMetricFilter

$result = $client->putMetricFilter([/* ... */]);
$promise = $client->putMetricFilterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putMetricFilter([
    'filterName' => '<string>', // REQUIRED
    'filterPattern' => '<string>', // REQUIRED
    'logGroupName' => '<string>', // REQUIRED
    'metricTransformations' => [ // REQUIRED
        [
            'defaultValue' => <float>,
            'metricName' => '<string>', // REQUIRED
            'metricNamespace' => '<string>', // REQUIRED
            'metricValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

filterName

Required: Yes
Type: string

A name for the metric filter.

filterPattern

Required: Yes
Type: string

A filter pattern for extracting metric data out of ingested log events.

logGroupName

Required: Yes
Type: string

The name of the log group.

metricTransformations

Required: Yes
Type: Array of MetricTransformation structures

A collection of information that defines how metric data gets emitted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
LimitExceededException:
You have reached the maximum number of resources that can be created.
ServiceUnavailableException:
The service cannot complete the request.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putResourcePolicy([
    'policyDocument' => '<string>',
    'policyName' => '<string>',
]);

Parameter Details

Members

policyDocument

Type: string

Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.

The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action":"logs:PutLogEvents", "Resource": "logArn" } ] }

policyName

Type: string

Name of the new policy. This parameter is required.

Result Syntax

[
    'resourcePolicy' => [
        'lastUpdatedTime' => <integer>,
        'policyDocument' => '<string>',
        'policyName' => '<string>',
    ],
]

Result Details

Members

resourcePolicy

Type: ResourcePolicy structure

The new policy.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
LimitExceededException:
You have reached the maximum number of resources that can be created.
ServiceUnavailableException:
The service cannot complete the request.

PutRetentionPolicy

$result = $client->putRetentionPolicy([/* ... */]);
$promise = $client->putRetentionPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putRetentionPolicy([
    'logGroupName' => '<string>', // REQUIRED
    'retentionInDays' => <integer>, // REQUIRED
]);

Parameter Details

Members

logGroupName

Required: Yes
Type: string

The name of the log group.

retentionInDays

Required: Yes
Type: int

The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
ServiceUnavailableException:
The service cannot complete the request.

PutSubscriptionFilter

$result = $client->putSubscriptionFilter([/* ... */]);
$promise = $client->putSubscriptionFilterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putSubscriptionFilter([
    'destinationArn' => '<string>', // REQUIRED
    'distribution' => 'Random|ByLogStream',
    'filterName' => '<string>', // REQUIRED
    'filterPattern' => '<string>', // REQUIRED
    'logGroupName' => '<string>', // REQUIRED
    'roleArn' => '<string>',
]);

Parameter Details

Members

destinationArn

Required: Yes
Type: string

The ARN of the destination to deliver matching log events to. 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 (specified using an ARN) belonging to a different account, for cross-account delivery.
An Amazon Kinesis Firehose delivery 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.

distribution

Type: string

The method used to distribute log data to the destination. By default log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream.

filterName

Required: Yes
Type: string

A name for the subscription filter. 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. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.

filterPattern

Required: Yes
Type: string

A filter pattern for subscribing to a filtered stream of log events.

logGroupName

Required: Yes
Type: string

The name of the log group.

roleArn

Type: string

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
OperationAbortedException:
Multiple requests to update the same resource were in conflict.
LimitExceededException:
You have reached the maximum number of resources that can be created.
ServiceUnavailableException:
The service cannot complete the request.

StartQuery

$result = $client->startQuery([/* ... */]);
$promise = $client->startQueryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startQuery([
    'endTime' => <integer>, // REQUIRED
    'limit' => <integer>,
    'logGroupName' => '<string>',
    'logGroupNames' => ['<string>', ...],
    'queryString' => '<string>', // REQUIRED
    'startTime' => <integer>, // REQUIRED
]);

Parameter Details

Members

endTime

Required: Yes
Type: long (int|float)

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

limit

Type: int

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

logGroupName

Type: string

The log group on which to perform the query.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

logGroupNames

Type: Array of strings

The list of log groups to be queried. You can include up to 20 log groups.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

queryString

Required: Yes
Type: string

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

startTime

Required: Yes
Type: long (int|float)

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Result Syntax

[
    'queryId' => '<string>',
]

Result Details

Members

queryId

Type: string

The unique ID of the query.

Errors

MalformedQueryException:
The query string is not valid. Details about this error are displayed in a QueryCompileError object. For more information, see .

For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.
InvalidParameterException:
A parameter is specified incorrectly.
LimitExceededException:
You have reached the maximum number of resources that can be created.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

StopQuery

$result = $client->stopQuery([/* ... */]);
$promise = $client->stopQueryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->stopQuery([
    'queryId' => '<string>', // REQUIRED
]);

Parameter Details

Members

queryId

Required: Yes
Type: string

The ID number of the query to stop. If necessary, you can use DescribeQueries to find this ID number.

Result Syntax

[
    'success' => true || false,
]

Result Details

Members

success

Type: boolean

This is true if the query was stopped by the StopQuery operation.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ResourceNotFoundException:
The specified resource does not exist.
ServiceUnavailableException:
The service cannot complete the request.

TagLogGroup

$result = $client->tagLogGroup([/* ... */]);
$promise = $client->tagLogGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagLogGroup([
    'logGroupName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

logGroupName

Required: Yes
Type: string

The name of the log group.

tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The key-value pairs to use for the tags.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource does not exist.
InvalidParameterException:
A parameter is specified incorrectly.

TestMetricFilter

$result = $client->testMetricFilter([/* ... */]);
$promise = $client->testMetricFilterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->testMetricFilter([
    'filterPattern' => '<string>', // REQUIRED
    'logEventMessages' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

filterPattern

Required: Yes
Type: string

A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

logEventMessages

Required: Yes
Type: Array of strings

The log event messages to test.

Result Syntax

[
    'matches' => [
        [
            'eventMessage' => '<string>',
            'eventNumber' => <integer>,
            'extractedValues' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

matches

Type: Array of MetricFilterMatchRecord structures

The matched events.

Errors

InvalidParameterException:
A parameter is specified incorrectly.
ServiceUnavailableException:
The service cannot complete the request.

UntagLogGroup

$result = $client->untagLogGroup([/* ... */]);
$promise = $client->untagLogGroupAsync([/* ... */]);

Removes the specified tags from the specified log group.

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

Parameter Syntax

$result = $client->untagLogGroup([
    'logGroupName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

logGroupName

Required: Yes
Type: string

The name of the log group.

tags

Required: Yes
Type: Array of strings

The tag keys. The corresponding tags are removed from the log group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource does not exist.

Shapes

DataAlreadyAcceptedException

Description

The event was already logged.

Members

expectedSequenceToken

Type: string

Destination

Description

Represents a cross-account destination that receives subscription log events.

Members

accessPolicy

Type: string

An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

arn

Type: string

The ARN of this destination.

creationTime

Type: long (int|float)

The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

destinationName

Type: string

The name of the destination.

roleArn

Type: string

A role for impersonation, used when delivering log events to the target.

targetArn

Type: string

The Amazon Resource Name (ARN) of the physical target to where the log events are delivered (for example, a Kinesis stream).

ExportTask

Description

Represents an export task.

Members

destination

Type: string

The name of Amazon S3 bucket to which the log data was exported.

destinationPrefix

Type: string

The prefix that was used as the start of Amazon S3 key for every object exported.

executionInfo

Type: ExportTaskExecutionInfo structure

Execution info about the export task.

from

Type: long (int|float)

The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not exported.

logGroupName

Type: string

The name of the log group from which logs data was exported.

status

Type: ExportTaskStatus structure

The status of the export task.

taskId

Type: string

The ID of the export task.

taskName

Type: string

The name of the export task.

to

Type: long (int|float)

The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

ExportTaskExecutionInfo

Description

Represents the status of an export task.

Members

completionTime

Type: long (int|float)

The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

creationTime

Type: long (int|float)

The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

ExportTaskStatus

Description

Represents the status of an export task.

Members

code

Type: string

The status code of the export task.

message

Type: string

The status message related to the status code.

FilteredLogEvent

Description

Represents a matched event.

Members

eventId

Type: string

The ID of the event.

ingestionTime

Type: long (int|float)

The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

logStreamName

Type: string

The name of the log stream to which this event belongs.

message

Type: string

The data contained in the log event.

timestamp

Type: long (int|float)

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

InputLogEvent

Description

Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.

Members

message

Required: Yes
Type: string

The raw event message.

timestamp

Required: Yes
Type: long (int|float)

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

InvalidOperationException

Description

The operation is not valid on the specified resource.

Members

InvalidParameterException

Description

A parameter is specified incorrectly.

Members

InvalidSequenceTokenException

Description

The sequence token is not valid.

Members

expectedSequenceToken

Type: string

LimitExceededException

Description

You have reached the maximum number of resources that can be created.

Members

LogGroup

Description

Represents a log group.

Members

arn

Type: string

The Amazon Resource Name (ARN) of the log group.

creationTime

Type: long (int|float)

The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

kmsKeyId

Type: string

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.

logGroupName

Type: string

The name of the log group.

metricFilterCount

Type: int

The number of metric filters.

retentionInDays

Type: int

The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

storedBytes

Type: long (int|float)

The number of bytes stored.

LogGroupField

Description

The fields contained in log events found by a GetLogGroupFields operation, along with the percentage of queried log events in which each field appears.

Members

name

Type: string

The name of a log field.

percent

Type: int

The percentage of log events queried that contained the field.

LogStream

Description

Represents a log stream, which is a sequence of log events from a single emitter of logs.

Members

arn

Type: string

The Amazon Resource Name (ARN) of the log stream.

creationTime

Type: long (int|float)

The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

firstEventTimestamp

Type: long (int|float)

The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

lastEventTimestamp

Type: long (int|float)

The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

lastIngestionTime

Type: long (int|float)

The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

logStreamName

Type: string

The name of the log stream.

storedBytes

Type: long (int|float)

The number of bytes stored.

IMPORTANT:On June 17, 2019, this parameter was deprecated for log streams, and is always reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.

uploadSequenceToken

Type: string

The sequence token.

MalformedQueryException

Description

The query string is not valid. Details about this error are displayed in a QueryCompileError object. For more information, see .

For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.

Members

queryCompileError

Type: QueryCompileError structure

Reserved.

MetricFilter

Description

Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.

Members

creationTime

Type: long (int|float)

The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

filterName

Type: string

The name of the metric filter.

filterPattern

Type: string

logGroupName

Type: string

The name of the log group.

metricTransformations

Type: Array of MetricTransformation structures

The metric transformations.

MetricFilterMatchRecord

Description

Represents a matched event.

Members

eventMessage

Type: string

The raw event data.

eventNumber

Type: long (int|float)

The event number.

extractedValues

Type: Associative array of custom strings keys (Token) to strings

The values extracted from the event data by the filter.

MetricTransformation

Description

Indicates how to transform ingested log events to metric data in a CloudWatch metric.

Members

defaultValue

Type: double

(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.

metricName

Required: Yes
Type: string

The name of the CloudWatch metric.

metricNamespace

Required: Yes
Type: string

The namespace of the CloudWatch metric.

metricValue

Required: Yes
Type: string

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

OperationAbortedException

Description

Multiple requests to update the same resource were in conflict.

Members

OutputLogEvent

Description

Represents a log event.

Members

ingestionTime

Type: long (int|float)

The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

message

Type: string

The data contained in the log event.

timestamp

Type: long (int|float)

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

QueryCompileError

Description

Reserved.

Members

location

Type: QueryCompileErrorLocation structure

Reserved.

message

Type: string

Reserved.

QueryCompileErrorLocation

Description

Reserved.

Members

endCharOffset

Type: int

Reserved.

startCharOffset

Type: int

Reserved.

QueryInfo

Description

Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.

Members

createTime

Type: long (int|float)

The date and time that this query was created.

logGroupName

Type: string

The name of the log group scanned by this query.

queryId

Type: string

The unique ID number of this query.

queryString

Type: string

The query string used in this query.

status

Type: string

The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.

QueryStatistics

Description

Contains the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned.

Members

bytesScanned

Type: double

The total number of bytes in the log events scanned during the query.

recordsMatched

Type: double

The number of log events that matched the query string.

recordsScanned

Type: double

The total number of log events scanned during the query.

RejectedLogEventsInfo

Description

Represents the rejected events.

Members

expiredLogEventEndIndex

Type: int

The expired log events.

tooNewLogEventStartIndex

Type: int

The log events that are too new.

tooOldLogEventEndIndex

Type: int

The log events that are too old.

ResourceAlreadyExistsException

Description

The specified resource already exists.

Members

ResourceNotFoundException

Description

The specified resource does not exist.

Members

ResourcePolicy

Description

A policy enabling one or more entities to put logs to a log group in this account.

Members

lastUpdatedTime

Type: long (int|float)

Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

policyDocument

Type: string

The details of the policy.

policyName

Type: string

The name of the resource policy.

ResultField

Description

Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.

Members

field

Type: string

The log event field.

value

Type: string

The value of this field.

SearchedLogStream

Description

Represents the search status of a log stream.

Members

logStreamName

Type: string

The name of the log stream.

searchedCompletely

Type: boolean

Indicates whether all the events in this log stream were searched.

ServiceUnavailableException

Description

The service cannot complete the request.

Members

SubscriptionFilter

Description

Represents a subscription filter.

Members

creationTime

Type: long (int|float)

The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

destinationArn

Type: string

The Amazon Resource Name (ARN) of the destination.

distribution

Type: string

The method used to distribute log data to the destination, which can be either random or grouped by log stream.

filterName

Type: string

The name of the subscription filter.

filterPattern

Type: string

logGroupName

Type: string

The name of the log group.

roleArn

Type: string

UnrecognizedClientException

Description

The most likely cause is an invalid AWS access key ID or secret key.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon CloudWatch Logs 2014-03-28

Operation Summary

Paginators

Operations

AssociateKmsKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CancelExportTask

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateExportTask

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLogGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateLogStream

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteDestination

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteLogGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteLogStream

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteMetricFilter

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteResourcePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details