AssociateKmsKey

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

Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.

When you use AssociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.

• Specify the logGroupName parameter to cause log events ingested into that log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.

  Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

  Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier parameter that specifies a query-result resource.

• Specify the resourceIdentifier parameter with a query-result resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.

  Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.

  If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.

It can take up to 5 minutes for this operation to take effect.

If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

OperationAbortedException:

Multiple concurrent 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

Result Syntax

[]

Result Details

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.

CreateDelivery

$result = $client->createDelivery([/* ... */]);
$promise = $client->createDeliveryAsync([/* ... */]);

Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.

Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.

A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.

To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:

• Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.

• Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.

• If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.

• Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination.

You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.

To update an existing delivery configuration, use UpdateDeliveryConfiguration.

Parameter Syntax

$result = $client->createDelivery([
    'deliveryDestinationArn' => '<string>', // REQUIRED
    'deliverySourceName' => '<string>', // REQUIRED
    'fieldDelimiter' => '<string>',
    'recordFields' => ['<string>', ...],
    's3DeliveryConfiguration' => [
        'enableHiveCompatiblePath' => true || false,
        'suffixPath' => '<string>',
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'delivery' => [
        'arn' => '<string>',
        'deliveryDestinationArn' => '<string>',
        'deliveryDestinationType' => 'S3|CWL|FH',
        'deliverySourceName' => '<string>',
        'fieldDelimiter' => '<string>',
        'id' => '<string>',
        'recordFields' => ['<string>', ...],
        's3DeliveryConfiguration' => [
            'enableHiveCompatiblePath' => true || false,
            'suffixPath' => '<string>',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ServiceUnavailableException:

The service cannot complete the request.

ConflictException:

This operation attempted to create a resource that already exists.

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

One of the parameters for the request is not valid.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

ServiceQuotaExceededException:

This request exceeds a service quota.

ThrottlingException:

The request was throttled because of quota limits.

CreateExportTask

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

Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.

Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.

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

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 log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

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

Result Syntax

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

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

LimitExceededException:

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

OperationAbortedException:

Multiple concurrent 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.

CreateLogAnomalyDetector

$result = $client->createLogAnomalyDetector([/* ... */]);
$promise = $client->createLogAnomalyDetectorAsync([/* ... */]);

Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.

An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns.

The anomaly detector uses pattern recognition to find anomalies, which are unusual log events. It uses the evaluationFrequency to compare current log events and patterns with trained baselines.

Fields within a pattern are called tokens. Fields that vary within a pattern, such as a request ID or timestamp, are referred to as dynamic tokens and represented by <*>.

The following is an example of a pattern:

[INFO] Request time: <*> ms

This pattern represents log events like [INFO] Request time: 327 ms and other similar log events that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced by <*>

Parameter Syntax

$result = $client->createLogAnomalyDetector([
    'anomalyVisibilityTime' => <integer>,
    'detectorName' => '<string>',
    'evaluationFrequency' => 'ONE_MIN|FIVE_MIN|TEN_MIN|FIFTEEN_MIN|THIRTY_MIN|ONE_HOUR',
    'filterPattern' => '<string>',
    'kmsKeyId' => '<string>',
    'logGroupArnList' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

LimitExceededException:

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

CreateLogGroup

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

Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.

You must use the following guidelines when naming a log group:

• Log group names must be unique within a Region for an Amazon Web Services 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)

• Log group names can't start with the string aws/

When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.

If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 concurrent 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. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.

There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.

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.

• Don't use ':' (colon) or '*' (asterisk) characters.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

DeleteAccountPolicy

$result = $client->deleteAccountPolicy([/* ... */]);
$promise = $client->deleteAccountPolicyAsync([/* ... */]);

Deletes a CloudWatch Logs account policy. This stops the account-wide policy from applying to log groups in the account. If you delete a data protection policy or subscription filter policy, any log-group level policies of those types remain in effect.

To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting.

• To delete a data protection policy, you must have the logs:DeleteDataProtectionPolicy and logs:DeleteAccountPolicy permissions.

• To delete a subscription filter policy, you must have the logs:DeleteSubscriptionFilter and logs:DeleteAccountPolicy permissions.

• To delete a transformer policy, you must have the logs:DeleteTransformer and logs:DeleteAccountPolicy permissions.

• To delete a field index policy, you must have the logs:DeleteIndexPolicy and logs:DeleteAccountPolicy permissions.

If you delete a field index policy, the indexing of the log events that happened before you deleted the policy will still be used for up to 30 days to improve CloudWatch Logs Insights queries.

Parameter Syntax

$result = $client->deleteAccountPolicy([
    'policyName' => '<string>', // REQUIRED
    'policyType' => 'DATA_PROTECTION_POLICY|SUBSCRIPTION_FILTER_POLICY|FIELD_INDEX_POLICY|TRANSFORMER_POLICY', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

DeleteDataProtectionPolicy

$result = $client->deleteDataProtectionPolicy([/* ... */]);
$promise = $client->deleteDataProtectionPolicyAsync([/* ... */]);

Deletes the data protection policy from the specified log group.

For more information about data protection policies, see PutDataProtectionPolicy.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

DeleteDelivery

$result = $client->deleteDelivery([/* ... */]);
$promise = $client->deleteDeliveryAsync([/* ... */]);

Deletes a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

ConflictException:

This operation attempted to create a resource that already exists.

ValidationException:

One of the parameters for the request is not valid.

ServiceQuotaExceededException:

This request exceeds a service quota.

ThrottlingException:

The request was throttled because of quota limits.

DeleteDeliveryDestination

$result = $client->deleteDeliveryDestination([/* ... */]);
$promise = $client->deleteDeliveryDestinationAsync([/* ... */]);

Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination.

You can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn field in the results.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

ConflictException:

This operation attempted to create a resource that already exists.

ValidationException:

One of the parameters for the request is not valid.

ServiceQuotaExceededException:

This request exceeds a service quota.

ThrottlingException:

The request was throttled because of quota limits.

DeleteDeliveryDestinationPolicy

$result = $client->deleteDeliveryDestinationPolicy([/* ... */]);
$promise = $client->deleteDeliveryDestinationPolicyAsync([/* ... */]);

Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceUnavailableException:

The service cannot complete the request.

ValidationException:

One of the parameters for the request is not valid.

ResourceNotFoundException:

The specified resource does not exist.

ConflictException:

This operation attempted to create a resource that already exists.

DeleteDeliverySource

$result = $client->deleteDeliverySource([/* ... */]);
$promise = $client->deleteDeliverySourceAsync([/* ... */]);

Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination.

You can't delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the deliverySourceName field in the results.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

ConflictException:

This operation attempted to create a resource that already exists.

ValidationException:

One of the parameters for the request is not valid.

ServiceQuotaExceededException:

This request exceeds a service quota.

ThrottlingException:

The request was throttled because of quota limits.

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

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ServiceUnavailableException:

The service cannot complete the request.

DeleteIndexPolicy

$result = $client->deleteIndexPolicy([/* ... */]);
$promise = $client->deleteIndexPolicyAsync([/* ... */]);

Deletes a log-group level field index policy that was applied to a single log group. The indexing of the log events that happened before you delete the policy will still be used for as many as 30 days to improve CloudWatch Logs Insights queries.

You can't use this operation to delete an account-level index policy. Instead, use DeletAccountPolicy.

If you delete a log-group level field index policy and there is an account-level field index policy, in a few minutes the log group begins using that account-wide policy to index new incoming log events.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

LimitExceededException:

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

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ServiceUnavailableException:

The service cannot complete the request.

DeleteIntegration

$result = $client->deleteIntegration([/* ... */]);
$promise = $client->deleteIntegrationAsync([/* ... */]);

Deletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active vended logs dashboards, you must specify true for the force parameter, otherwise the operation will fail. If you delete the integration by setting force to true, all your vended logs dashboards powered by OpenSearch Service will be deleted and the data that was on them will no longer be accessible.

Parameter Syntax

$result = $client->deleteIntegration([
    'force' => true || false,
    'integrationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

ValidationException:

One of the parameters for the request is not valid.

DeleteLogAnomalyDetector

$result = $client->deleteLogAnomalyDetector([/* ... */]);
$promise = $client->deleteLogAnomalyDetectorAsync([/* ... */]);

Deletes the specified CloudWatch Logs anomaly detector.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

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

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

OperationAbortedException:

Multiple concurrent 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

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

OperationAbortedException:

Multiple concurrent 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

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ServiceUnavailableException:

The service cannot complete the request.

DeleteQueryDefinition

$result = $client->deleteQueryDefinition([/* ... */]);
$promise = $client->deleteQueryDefinitionAsync([/* ... */]);

Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.

Each DeleteQueryDefinition operation can delete one query definition.

You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

OperationAbortedException:

Multiple concurrent 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

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ServiceUnavailableException:

The service cannot complete the request.

DeleteTransformer

$result = $client->deleteTransformer([/* ... */]);
$promise = $client->deleteTransformerAsync([/* ... */]);

Deletes the log transformer for the specified log group. As soon as you do this, the transformation of incoming log events according to that transformer stops. If this account has an account-level transformer that applies to this log group, the log group begins using that account-level transformer when this log-group level transformer is deleted.

After you delete a transformer, be sure to edit any metric filters or subscription filters that relied on the transformed versions of the log events.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

InvalidOperationException:

The operation is not valid on the specified resource.

DescribeAccountPolicies

$result = $client->describeAccountPolicies([/* ... */]);
$promise = $client->describeAccountPoliciesAsync([/* ... */]);

Returns a list of all CloudWatch Logs account policies in the account.

To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are retrieving information for.

• To see data protection policies, you must have the logs:GetDataProtectionPolicy and logs:DescribeAccountPolicies permissions.

• To see subscription filter policies, you must have the logs:DescribeSubscriptionFilters and logs:DescribeAccountPolicies permissions.

• To see transformer policies, you must have the logs:GetTransformer and logs:DescribeAccountPolicies permissions.

• To see field index policies, you must have the logs:DescribeIndexPolicies and logs:DescribeAccountPolicies permissions.

Parameter Syntax

$result = $client->describeAccountPolicies([
    'accountIdentifiers' => ['<string>', ...],
    'nextToken' => '<string>',
    'policyName' => '<string>',
    'policyType' => 'DATA_PROTECTION_POLICY|SUBSCRIPTION_FILTER_POLICY|FIELD_INDEX_POLICY|TRANSFORMER_POLICY', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accountPolicies' => [
        [
            'accountId' => '<string>',
            'lastUpdatedTime' => <integer>,
            'policyDocument' => '<string>',
            'policyName' => '<string>',
            'policyType' => 'DATA_PROTECTION_POLICY|SUBSCRIPTION_FILTER_POLICY|FIELD_INDEX_POLICY|TRANSFORMER_POLICY',
            'scope' => 'ALL',
            'selectionCriteria' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

DescribeConfigurationTemplates

$result = $client->describeConfigurationTemplates([/* ... */]);
$promise = $client->describeConfigurationTemplatesAsync([/* ... */]);

Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see CreateDelivery.

Parameter Syntax

$result = $client->describeConfigurationTemplates([
    'deliveryDestinationTypes' => ['<string>', ...],
    'limit' => <integer>,
    'logTypes' => ['<string>', ...],
    'nextToken' => '<string>',
    'resourceTypes' => ['<string>', ...],
    'service' => '<string>',
]);

Parameter Details

Result Syntax

[
    'configurationTemplates' => [
        [
            'allowedActionForAllowVendedLogsDeliveryForResource' => '<string>',
            'allowedFieldDelimiters' => ['<string>', ...],
            'allowedFields' => [
                [
                    'mandatory' => true || false,
                    'name' => '<string>',
                ],
                // ...
            ],
            'allowedOutputFormats' => ['<string>', ...],
            'allowedSuffixPathFields' => ['<string>', ...],
            'defaultDeliveryConfigValues' => [
                'fieldDelimiter' => '<string>',
                'recordFields' => ['<string>', ...],
                's3DeliveryConfiguration' => [
                    'enableHiveCompatiblePath' => true || false,
                    'suffixPath' => '<string>',
                ],
            ],
            'deliveryDestinationType' => 'S3|CWL|FH',
            'logType' => '<string>',
            'resourceType' => '<string>',
            'service' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ServiceUnavailableException:

The service cannot complete the request.

ValidationException:

One of the parameters for the request is not valid.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was throttled because of quota limits.

DescribeDeliveries

$result = $client->describeDeliveries([/* ... */]);
$promise = $client->describeDeliveriesAsync([/* ... */]);

Retrieves a list of the deliveries that have been created in the account.

A delivery is a connection between a delivery source and a delivery destination .

A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'deliveries' => [
        [
            'arn' => '<string>',
            'deliveryDestinationArn' => '<string>',
            'deliveryDestinationType' => 'S3|CWL|FH',
            'deliverySourceName' => '<string>',
            'fieldDelimiter' => '<string>',
            'id' => '<string>',
            'recordFields' => ['<string>', ...],
            's3DeliveryConfiguration' => [
                'enableHiveCompatiblePath' => true || false,
                'suffixPath' => '<string>',
            ],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ServiceUnavailableException:

The service cannot complete the request.

ServiceQuotaExceededException:

This request exceeds a service quota.

ValidationException:

One of the parameters for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

DescribeDeliveryDestinations

$result = $client->describeDeliveryDestinations([/* ... */]);
$promise = $client->describeDeliveryDestinationsAsync([/* ... */]);

Retrieves a list of the delivery destinations that have been created in the account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'deliveryDestinations' => [
        [
            'arn' => '<string>',
            'deliveryDestinationConfiguration' => [
                'destinationResourceArn' => '<string>',
            ],
            'deliveryDestinationType' => 'S3|CWL|FH',
            'name' => '<string>',
            'outputFormat' => 'json|plain|w3c|raw|parquet',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ServiceUnavailableException:

The service cannot complete the request.

ServiceQuotaExceededException:

This request exceeds a service quota.

ValidationException:

One of the parameters for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

DescribeDeliverySources

$result = $client->describeDeliverySources([/* ... */]);
$promise = $client->describeDeliverySourcesAsync([/* ... */]);

Retrieves a list of the delivery sources that have been created in the account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'deliverySources' => [
        [
            'arn' => '<string>',
            'logType' => '<string>',
            'name' => '<string>',
            'resourceArns' => ['<string>', ...],
            'service' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ServiceUnavailableException:

The service cannot complete the request.

ServiceQuotaExceededException:

This request exceeds a service quota.

ValidationException:

One of the parameters for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

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

Result Syntax

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

Result Details

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

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

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ServiceUnavailableException:

The service cannot complete the request.

DescribeFieldIndexes

$result = $client->describeFieldIndexes([/* ... */]);
$promise = $client->describeFieldIndexesAsync([/* ... */]);

Returns a list of field indexes listed in the field index policies of one or more log groups. For more information about field index policies, see PutIndexPolicy.

Parameter Syntax

$result = $client->describeFieldIndexes([
    'logGroupIdentifiers' => ['<string>', ...], // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'fieldIndexes' => [
        [
            'fieldIndexName' => '<string>',
            'firstEventTime' => <integer>,
            'lastEventTime' => <integer>,
            'lastScanTime' => <integer>,
            'logGroupIdentifier' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

LimitExceededException:

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

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ServiceUnavailableException:

The service cannot complete the request.

DescribeIndexPolicies

$result = $client->describeIndexPolicies([/* ... */]);
$promise = $client->describeIndexPoliciesAsync([/* ... */]);

Returns the field index policies of one or more log groups. For more information about field index policies, see PutIndexPolicy.

If a specified log group has a log-group level index policy, that policy is returned by this operation.

If a specified log group doesn't have a log-group level index policy, but an account-wide index policy applies to it, that account-wide policy is returned by this operation.

To find information about only account-level policies, use DescribeAccountPolicies instead.

Parameter Syntax

$result = $client->describeIndexPolicies([
    'logGroupIdentifiers' => ['<string>', ...], // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'indexPolicies' => [
        [
            'lastUpdateTime' => <integer>,
            'logGroupIdentifier' => '<string>',
            'policyDocument' => '<string>',
            'policyName' => '<string>',
            'source' => 'ACCOUNT|LOG_GROUP',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

LimitExceededException:

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

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ServiceUnavailableException:

The service cannot complete the request.

DescribeLogGroups

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

Returns information about log groups. You can return all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

CloudWatch Logs doesn't support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

Parameter Syntax

$result = $client->describeLogGroups([
    'accountIdentifiers' => ['<string>', ...],
    'includeLinkedAccounts' => true || false,
    'limit' => <integer>,
    'logGroupClass' => 'STANDARD|INFREQUENT_ACCESS|DELIVERY',
    'logGroupIdentifiers' => ['<string>', ...],
    'logGroupNamePattern' => '<string>',
    'logGroupNamePrefix' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'logGroups' => [
        [
            'arn' => '<string>',
            'creationTime' => <integer>,
            'dataProtectionStatus' => 'ACTIVATED|DELETED|ARCHIVED|DISABLED',
            'inheritedProperties' => ['<string>', ...],
            'kmsKeyId' => '<string>',
            'logGroupArn' => '<string>',
            'logGroupClass' => 'STANDARD|INFREQUENT_ACCESS|DELIVERY',
            'logGroupName' => '<string>',
            'metricFilterCount' => <integer>,
            'retentionInDays' => <integer>,
            'storedBytes' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

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.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

This operation has a limit of 25 transactions per second, after which transactions are throttled.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 of 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

Result Syntax

[
    'metricFilters' => [
        [
            'applyOnTransformedLogs' => true || false,
            'creationTime' => <integer>,
            'filterName' => '<string>',
            'filterPattern' => '<string>',
            'logGroupName' => '<string>',
            'metricTransformations' => [
                [
                    'defaultValue' => <float>,
                    'dimensions' => ['<string>', ...],
                    'metricName' => '<string>',
                    'metricNamespace' => '<string>',
                    'metricValue' => '<string>',
                    'unit' => 'Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

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, running, or have been run 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>',
    'queryLanguage' => 'CWLI|SQL|PPL',
    'status' => 'Scheduled|Running|Complete|Failed|Cancelled|Timeout|Unknown',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

DescribeQueryDefinitions

$result = $client->describeQueryDefinitions([/* ... */]);
$promise = $client->describeQueryDefinitionsAsync([/* ... */]);

This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can retrieve query definitions from the current account or from a source account that is linked to the current account.

You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string.

Parameter Syntax

$result = $client->describeQueryDefinitions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queryDefinitionNamePrefix' => '<string>',
    'queryLanguage' => 'CWLI|SQL|PPL',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'queryDefinitions' => [
        [
            'lastModified' => <integer>,
            'logGroupNames' => ['<string>', ...],
            'name' => '<string>',
            'queryDefinitionId' => '<string>',
            'queryLanguage' => 'CWLI|SQL|PPL',
            'queryString' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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 specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.

When you use DisassociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.

• Specify the logGroupName parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.

• Specify the resourceIdentifier parameter with the query-result resource to stop using the KMS key to encrypt the results of all future StartQuery operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.

It can take up to 5 minutes for this operation to take effect.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

OperationAbortedException:

Multiple concurrent 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 one or more of the following:

• A filter pattern

• A time range

• The log stream name, or a log stream name prefix that matches mutltiple log streams

You must have the logs:FilterLogEvents permission to perform this operation.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

FilterLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.

Partially full or empty pages don't necessarily mean that pagination is finished. If the results include a nextToken, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent FilterLogEvents operation. If the results don't include a nextToken, then pagination is finished.

Specifying the limit parameter only guarantees that a single page doesn't return more log events than the specified limit, but it might return fewer events than the limit. This is the expected API behavior.

The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

GetDataProtectionPolicy

$result = $client->getDataProtectionPolicy([/* ... */]);
$promise = $client->getDataProtectionPolicyAsync([/* ... */]);

Returns information about a log group data protection policy.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'lastUpdatedTime' => <integer>,
    'logGroupIdentifier' => '<string>',
    'policyDocument' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

GetDelivery

$result = $client->getDelivery([/* ... */]);
$promise = $client->getDeliveryAsync([/* ... */]);

Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination .

A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.

You need to specify the delivery id in this operation. You can find the IDs of the deliveries in your account with the DescribeDeliveries operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'delivery' => [
        'arn' => '<string>',
        'deliveryDestinationArn' => '<string>',
        'deliveryDestinationType' => 'S3|CWL|FH',
        'deliverySourceName' => '<string>',
        'fieldDelimiter' => '<string>',
        'id' => '<string>',
        'recordFields' => ['<string>', ...],
        's3DeliveryConfiguration' => [
            'enableHiveCompatiblePath' => true || false,
            'suffixPath' => '<string>',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

ValidationException:

One of the parameters for the request is not valid.

ServiceQuotaExceededException:

This request exceeds a service quota.

ThrottlingException:

The request was throttled because of quota limits.

GetDeliveryDestination

$result = $client->getDeliveryDestination([/* ... */]);
$promise = $client->getDeliveryDestinationAsync([/* ... */]);

Retrieves complete information about one delivery destination.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'deliveryDestination' => [
        'arn' => '<string>',
        'deliveryDestinationConfiguration' => [
            'destinationResourceArn' => '<string>',
        ],
        'deliveryDestinationType' => 'S3|CWL|FH',
        'name' => '<string>',
        'outputFormat' => 'json|plain|w3c|raw|parquet',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

ValidationException:

One of the parameters for the request is not valid.

ServiceQuotaExceededException:

This request exceeds a service quota.

ThrottlingException:

The request was throttled because of quota limits.

GetDeliveryDestinationPolicy

$result = $client->getDeliveryDestinationPolicy([/* ... */]);
$promise = $client->getDeliveryDestinationPolicyAsync([/* ... */]);

Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'policy' => [
        'deliveryDestinationPolicy' => '<string>',
    ],
]

Result Details

Errors

ServiceUnavailableException:

The service cannot complete the request.

ValidationException:

One of the parameters for the request is not valid.

ResourceNotFoundException:

The specified resource does not exist.

GetDeliverySource

$result = $client->getDeliverySource([/* ... */]);
$promise = $client->getDeliverySourceAsync([/* ... */]);

Retrieves complete information about one delivery source.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'deliverySource' => [
        'arn' => '<string>',
        'logType' => '<string>',
        'name' => '<string>',
        'resourceArns' => ['<string>', ...],
        'service' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

ValidationException:

One of the parameters for the request is not valid.

ServiceQuotaExceededException:

This request exceeds a service quota.

ThrottlingException:

The request was throttled because of quota limits.

GetIntegration

$result = $client->getIntegration([/* ... */]);
$promise = $client->getIntegrationAsync([/* ... */]);

Returns information about one integration between CloudWatch Logs and OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'integrationDetails' => [
        'openSearchIntegrationDetails' => [
            'accessPolicy' => [
                'policyName' => '<string>',
                'status' => [
                    'status' => 'ACTIVE|NOT_FOUND|ERROR',
                    'statusMessage' => '<string>',
                ],
            ],
            'application' => [
                'applicationArn' => '<string>',
                'applicationEndpoint' => '<string>',
                'applicationId' => '<string>',
                'status' => [
                    'status' => 'ACTIVE|NOT_FOUND|ERROR',
                    'statusMessage' => '<string>',
                ],
            ],
            'collection' => [
                'collectionArn' => '<string>',
                'collectionEndpoint' => '<string>',
                'status' => [
                    'status' => 'ACTIVE|NOT_FOUND|ERROR',
                    'statusMessage' => '<string>',
                ],
            ],
            'dataSource' => [
                'dataSourceName' => '<string>',
                'status' => [
                    'status' => 'ACTIVE|NOT_FOUND|ERROR',
                    'statusMessage' => '<string>',
                ],
            ],
            'encryptionPolicy' => [
                'policyName' => '<string>',
                'status' => [
                    'status' => 'ACTIVE|NOT_FOUND|ERROR',
                    'statusMessage' => '<string>',
                ],
            ],
            'lifecyclePolicy' => [
                'policyName' => '<string>',
                'status' => [
                    'status' => 'ACTIVE|NOT_FOUND|ERROR',
                    'statusMessage' => '<string>',
                ],
            ],
            'networkPolicy' => [
                'policyName' => '<string>',
                'status' => [
                    'status' => 'ACTIVE|NOT_FOUND|ERROR',
                    'statusMessage' => '<string>',
                ],
            ],
            'workspace' => [
                'status' => [
                    'status' => 'ACTIVE|NOT_FOUND|ERROR',
                    'statusMessage' => '<string>',
                ],
                'workspaceId' => '<string>',
            ],
        ],
    ],
    'integrationName' => '<string>',
    'integrationStatus' => 'PROVISIONING|ACTIVE|FAILED',
    'integrationType' => 'OPENSEARCH',
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ServiceUnavailableException:

The service cannot complete the request.

ResourceNotFoundException:

The specified resource does not exist.

GetLogAnomalyDetector

$result = $client->getLogAnomalyDetector([/* ... */]);
$promise = $client->getLogAnomalyDetectorAsync([/* ... */]);

Retrieves information about the log anomaly detector that you specify. The KMS key ARN detected is valid.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'anomalyDetectorStatus' => 'INITIALIZING|TRAINING|ANALYZING|FAILED|DELETED|PAUSED',
    'anomalyVisibilityTime' => <integer>,
    'creationTimeStamp' => <integer>,
    'detectorName' => '<string>',
    'evaluationFrequency' => 'ONE_MIN|FIVE_MIN|TEN_MIN|FIFTEEN_MIN|THIRTY_MIN|ONE_HOUR',
    'filterPattern' => '<string>',
    'kmsKeyId' => '<string>',
    'lastModifiedTimeStamp' => <integer>,
    'logGroupArnList' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

GetLogEvents

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

Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

GetLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.

Partially full or empty pages don't necessarily mean that pagination is finished. As long as the nextBackwardToken or nextForwardToken returned is NOT equal to the nextToken that you passed into the API call, there might be more log events available. The token that you use depends on the direction you want to move in along the log stream. The returned tokens are never null.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must specify one of these parameters, but you can't specify both.

In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.

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

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

The full unparsed log event is returned within @message.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 GetLogRecord operation to get the full log record.

GetQueryResults does not start running a query. To run a query, use StartQuery. For more information about how long results of previous queries are available, see CloudWatch Logs quotas.

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.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'encryptionKey' => '<string>',
    'queryLanguage' => 'CWLI|SQL|PPL',
    'results' => [
        [
            [
                'field' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'statistics' => [
        'bytesScanned' => <float>,
        'estimatedBytesSkipped' => <float>,
        'estimatedRecordsSkipped' => <float>,
        'logGroupsScanned' => <float>,
        'recordsMatched' => <float>,
        'recordsScanned' => <float>,
    ],
    'status' => 'Scheduled|Running|Complete|Failed|Cancelled|Timeout|Unknown',
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

GetTransformer

$result = $client->getTransformer([/* ... */]);
$promise = $client->getTransformerAsync([/* ... */]);

Returns the information about the log transformer associated with this log group.

This operation returns data only for transformers created at the log group level. To get information for an account-level transformer, use DescribeAccountPolicies.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'creationTime' => <integer>,
    'lastModifiedTime' => <integer>,
    'logGroupIdentifier' => '<string>',
    'transformerConfig' => [
        [
            'addKeys' => [
                'entries' => [
                    [
                        'key' => '<string>',
                        'overwriteIfExists' => true || false,
                        'value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'copyValue' => [
                'entries' => [
                    [
                        'overwriteIfExists' => true || false,
                        'source' => '<string>',
                        'target' => '<string>',
                    ],
                    // ...
                ],
            ],
            'csv' => [
                'columns' => ['<string>', ...],
                'delimiter' => '<string>',
                'quoteCharacter' => '<string>',
                'source' => '<string>',
            ],
            'dateTimeConverter' => [
                'locale' => '<string>',
                'matchPatterns' => ['<string>', ...],
                'source' => '<string>',
                'sourceTimezone' => '<string>',
                'target' => '<string>',
                'targetFormat' => '<string>',
                'targetTimezone' => '<string>',
            ],
            'deleteKeys' => [
                'withKeys' => ['<string>', ...],
            ],
            'grok' => [
                'match' => '<string>',
                'source' => '<string>',
            ],
            'listToMap' => [
                'flatten' => true || false,
                'flattenedElement' => 'first|last',
                'key' => '<string>',
                'source' => '<string>',
                'target' => '<string>',
                'valueKey' => '<string>',
            ],
            'lowerCaseString' => [
                'withKeys' => ['<string>', ...],
            ],
            'moveKeys' => [
                'entries' => [
                    [
                        'overwriteIfExists' => true || false,
                        'source' => '<string>',
                        'target' => '<string>',
                    ],
                    // ...
                ],
            ],
            'parseCloudfront' => [
                'source' => '<string>',
            ],
            'parseJSON' => [
                'destination' => '<string>',
                'source' => '<string>',
            ],
            'parseKeyValue' => [
                'destination' => '<string>',
                'fieldDelimiter' => '<string>',
                'keyPrefix' => '<string>',
                'keyValueDelimiter' => '<string>',
                'nonMatchValue' => '<string>',
                'overwriteIfExists' => true || false,
                'source' => '<string>',
            ],
            'parsePostgres' => [
                'source' => '<string>',
            ],
            'parseRoute53' => [
                'source' => '<string>',
            ],
            'parseToOCSF' => [
                'eventSource' => 'CloudTrail|Route53Resolver|VPCFlow|EKSAudit|AWSWAF',
                'ocsfVersion' => 'V1.1',
                'source' => '<string>',
            ],
            'parseVPC' => [
                'source' => '<string>',
            ],
            'parseWAF' => [
                'source' => '<string>',
            ],
            'renameKeys' => [
                'entries' => [
                    [
                        'key' => '<string>',
                        'overwriteIfExists' => true || false,
                        'renameTo' => '<string>',
                    ],
                    // ...
                ],
            ],
            'splitString' => [
                'entries' => [
                    [
                        'delimiter' => '<string>',
                        'source' => '<string>',
                    ],
                    // ...
                ],
            ],
            'substituteString' => [
                'entries' => [
                    [
                        'from' => '<string>',
                        'source' => '<string>',
                        'to' => '<string>',
                    ],
                    // ...
                ],
            ],
            'trimString' => [
                'withKeys' => ['<string>', ...],
            ],
            'typeConverter' => [
                'entries' => [
                    [
                        'key' => '<string>',
                        'type' => 'boolean|integer|double|string',
                    ],
                    // ...
                ],
            ],
            'upperCaseString' => [
                'withKeys' => ['<string>', ...],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

InvalidOperationException:

The operation is not valid on the specified resource.

ListAnomalies

$result = $client->listAnomalies([/* ... */]);
$promise = $client->listAnomaliesAsync([/* ... */]);

Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.

Parameter Syntax

$result = $client->listAnomalies([
    'anomalyDetectorArn' => '<string>',
    'limit' => <integer>,
    'nextToken' => '<string>',
    'suppressionState' => 'SUPPRESSED|UNSUPPRESSED',
]);

Parameter Details

Result Syntax

[
    'anomalies' => [
        [
            'active' => true || false,
            'anomalyDetectorArn' => '<string>',
            'anomalyId' => '<string>',
            'description' => '<string>',
            'firstSeen' => <integer>,
            'histogram' => [<integer>, ...],
            'isPatternLevelSuppression' => true || false,
            'lastSeen' => <integer>,
            'logGroupArnList' => ['<string>', ...],
            'logSamples' => [
                [
                    'message' => '<string>',
                    'timestamp' => <integer>,
                ],
                // ...
            ],
            'patternId' => '<string>',
            'patternRegex' => '<string>',
            'patternString' => '<string>',
            'patternTokens' => [
                [
                    'dynamicTokenPosition' => <integer>,
                    'enumerations' => [<integer>, ...],
                    'inferredTokenName' => '<string>',
                    'isDynamic' => true || false,
                    'tokenString' => '<string>',
                ],
                // ...
            ],
            'priority' => '<string>',
            'state' => 'Active|Suppressed|Baseline',
            'suppressed' => true || false,
            'suppressedDate' => <integer>,
            'suppressedUntil' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ListIntegrations

$result = $client->listIntegrations([/* ... */]);
$promise = $client->listIntegrationsAsync([/* ... */]);

Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one integration can be created in an account, and this integration must be with OpenSearch Service.

Parameter Syntax

$result = $client->listIntegrations([
    'integrationNamePrefix' => '<string>',
    'integrationStatus' => 'PROVISIONING|ACTIVE|FAILED',
    'integrationType' => 'OPENSEARCH',
]);

Parameter Details

Result Syntax

[
    'integrationSummaries' => [
        [
            'integrationName' => '<string>',
            'integrationStatus' => 'PROVISIONING|ACTIVE|FAILED',
            'integrationType' => 'OPENSEARCH',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ServiceUnavailableException:

The service cannot complete the request.

ListLogAnomalyDetectors

$result = $client->listLogAnomalyDetectors([/* ... */]);
$promise = $client->listLogAnomalyDetectorsAsync([/* ... */]);

Retrieves a list of the log anomaly detectors in the account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'anomalyDetectors' => [
        [
            'anomalyDetectorArn' => '<string>',
            'anomalyDetectorStatus' => 'INITIALIZING|TRAINING|ANALYZING|FAILED|DELETED|PAUSED',
            'anomalyVisibilityTime' => <integer>,
            'creationTimeStamp' => <integer>,
            'detectorName' => '<string>',
            'evaluationFrequency' => 'ONE_MIN|FIVE_MIN|TEN_MIN|FIFTEEN_MIN|THIRTY_MIN|ONE_HOUR',
            'filterPattern' => '<string>',
            'kmsKeyId' => '<string>',
            'lastModifiedTimeStamp' => <integer>,
            'logGroupArnList' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ListLogGroups

$result = $client->listLogGroups([/* ... */]);
$promise = $client->listLogGroupsAsync([/* ... */]);

Returns a list of log groups in the Region in your account. If you are performing this action in a monitoring account, you can choose to also return log groups from source accounts that are linked to the monitoring account. For more information about using cross-account observability to set up monitoring accounts and source accounts, see CloudWatch cross-account observability.

You can optionally filter the list by log group class and by using regular expressions in your request to match strings in the log group names.

This operation is paginated. By default, your first use of this operation returns 50 results, and includes a token to use in a subsequent operation to return more results.

Parameter Syntax

$result = $client->listLogGroups([
    'accountIdentifiers' => ['<string>', ...],
    'includeLinkedAccounts' => true || false,
    'limit' => <integer>,
    'logGroupClass' => 'STANDARD|INFREQUENT_ACCESS|DELIVERY',
    'logGroupNamePattern' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'logGroups' => [
        [
            'logGroupArn' => '<string>',
            'logGroupClass' => 'STANDARD|INFREQUENT_ACCESS|DELIVERY',
            'logGroupName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

ServiceUnavailableException:

The service cannot complete the request.

ListLogGroupsForQuery

$result = $client->listLogGroupsForQuery([/* ... */]);
$promise = $client->listLogGroupsForQueryAsync([/* ... */]);

Returns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query. This can be useful for queries that use log group name prefixes or the filterIndex command, because the log groups are dynamically selected in these cases.

For more information about field indexes, see Create field indexes to improve query performance and reduce costs.

Parameter Syntax

$result = $client->listLogGroupsForQuery([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'logGroupIdentifiers' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.

Lists the tags for the specified log group.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

PutAccountPolicy

$result = $client->putAccountPolicy([/* ... */]);
$promise = $client->putAccountPolicyAsync([/* ... */]);

Creates an account-level data protection policy, subscription filter policy, or field index policy that applies to all log groups or a subset of log groups in the account.

To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are creating.

• To create a data protection policy, you must have the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions.

• To create a subscription filter policy, you must have the logs:PutSubscriptionFilter and logs:PutccountPolicy permissions.

• To create a transformer policy, you must have the logs:PutTransformer and logs:PutAccountPolicy permissions.

• To create a field index policy, you must have the logs:PutIndexPolicy and logs:PutAccountPolicy permissions.

Data protection policy

A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.

If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

To use the PutAccountPolicy operation for a data protection policy, you must be signed on with the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions.

The PutAccountPolicy operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

Subscription filter policy

A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

The following destinations are supported for subscription filters:

• An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.

• An Firehose data stream in the same account as the subscription policy, for same-account delivery.

• A Lambda function in the same account as the subscription policy, for same-account delivery.

• A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.

Each account can have one account-level subscription filter policy per Region. If you are updating an existing filter, you must specify the correct name in PolicyName. To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.

Transformer policy

Creates or updates a log transformer policy for your account. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contain relevant, source-specific information. After you have created a transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters.

You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region.

A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. For more information about the available processors to use in a transformer, see Processors that you can use.

Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.

You can create transformers only for the log groups in the Standard log class.

You can have one account-level transformer policy that applies to all log groups in the account. Or you can create as many as 20 account-level transformer policies that are each scoped to a subset of log groups with the selectionCriteria parameter. If you have multiple account-level transformer policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with my-log, you can't have another field index policy filtered to my-logpprod or my-logging.

You can also set up a transformer at the log-group level. For more information, see PutTransformer. If there is both a log-group level transformer created with PutTransformer and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer.

Field index policy

You can use field index policies to create indexes on fields found in log events in the log group. Creating field indexes can help lower the scan volume for CloudWatch Logs Insights queries that reference those fields, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, user IDs, or instance IDs. For more information, see Create field indexes to improve query performance and reduce costs

To find the fields that are in your log group events, use the GetLogGroupFields operation.

For example, suppose you have created a field index for requestId. Then, any CloudWatch Logs Insights query on that log group that includes requestId = value or requestId in [value, value, ...] will attempt to process only the log events where the indexed field matches the specified value.

Matches of log events to the names of indexed fields are case-sensitive. For example, an indexed field of RequestId won't match a log event containing requestId.

You can have one account-level field index policy that applies to all log groups in the account. Or you can create as many as 20 account-level field index policies that are each scoped to a subset of log groups with the selectionCriteria parameter. If you have multiple account-level index policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with my-log, you can't have another field index policy filtered to my-logpprod or my-logging.

If you create an account-level field index policy in a monitoring account in cross-account observability, the policy is applied only to the monitoring account and not to any source accounts.

If you want to create a field index policy for a single log group, you can use PutIndexPolicy instead of PutAccountPolicy. If you do so, that log group will use only that log-group level policy, and will ignore the account-level policy that you create with PutAccountPolicy.

Parameter Syntax

$result = $client->putAccountPolicy([
    'policyDocument' => '<string>', // REQUIRED
    'policyName' => '<string>', // REQUIRED
    'policyType' => 'DATA_PROTECTION_POLICY|SUBSCRIPTION_FILTER_POLICY|FIELD_INDEX_POLICY|TRANSFORMER_POLICY', // REQUIRED
    'scope' => 'ALL',
    'selectionCriteria' => '<string>',
]);

Parameter Details

Result Syntax

[
    'accountPolicy' => [
        'accountId' => '<string>',
        'lastUpdatedTime' => <integer>,
        'policyDocument' => '<string>',
        'policyName' => '<string>',
        'policyType' => 'DATA_PROTECTION_POLICY|SUBSCRIPTION_FILTER_POLICY|FIELD_INDEX_POLICY|TRANSFORMER_POLICY',
        'scope' => 'ALL',
        'selectionCriteria' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ServiceUnavailableException:

The service cannot complete the request.

LimitExceededException:

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

PutDataProtectionPolicy

$result = $client->putDataProtectionPolicy([/* ... */]);
$promise = $client->putDataProtectionPolicyAsync([/* ... */]);

Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

The PutDataProtectionPolicy operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

Parameter Syntax

$result = $client->putDataProtectionPolicy([
    'logGroupIdentifier' => '<string>', // REQUIRED
    'policyDocument' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'lastUpdatedTime' => <integer>,
    'logGroupIdentifier' => '<string>',
    'policyDocument' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

LimitExceededException:

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

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ResourceNotFoundException:

The specified resource does not exist.

ServiceUnavailableException:

The service cannot complete the request.

PutDeliveryDestination

$result = $client->putDeliveryDestination([/* ... */]);
$promise = $client->putDeliveryDestinationAsync([/* ... */]);

Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations.

To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:

• Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.

• Use PutDeliveryDestination to create a delivery destination in the same account of the actual delivery destination. The delivery destination that you create is a logical object that represents the actual delivery destination.

• If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.

• Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.

Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.

If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.

Parameter Syntax

$result = $client->putDeliveryDestination([
    'deliveryDestinationConfiguration' => [ // REQUIRED
        'destinationResourceArn' => '<string>', // REQUIRED
    ],
    'name' => '<string>', // REQUIRED
    'outputFormat' => 'json|plain|w3c|raw|parquet',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'deliveryDestination' => [
        'arn' => '<string>',
        'deliveryDestinationConfiguration' => [
            'destinationResourceArn' => '<string>',
        ],
        'deliveryDestinationType' => 'S3|CWL|FH',
        'name' => '<string>',
        'outputFormat' => 'json|plain|w3c|raw|parquet',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ServiceUnavailableException:

The service cannot complete the request.

ConflictException:

This operation attempted to create a resource that already exists.

ValidationException:

One of the parameters for the request is not valid.

ServiceQuotaExceededException:

This request exceeds a service quota.

ThrottlingException:

The request was throttled because of quota limits.

ResourceNotFoundException:

The specified resource does not exist.

PutDeliveryDestinationPolicy

$result = $client->putDeliveryDestinationPolicy([/* ... */]);
$promise = $client->putDeliveryDestinationPolicyAsync([/* ... */]);

Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:

• Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.

• Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.

• Use this operation in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.

• Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.

The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies.

Parameter Syntax

$result = $client->putDeliveryDestinationPolicy([
    'deliveryDestinationName' => '<string>', // REQUIRED
    'deliveryDestinationPolicy' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policy' => [
        'deliveryDestinationPolicy' => '<string>',
    ],
]

Result Details

Errors

ServiceUnavailableException:

The service cannot complete the request.

ValidationException:

One of the parameters for the request is not valid.

ResourceNotFoundException:

The specified resource does not exist.

ConflictException:

This operation attempted to create a resource that already exists.

PutDeliverySource

$result = $client->putDeliverySource([/* ... */]);
$promise = $client->putDeliverySourceAsync([/* ... */]);

Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.

To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:

• Use PutDeliverySource to create a delivery source, which is a logical object that represents the resource that is actually sending the logs.

• Use PutDeliveryDestination to create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.

• If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.

• Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.

Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.

If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify.

Parameter Syntax

$result = $client->putDeliverySource([
    'logType' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'deliverySource' => [
        'arn' => '<string>',
        'logType' => '<string>',
        'name' => '<string>',
        'resourceArns' => ['<string>', ...],
        'service' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ServiceUnavailableException:

The service cannot complete the request.

ConflictException:

This operation attempted to create a resource that already exists.

ValidationException:

One of the parameters for the request is not valid.

ServiceQuotaExceededException:

This request exceeds a service quota.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was throttled because of quota limits.

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). With a destination, you can 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.

To perform a PutDestination operation, you must also have the iam:PassRole permission.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

OperationAbortedException:

Multiple concurrent 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
    'forceUpdate' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter is specified incorrectly.

OperationAbortedException:

Multiple concurrent requests to update the same resource were in conflict.

ServiceUnavailableException:

The service cannot complete the request.