{ "version":"2.0", "metadata":{ "apiVersion":"2014-03-28", "endpointPrefix":"logs", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon CloudWatch Logs", "serviceId":"CloudWatch Logs", "signatureVersion":"v4", "targetPrefix":"Logs_20140328", "uid":"logs-2014-03-28" }, "operations":{ "AssociateKmsKey":{ "name":"AssociateKmsKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateKmsKeyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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 all log events stored in the 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.

If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.

CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.

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.

" }, "CancelExportTask":{ "name":"CancelExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelExportTaskRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidOperationException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Cancels the specified export task.

The task must be in the `PENDING` or `RUNNING` state.

" }, "CreateDelivery":{ "name":"CreateDelivery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDeliveryRequest"}, "output":{"shape":"CreateDeliveryResponse"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

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 Kinesis Data 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.

You can't update an existing delivery. You can only create and delete deliveries.

" }, "CreateExportTask":{ "name":"CreateExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateExportTaskRequest"}, "output":{"shape":"CreateExportTaskResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceAlreadyExistsException"} ], "documentation":"

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.

Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.

" }, "CreateLogAnomalyDetector":{ "name":"CreateLogAnomalyDetector", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLogAnomalyDetectorRequest"}, "output":{"shape":"CreateLogAnomalyDetectorResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationAbortedException"}, {"shape":"LimitExceededException"} ], "documentation":"

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 `<*>`

Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information about masking sensitive data, see Help protect sensitive log data with masking.

" }, "CreateLogGroup":{ "name":"CreateLogGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLogGroupRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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)

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.

CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.

" }, "CreateLogStream":{ "name":"CreateLogStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLogStreamRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "DeleteAccountPolicy":{ "name":"DeleteAccountPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAccountPolicyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationAbortedException"} ], "documentation":"

Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups or a subset of log groups in the account. Log-group level policies will still be 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.

" }, "DeleteDataProtectionPolicy":{ "name":"DeleteDataProtectionPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDataProtectionPolicyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"OperationAbortedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Deletes the data protection policy from the specified log group.

For more information about data protection policies, see PutDataProtectionPolicy.

" }, "DeleteDelivery":{ "name":"DeleteDelivery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDeliveryRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes s 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.

" }, "DeleteDeliveryDestination":{ "name":"DeleteDeliveryDestination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDeliveryDestinationRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "DeleteDeliveryDestinationPolicy":{ "name":"DeleteDeliveryDestinationPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDeliveryDestinationPolicyRequest"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

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

" }, "DeleteDeliverySource":{ "name":"DeleteDeliverySource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDeliverySourceRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "DeleteDestination":{ "name":"DeleteDestination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDestinationRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "DeleteLogAnomalyDetector":{ "name":"DeleteLogAnomalyDetector", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLogAnomalyDetectorRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationAbortedException"} ], "documentation":"

Deletes the specified CloudWatch Logs anomaly detector.

" }, "DeleteLogGroup":{ "name":"DeleteLogGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLogGroupRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

" }, "DeleteLogStream":{ "name":"DeleteLogStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLogStreamRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

" }, "DeleteMetricFilter":{ "name":"DeleteMetricFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteMetricFilterRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Deletes the specified metric filter.

" }, "DeleteQueryDefinition":{ "name":"DeleteQueryDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteQueryDefinitionRequest"}, "output":{"shape":"DeleteQueryDefinitionResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "DeleteResourcePolicy":{ "name":"DeleteResourcePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteResourcePolicyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

" }, "DeleteRetentionPolicy":{ "name":"DeleteRetentionPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRetentionPolicyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Deletes the specified retention policy.

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

" }, "DeleteSubscriptionFilter":{ "name":"DeleteSubscriptionFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubscriptionFilterRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Deletes the specified subscription filter.

" }, "DescribeAccountPolicies":{ "name":"DescribeAccountPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountPoliciesRequest"}, "output":{"shape":"DescribeAccountPoliciesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"OperationAbortedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

" }, "DescribeDeliveries":{ "name":"DescribeDeliveries", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDeliveriesRequest"}, "output":{"shape":"DescribeDeliveriesResponse"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

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

" }, "DescribeDeliveryDestinations":{ "name":"DescribeDeliveryDestinations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDeliveryDestinationsRequest"}, "output":{"shape":"DescribeDeliveryDestinationsResponse"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

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

" }, "DescribeDeliverySources":{ "name":"DescribeDeliverySources", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDeliverySourcesRequest"}, "output":{"shape":"DescribeDeliverySourcesResponse"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

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

" }, "DescribeDestinations":{ "name":"DescribeDestinations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDestinationsRequest"}, "output":{"shape":"DescribeDestinationsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

" }, "DescribeExportTasks":{ "name":"DescribeExportTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExportTasksRequest"}, "output":{"shape":"DescribeExportTasksResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

" }, "DescribeLogGroups":{ "name":"DescribeLogGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLogGroupsRequest"}, "output":{"shape":"DescribeLogGroupsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

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.

" }, "DescribeLogStreams":{ "name":"DescribeLogStreams", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLogStreamsRequest"}, "output":{"shape":"DescribeLogStreamsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

" }, "DescribeMetricFilters":{ "name":"DescribeMetricFilters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMetricFiltersRequest"}, "output":{"shape":"DescribeMetricFiltersResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "DescribeQueries":{ "name":"DescribeQueries", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeQueriesRequest"}, "output":{"shape":"DescribeQueriesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "DescribeQueryDefinitions":{ "name":"DescribeQueryDefinitions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeQueryDefinitionsRequest"}, "output":{"shape":"DescribeQueryDefinitionsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "DescribeResourcePolicies":{ "name":"DescribeResourcePolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeResourcePoliciesRequest"}, "output":{"shape":"DescribeResourcePoliciesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists the resource policies in this account.

" }, "DescribeSubscriptionFilters":{ "name":"DescribeSubscriptionFilters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubscriptionFiltersRequest"}, "output":{"shape":"DescribeSubscriptionFiltersResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "DisassociateKmsKey":{ "name":"DisassociateKmsKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateKmsKeyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "FilterLogEvents":{ "name":"FilterLogEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"FilterLogEventsRequest"}, "output":{"shape":"FilterLogEventsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

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.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.

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.

" }, "GetDataProtectionPolicy":{ "name":"GetDataProtectionPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDataProtectionPolicyRequest"}, "output":{"shape":"GetDataProtectionPolicyResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"OperationAbortedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Returns information about a log group data protection policy.

" }, "GetDelivery":{ "name":"GetDelivery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeliveryRequest"}, "output":{"shape":"GetDeliveryResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

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

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.

" }, "GetDeliveryDestination":{ "name":"GetDeliveryDestination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeliveryDestinationRequest"}, "output":{"shape":"GetDeliveryDestinationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

Retrieves complete information about one delivery destination.

" }, "GetDeliveryDestinationPolicy":{ "name":"GetDeliveryDestinationPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeliveryDestinationPolicyRequest"}, "output":{"shape":"GetDeliveryDestinationPolicyResponse"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

" }, "GetDeliverySource":{ "name":"GetDeliverySource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeliverySourceRequest"}, "output":{"shape":"GetDeliverySourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

Retrieves complete information about one delivery source.

" }, "GetLogAnomalyDetector":{ "name":"GetLogAnomalyDetector", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetLogAnomalyDetectorRequest"}, "output":{"shape":"GetLogAnomalyDetectorResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationAbortedException"} ], "documentation":"

Retrieves information about the log anomaly detector that you specify.

" }, "GetLogEvents":{ "name":"GetLogEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetLogEventsRequest"}, "output":{"shape":"GetLogEventsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

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.

" }, "GetLogGroupFields":{ "name":"GetLogGroupFields", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetLogGroupFieldsRequest"}, "output":{"shape":"GetLogGroupFieldsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "GetLogRecord":{ "name":"GetLogRecord", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetLogRecordRequest"}, "output":{"shape":"GetLogRecordResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

" }, "GetQueryResults":{ "name":"GetQueryResults", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetQueryResultsRequest"}, "output":{"shape":"GetQueryResultsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "ListAnomalies":{ "name":"ListAnomalies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAnomaliesRequest"}, "output":{"shape":"ListAnomaliesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationAbortedException"} ], "documentation":"

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.

" }, "ListLogAnomalyDetectors":{ "name":"ListLogAnomalyDetectors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListLogAnomalyDetectorsRequest"}, "output":{"shape":"ListLogAnomalyDetectorsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationAbortedException"} ], "documentation":"

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

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

" }, "ListTagsLogGroup":{ "name":"ListTagsLogGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsLogGroupRequest"}, "output":{"shape":"ListTagsLogGroupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

Lists the tags for the specified log group.

", "deprecated":true, "deprecatedMessage":"Please use the generic tagging API ListTagsForResource" }, "PutAccountPolicy":{ "name":"PutAccountPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutAccountPolicyRequest"}, "output":{"shape":"PutAccountPolicyResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"LimitExceededException"} ], "documentation":"

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

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.

Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.

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, Kinesis Data 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 Kinesis Data 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 Kinesis Data Firehose are supported as logical destinations.

Each account can have one account-level subscription filter policy. 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.

" }, "PutDataProtectionPolicy":{ "name":"PutDataProtectionPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutDataProtectionPolicyRequest"}, "output":{"shape":"PutDataProtectionPolicyResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"OperationAbortedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not 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.

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.

" }, "PutDeliveryDestination":{ "name":"PutDeliveryDestination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutDeliveryDestinationRequest"}, "output":{"shape":"PutDeliveryDestinationResponse"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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 Kinesis Data 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, which 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.

" }, "PutDeliveryDestinationPolicy":{ "name":"PutDeliveryDestinationPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutDeliveryDestinationPolicyRequest"}, "output":{"shape":"PutDeliveryDestinationPolicyResponse"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

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.

" }, "PutDeliverySource":{ "name":"PutDeliverySource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutDeliverySourceRequest"}, "output":{"shape":"PutDeliverySourceResponse"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"

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 Kinesis Data 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.

" }, "PutDestination":{ "name":"PutDestination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutDestinationRequest"}, "output":{"shape":"PutDestinationResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "PutDestinationPolicy":{ "name":"PutDestinationPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutDestinationPolicyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

" }, "PutLogEvents":{ "name":"PutLogEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutLogEventsRequest"}, "output":{"shape":"PutLogEventsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidSequenceTokenException"}, {"shape":"DataAlreadyAcceptedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"UnrecognizedClientException"} ], "documentation":"

Uploads a batch of log events to the specified log stream.

The sequence token is now ignored in `PutLogEvents` actions. `PutLogEvents` actions are always accepted and never return `InvalidSequenceTokenException` or `DataAlreadyAcceptedException` even if the sequence token is not valid. You can use parallel `PutLogEvents` actions on the same log stream.

The batch of events must satisfy the following constraints:

- The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

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

- None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.

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

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

- Each log event can be no larger than 256 KB.

- The maximum number of log events in a batch is 10,000.

- The quota of five requests per second per log stream has been removed. Instead, `PutLogEvents` actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.

If a call to `PutLogEvents` returns \"UnrecognizedClientException\" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.

" }, "PutMetricFilter":{ "name":"PutMetricFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutMetricFilterRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.

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

When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as `IPAddress` or `requestID` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

" }, "PutQueryDefinition":{ "name":"PutQueryDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutQueryDefinitionRequest"}, "output":{"shape":"PutQueryDefinitionResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.

To update a query definition, specify its `queryDefinitionId` in your request. The values of `name`, `queryString`, and `logGroupNames` are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify the `logGroupNames` parameter in your update operation, the query definition changes to contain no log groups.

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

" }, "PutResourcePolicy":{ "name":"PutResourcePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutResourcePolicyRequest"}, "output":{"shape":"PutResourcePolicyResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.

" }, "PutRetentionPolicy":{ "name":"PutRetentionPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutRetentionPolicyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.

CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.

To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.

When log events reach their retention setting they are marked for deletion. After they are marked for deletion, they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These log events marked for deletion are also not included when you use an API to retrieve the `storedBytes` value to see how many bytes a log group is storing.

" }, "PutSubscriptionFilter":{ "name":"PutSubscriptionFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutSubscriptionFilterRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. 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 Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.

- A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Kinesis Data Firehose as logical destinations.

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

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

Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in `filterName`.

To perform a `PutSubscriptionFilter` operation for any destination except a Lambda function, you must also have the `iam:PassRole` permission.

" }, "StartLiveTail":{ "name":"StartLiveTail", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartLiveTailRequest"}, "output":{"shape":"StartLiveTailResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidOperationException"} ], "documentation":"

Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time.

The response to this operation is a response stream, over which the server sends live log events and the client receives them.

The following objects are sent over the stream:

- A single LiveTailSessionStart object is sent at the start of the session.

- Every second, a LiveTailSessionUpdate object is sent. Each of these objects contains an array of the actual log events.

  If no new log events were ingested in the past second, the `LiveTailSessionUpdate` object will contain an empty array.

  The array of log events contained in a `LiveTailSessionUpdate` can include as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500 log events to be included in each `LiveTailSessionUpdate` object.

  If your client consumes the log events slower than the server produces them, CloudWatch Logs buffers up to 10 `LiveTailSessionUpdate` events or 5000 log events, after which it starts dropping the oldest events.

- A SessionStreamingException object is returned if an unknown error occurs on the server side.

- A SessionTimeoutException object is returned when the session times out, after it has been kept open for three hours.

You can end a session before it times out by closing the session stream or by closing the client that is receiving the stream. The session also ends if the established connection between the client and the server breaks.

For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK.

", "endpoint":{"hostPrefix":"streaming-"} }, "StartQuery":{ "name":"StartQuery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartQueryRequest"}, "output":{"shape":"StartQueryResponse"}, "errors":[ {"shape":"MalformedQueryException"}, {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

For more information, see CloudWatch Logs Insights Query Syntax.

After you run a query using `StartQuery`, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using the `queryId` that `StartQuery` returns.

If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.

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

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account `StartQuery` operation, the query definition must be defined in the monitoring account.

You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.

" }, "StopQuery":{ "name":"StopQuery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopQueryRequest"}, "output":{"shape":"StopQueryResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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

" }, "TagLogGroup":{ "name":"TagLogGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagLogGroupRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"} ], "documentation":"

The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the `aws:Resource/key-name` or `aws:TagKeys` condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

", "deprecated":true, "deprecatedMessage":"Please use the generic tagging API TagResource" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"TooManyTagsException"} ], "documentation":"

Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the `TagResource` action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a CloudWatch Logs resource.

" }, "TestMetricFilter":{ "name":"TestMetricFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TestMetricFilterRequest"}, "output":{"shape":"TestMetricFilterResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

" }, "UntagLogGroup":{ "name":"UntagLogGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagLogGroupRequest"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the `aws:Resource/key-name` or `aws:TagKeys` condition keys.

", "deprecated":true, "deprecatedMessage":"Please use the generic tagging API UntagResource" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Removes one or more tags from the specified resource.

" }, "UpdateAnomaly":{ "name":"UpdateAnomaly", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAnomalyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationAbortedException"} ], "documentation":"

Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won’t report new occurrences of that anomaly and won't update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won’t report any anomalies related to that pattern.

You must specify either `anomalyId` or `patternId`, but you can't specify both parameters in the same operation.

If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to stop suppressing, and omit the `suppressionType` and `suppressionPeriod` parameters.

" }, "UpdateLogAnomalyDetector":{ "name":"UpdateLogAnomalyDetector", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateLogAnomalyDetectorRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationAbortedException"} ], "documentation":"

Updates an existing log anomaly detector.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ }, "documentation":"

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

", "exception":true }, "AccessPolicy":{ "type":"string", "min":1 }, "AccountId":{ "type":"string", "max":12, "min":12, "pattern":"^\\d{12}$" }, "AccountIds":{ "type":"list", "member":{"shape":"AccountId"}, "max":20, "min":0 }, "AccountPolicies":{ "type":"list", "member":{"shape":"AccountPolicy"} }, "AccountPolicy":{ "type":"structure", "members":{ "policyName":{ "shape":"PolicyName", "documentation":"

The name of the account policy.

" }, "policyDocument":{ "shape":"AccountPolicyDocument", "documentation":"

The policy document for this account policy.

The JSON specified in `policyDocument` can be up to 30,720 characters.

" }, "lastUpdatedTime":{ "shape":"Timestamp", "documentation":"

The date and time that this policy was most recently updated.

" }, "policyType":{ "shape":"PolicyType", "documentation":"

The type of policy for this account policy.

" }, "scope":{ "shape":"Scope", "documentation":"

The scope of the account policy.

" }, "selectionCriteria":{ "shape":"SelectionCriteria", "documentation":"

The log group selection criteria for this subscription filter policy.

" }, "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID that the policy applies to.

" } }, "documentation":"

A structure that contains information about one CloudWatch Logs account policy.

" }, "AccountPolicyDocument":{"type":"string"}, "AmazonResourceName":{ "type":"string", "max":1011, "min":1, "pattern":"[\\w+=/:,.@-]*" }, "Anomalies":{ "type":"list", "member":{"shape":"Anomaly"} }, "Anomaly":{ "type":"structure", "required":[ "anomalyId", "patternId", "anomalyDetectorArn", "patternString", "firstSeen", "lastSeen", "description", "active", "state", "histogram", "logSamples", "patternTokens", "logGroupArnList" ], "members":{ "anomalyId":{ "shape":"AnomalyId", "documentation":"

The unique ID that CloudWatch Logs assigned to this anomaly.

" }, "patternId":{ "shape":"PatternId", "documentation":"

The ID of the pattern used to help identify this anomaly.

" }, "anomalyDetectorArn":{ "shape":"AnomalyDetectorArn", "documentation":"

The ARN of the anomaly detector that identified this anomaly.

" }, "patternString":{ "shape":"PatternString", "documentation":"

The pattern used to help identify this anomaly, in string format.

" }, "patternRegex":{ "shape":"PatternRegex", "documentation":"

The pattern used to help identify this anomaly, in regular expression format.

" }, "priority":{ "shape":"Priority", "documentation":"

The priority level of this anomaly, as determined by CloudWatch Logs. Priority is computed based on log severity labels such as `FATAL` and `ERROR` and the amount of deviation from the baseline. Possible values are `HIGH`, `MEDIUM`, and `LOW`.

" }, "firstSeen":{ "shape":"EpochMillis", "documentation":"

The date and time when the anomaly detector first saw this anomaly. It is specified as epoch time, which is the number of seconds since `January 1, 1970, 00:00:00 UTC`.

" }, "lastSeen":{ "shape":"EpochMillis", "documentation":"

The date and time when the anomaly detector most recently saw this anomaly. It is specified as epoch time, which is the number of seconds since `January 1, 1970, 00:00:00 UTC`.

" }, "description":{ "shape":"Description", "documentation":"

A human-readable description of the anomaly. This description is generated by CloudWatch Logs.

" }, "active":{ "shape":"Boolean", "documentation":"

Specifies whether this anomaly is still ongoing.

" }, "state":{ "shape":"State", "documentation":"

Indicates the current state of this anomaly. If it is still being treated as an anomaly, the value is `Active`. If you have suppressed this anomaly by using the UpdateAnomaly operation, the value is `Suppressed`. If this behavior is now considered to be normal, the value is `Baseline`.

" }, "histogram":{ "shape":"Histogram", "documentation":"

A map showing times when the anomaly detector ran, and the number of occurrences of this anomaly that were detected at each of those runs. The times are specified in epoch time, which is the number of seconds since `January 1, 1970, 00:00:00 UTC`.

" }, "logSamples":{ "shape":"LogSamples", "documentation":"

An array of sample log event messages that are considered to be part of this anomaly.

" }, "patternTokens":{ "shape":"PatternTokens", "documentation":"

An array of structures where each structure contains information about one token that makes up the pattern.

" }, "logGroupArnList":{ "shape":"LogGroupArnList", "documentation":"

An array of ARNS of the log groups that contained log events considered to be part of this anomaly.

" }, "suppressed":{ "shape":"Boolean", "documentation":"

Indicates whether this anomaly is currently suppressed. To suppress an anomaly, use UpdateAnomaly.

" }, "suppressedDate":{ "shape":"EpochMillis", "documentation":"

If the anomaly is suppressed, this indicates when it was suppressed.

" }, "suppressedUntil":{ "shape":"EpochMillis", "documentation":"

If the anomaly is suppressed, this indicates when the suppression will end. If this value is `0`, the anomaly was suppressed with no expiration, with the `INFINITE` value.

" }, "isPatternLevelSuppression":{ "shape":"Boolean", "documentation":"

If this anomaly is suppressed, this field is `true` if the suppression is because the pattern is suppressed. If `false`, then only this particular anomaly is suppressed.

" } }, "documentation":"

This structure represents one anomaly that has been found by a logs anomaly detector.

For more information about patterns and anomalies, see CreateLogAnomalyDetector.

" }, "AnomalyDetector":{ "type":"structure", "members":{ "anomalyDetectorArn":{ "shape":"AnomalyDetectorArn", "documentation":"

The ARN of the anomaly detector.

" }, "detectorName":{ "shape":"DetectorName", "documentation":"

The name of the anomaly detector.

" }, "logGroupArnList":{ "shape":"LogGroupArnList", "documentation":"

A list of the ARNs of the log groups that this anomaly detector watches.

" }, "evaluationFrequency":{ "shape":"EvaluationFrequency", "documentation":"

Specifies how often the anomaly detector runs and look for anomalies.

" }, "filterPattern":{"shape":"FilterPattern"}, "anomalyDetectorStatus":{ "shape":"AnomalyDetectorStatus", "documentation":"

Specifies the current status of the anomaly detector. To pause an anomaly detector, use the `enabled` parameter in the UpdateLogAnomalyDetector operation.

" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

The ID of the KMS key assigned to this anomaly detector, if any.

" }, "creationTimeStamp":{ "shape":"EpochMillis", "documentation":"

The date and time when this anomaly detector was created.

" }, "lastModifiedTimeStamp":{ "shape":"EpochMillis", "documentation":"

The date and time when this anomaly detector was most recently modified.

" }, "anomalyVisibilityTime":{ "shape":"AnomalyVisibilityTime", "documentation":"

The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined and the anomaly detector model will treat new occurrences of similar event as normal.

" } }, "documentation":"

Contains information about one anomaly detector in the account.

" }, "AnomalyDetectorArn":{ "type":"string", "min":1, "pattern":"[\\w#+=/:,.@-]*" }, "AnomalyDetectorStatus":{ "type":"string", "enum":[ "INITIALIZING", "TRAINING", "ANALYZING", "FAILED", "DELETED", "PAUSED" ] }, "AnomalyDetectors":{ "type":"list", "member":{"shape":"AnomalyDetector"} }, "AnomalyId":{ "type":"string", "max":36, "min":36 }, "AnomalyVisibilityTime":{ "type":"long", "max":90, "min":7 }, "Arn":{"type":"string"}, "AssociateKmsKeyRequest":{ "type":"structure", "required":["kmsKeyId"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

In your `AssociateKmsKey` operation, you must specify either the `resourceIdentifier` parameter or the `logGroup` parameter, but you can't specify both.

" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys.

" }, "resourceIdentifier":{ "shape":"ResourceIdentifier", "documentation":"

Specifies the target for this operation. You must specify one of the following:

- Specify the following ARN to have future GetQueryResults operations in this account encrypt the results with the specified KMS key. Replace REGION and ACCOUNT_ID with your Region and account ID.

  `arn:aws:logs:REGION:ACCOUNT_ID:query-result:*`

- Specify the ARN of a log group to have CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log group. The log group ARN must be in the following format. Replace REGION and ACCOUNT_ID with your Region and account ID.

  `arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME`

In your `AssociateKmsKey` operation, you must specify either the `resourceIdentifier` parameter or the `logGroup` parameter, but you can't specify both.

" } } }, "Boolean":{"type":"boolean"}, "CancelExportTaskRequest":{ "type":"structure", "required":["taskId"], "members":{ "taskId":{ "shape":"ExportTaskId", "documentation":"

The ID of the export task.

" } } }, "ClientToken":{ "type":"string", "max":128, "min":36, "pattern":"\\S{36,128}" }, "ConflictException":{ "type":"structure", "members":{ }, "documentation":"

This operation attempted to create a resource that already exists.

", "exception":true }, "Count":{"type":"long"}, "CreateDeliveryRequest":{ "type":"structure", "required":[ "deliverySourceName", "deliveryDestinationArn" ], "members":{ "deliverySourceName":{ "shape":"DeliverySourceName", "documentation":"

The name of the delivery source to use for this delivery.

" }, "deliveryDestinationArn":{ "shape":"Arn", "documentation":"

The ARN of the delivery destination to use for this delivery.

" }, "tags":{ "shape":"Tags", "documentation":"

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources

" } } }, "CreateDeliveryResponse":{ "type":"structure", "members":{ "delivery":{ "shape":"Delivery", "documentation":"

A structure that contains information about the delivery that you just created.

" } } }, "CreateExportTaskRequest":{ "type":"structure", "required":[ "logGroupName", "from", "to", "destination" ], "members":{ "taskName":{ "shape":"ExportTaskName", "documentation":"

The name of the export task.

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "logStreamNamePrefix":{ "shape":"LogStreamName", "documentation":"

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

" }, "from":{ "shape":"Timestamp", "documentation":"

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

" }, "to":{ "shape":"Timestamp", "documentation":"

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

You must specify a time that is not earlier than when this log group was created.

" }, "destination":{ "shape":"ExportDestinationBucket", "documentation":"

The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.

" }, "destinationPrefix":{ "shape":"ExportDestinationPrefix", "documentation":"

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

" } } }, "CreateExportTaskResponse":{ "type":"structure", "members":{ "taskId":{ "shape":"ExportTaskId", "documentation":"

The ID of the export task.

" } } }, "CreateLogAnomalyDetectorRequest":{ "type":"structure", "required":["logGroupArnList"], "members":{ "logGroupArnList":{ "shape":"LogGroupArnList", "documentation":"

An array containing the ARN of the log group that this anomaly detector will watch. You can specify only one log group ARN.

" }, "detectorName":{ "shape":"DetectorName", "documentation":"

A name for this anomaly detector.

" }, "evaluationFrequency":{ "shape":"EvaluationFrequency", "documentation":"

Specifies how often the anomaly detector is to run and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then 15 minutes might be a good setting for `evaluationFrequency` .

" }, "filterPattern":{ "shape":"FilterPattern", "documentation":"

You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here. For more information, see Filter and Pattern Syntax.

" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

Optionally assigns a KMS key to secure this anomaly detector and its findings. If a key is assigned, the anomalies found and the model used by this detector are encrypted at rest with the key. If a key is assigned to an anomaly detector, a user must have permissions for both this key and for the anomaly detector to retrieve information about the anomalies that it finds.

For more information about using a KMS key and to see the required IAM policy, see Use a KMS key with an anomaly detector.

" }, "anomalyVisibilityTime":{ "shape":"AnomalyVisibilityTime", "documentation":"

The number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly, it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as normal. Therefore, if you do not correct the cause of an anomaly during the time period specified in `anomalyVisibilityTime`, it will be considered normal going forward and will not be detected as an anomaly.

" }, "tags":{ "shape":"Tags", "documentation":"

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources

" } } }, "CreateLogAnomalyDetectorResponse":{ "type":"structure", "members":{ "anomalyDetectorArn":{ "shape":"AnomalyDetectorArn", "documentation":"

The ARN of the log anomaly detector that you just created.

" } } }, "CreateLogGroupRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

A name for the log group.

" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names.

" }, "tags":{ "shape":"Tags", "documentation":"

The key-value pairs to use for the tags.

You can grant users access to certain log groups while preventing them from accessing other log groups. To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when you create a log group, you must have either the `logs:TagResource` or `logs:TagLogGroup` permission. For more information about tagging, see Tagging Amazon Web Services resources. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

" }, "logGroupClass":{ "shape":"LogGroupClass", "documentation":"

Use this parameter to specify the log group class for this log group. There are two classes:

- The `Standard` log class supports all CloudWatch Logs features.

- The `Infrequent Access` log class supports a subset of CloudWatch Logs features and incurs lower costs.

If you omit this parameter, the default of `STANDARD` is used.

The value of `logGroupClass` can't be changed after a log group is created.

For details about the features supported by each class, see Log classes

" } } }, "CreateLogStreamRequest":{ "type":"structure", "required":[ "logGroupName", "logStreamName" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" } } }, "DataAlreadyAcceptedException":{ "type":"structure", "members":{ "expectedSequenceToken":{"shape":"SequenceToken"} }, "documentation":"

The event was already logged.

`PutLogEvents` actions are now always accepted and never return `DataAlreadyAcceptedException` regardless of whether a given batch of log events has already been accepted.

", "exception":true }, "DataProtectionPolicyDocument":{"type":"string"}, "DataProtectionStatus":{ "type":"string", "enum":[ "ACTIVATED", "DELETED", "ARCHIVED", "DISABLED" ] }, "Days":{ "type":"integer", "documentation":"

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

To set a log group so that its log events do not expire, use DeleteRetentionPolicy.

" }, "DefaultValue":{"type":"double"}, "DeleteAccountPolicyRequest":{ "type":"structure", "required":[ "policyName", "policyType" ], "members":{ "policyName":{ "shape":"PolicyName", "documentation":"

The name of the policy to delete.

" }, "policyType":{ "shape":"PolicyType", "documentation":"

The type of policy to delete.

" } } }, "DeleteDataProtectionPolicyRequest":{ "type":"structure", "required":["logGroupIdentifier"], "members":{ "logGroupIdentifier":{ "shape":"LogGroupIdentifier", "documentation":"

The name or ARN of the log group that you want to delete the data protection policy for.

" } } }, "DeleteDeliveryDestinationPolicyRequest":{ "type":"structure", "required":["deliveryDestinationName"], "members":{ "deliveryDestinationName":{ "shape":"DeliveryDestinationName", "documentation":"

The name of the delivery destination that you want to delete the policy for.

" } } }, "DeleteDeliveryDestinationRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"DeliveryDestinationName", "documentation":"

The name of the delivery destination that you want to delete. You can find a list of delivery destionation names by using the DescribeDeliveryDestinations operation.

" } } }, "DeleteDeliveryRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"DeliveryId", "documentation":"

The unique ID of the delivery to delete. You can find the ID of a delivery with the DescribeDeliveries operation.

" } } }, "DeleteDeliverySourceRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"DeliverySourceName", "documentation":"

The name of the delivery source that you want to delete.

" } } }, "DeleteDestinationRequest":{ "type":"structure", "required":["destinationName"], "members":{ "destinationName":{ "shape":"DestinationName", "documentation":"

The name of the destination.

" } } }, "DeleteLogAnomalyDetectorRequest":{ "type":"structure", "required":["anomalyDetectorArn"], "members":{ "anomalyDetectorArn":{ "shape":"AnomalyDetectorArn", "documentation":"

The ARN of the anomaly detector to delete. You can find the ARNs of log anomaly detectors in your account by using the ListLogAnomalyDetectors operation.

" } } }, "DeleteLogGroupRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" } } }, "DeleteLogStreamRequest":{ "type":"structure", "required":[ "logGroupName", "logStreamName" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" } } }, "DeleteMetricFilterRequest":{ "type":"structure", "required":[ "logGroupName", "filterName" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterName":{ "shape":"FilterName", "documentation":"

The name of the metric filter.

" } } }, "DeleteQueryDefinitionRequest":{ "type":"structure", "required":["queryDefinitionId"], "members":{ "queryDefinitionId":{ "shape":"QueryId", "documentation":"

The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

" } } }, "DeleteQueryDefinitionResponse":{ "type":"structure", "members":{ "success":{ "shape":"Success", "documentation":"

A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation failed.

" } } }, "DeleteResourcePolicyRequest":{ "type":"structure", "members":{ "policyName":{ "shape":"PolicyName", "documentation":"

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

" } } }, "DeleteRetentionPolicyRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" } } }, "DeleteSubscriptionFilterRequest":{ "type":"structure", "required":[ "logGroupName", "filterName" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterName":{ "shape":"FilterName", "documentation":"

The name of the subscription filter.

" } } }, "Deliveries":{ "type":"list", "member":{"shape":"Delivery"} }, "Delivery":{ "type":"structure", "members":{ "id":{ "shape":"DeliveryId", "documentation":"

The unique ID that identifies this delivery in your account.

" }, "arn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies this delivery.

" }, "deliverySourceName":{ "shape":"DeliverySourceName", "documentation":"

The name of the delivery source that is associated with this delivery.

" }, "deliveryDestinationArn":{ "shape":"Arn", "documentation":"

The ARN of the delivery destination that is associated with this delivery.

" }, "deliveryDestinationType":{ "shape":"DeliveryDestinationType", "documentation":"

Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.

" }, "tags":{ "shape":"Tags", "documentation":"

The tags that have been assigned to this delivery.

" } }, "documentation":"

This structure contains information about one delivery in your account.

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

For more information, see CreateDelivery.

You can't update an existing delivery. You can only create and delete deliveries.

" }, "DeliveryDestination":{ "type":"structure", "members":{ "name":{ "shape":"DeliveryDestinationName", "documentation":"

The name of this delivery destination.

" }, "arn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.

" }, "deliveryDestinationType":{ "shape":"DeliveryDestinationType", "documentation":"

Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.

" }, "outputFormat":{ "shape":"OutputFormat", "documentation":"

The format of the logs that are sent to this delivery destination.

" }, "deliveryDestinationConfiguration":{ "shape":"DeliveryDestinationConfiguration", "documentation":"

A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

" }, "tags":{ "shape":"Tags", "documentation":"

The tags that have been assigned to this delivery destination.

" } }, "documentation":"

This structure contains information about one delivery destination in your account. 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, are supported as Kinesis Data Firehose 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.

- Create a delivery destination, which 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.

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

" }, "DeliveryDestinationConfiguration":{ "type":"structure", "required":["destinationResourceArn"], "members":{ "destinationResourceArn":{ "shape":"Arn", "documentation":"

The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Kinesis Data Firehose.

" } }, "documentation":"

A structure that contains information about one logs delivery destination.

" }, "DeliveryDestinationName":{ "type":"string", "max":60, "min":1, "pattern":"[\\w-]*" }, "DeliveryDestinationPolicy":{ "type":"string", "max":51200, "min":1 }, "DeliveryDestinationType":{ "type":"string", "enum":[ "S3", "CWL", "FH" ] }, "DeliveryDestinations":{ "type":"list", "member":{"shape":"DeliveryDestination"} }, "DeliveryId":{ "type":"string", "max":64, "min":1, "pattern":"^[0-9A-Za-z]+$" }, "DeliverySource":{ "type":"structure", "members":{ "name":{ "shape":"DeliverySourceName", "documentation":"

The unique name of the delivery source.

" }, "arn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies this delivery source.

" }, "resourceArns":{ "shape":"ResourceArns", "documentation":"

This array contains the ARN of the Amazon Web Services resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.

" }, "service":{ "shape":"Service", "documentation":"

The Amazon Web Services service that is sending logs.

" }, "logType":{ "shape":"LogType", "documentation":"

The type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.

" }, "tags":{ "shape":"Tags", "documentation":"

The tags that have been assigned to this delivery source.

" } }, "documentation":"

This structure contains information about one delivery source in your account. A delivery source is an Amazon Web Services resource that sends logs to an Amazon Web Services destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.

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.

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.

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

" }, "DeliverySourceName":{ "type":"string", "max":60, "min":1, "pattern":"[\\w-]*" }, "DeliverySources":{ "type":"list", "member":{"shape":"DeliverySource"} }, "Descending":{"type":"boolean"}, "DescribeAccountPoliciesRequest":{ "type":"structure", "required":["policyType"], "members":{ "policyType":{ "shape":"PolicyType", "documentation":"

Use this parameter to limit the returned policies to only the policies that match the policy type that you specify.

" }, "policyName":{ "shape":"PolicyName", "documentation":"

Use this parameter to limit the returned policies to only the policy with the name that you specify.

" }, "accountIdentifiers":{ "shape":"AccountIds", "documentation":"

If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account observability, you can use this to specify the account ID of a source account. If you do, the operation returns the account policy for the specified account. Currently, you can specify only one account ID in this parameter.

If you omit this parameter, only the policy in the current account is returned.

" } } }, "DescribeAccountPoliciesResponse":{ "type":"structure", "members":{ "accountPolicies":{ "shape":"AccountPolicies", "documentation":"

An array of structures that contain information about the CloudWatch Logs account policies that match the specified filters.

" } } }, "DescribeDeliveriesRequest":{ "type":"structure", "members":{ "nextToken":{"shape":"NextToken"}, "limit":{ "shape":"DescribeLimit", "documentation":"

Optionally specify the maximum number of deliveries to return in the response.

" } } }, "DescribeDeliveriesResponse":{ "type":"structure", "members":{ "deliveries":{ "shape":"Deliveries", "documentation":"

An array of structures. Each structure contains information about one delivery in the account.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeDeliveryDestinationsRequest":{ "type":"structure", "members":{ "nextToken":{"shape":"NextToken"}, "limit":{ "shape":"DescribeLimit", "documentation":"

Optionally specify the maximum number of delivery destinations to return in the response.

" } } }, "DescribeDeliveryDestinationsResponse":{ "type":"structure", "members":{ "deliveryDestinations":{ "shape":"DeliveryDestinations", "documentation":"

An array of structures. Each structure contains information about one delivery destination in the account.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeDeliverySourcesRequest":{ "type":"structure", "members":{ "nextToken":{"shape":"NextToken"}, "limit":{ "shape":"DescribeLimit", "documentation":"

Optionally specify the maximum number of delivery sources to return in the response.

" } } }, "DescribeDeliverySourcesResponse":{ "type":"structure", "members":{ "deliverySources":{ "shape":"DeliverySources", "documentation":"

An array of structures. Each structure contains information about one delivery source in the account.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeDestinationsRequest":{ "type":"structure", "members":{ "DestinationNamePrefix":{ "shape":"DestinationName", "documentation":"

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

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

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

" } } }, "DescribeDestinationsResponse":{ "type":"structure", "members":{ "destinations":{ "shape":"Destinations", "documentation":"

The destinations.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeExportTasksRequest":{ "type":"structure", "members":{ "taskId":{ "shape":"ExportTaskId", "documentation":"

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

" }, "statusCode":{ "shape":"ExportTaskStatusCode", "documentation":"

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

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

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

" } } }, "DescribeExportTasksResponse":{ "type":"structure", "members":{ "exportTasks":{ "shape":"ExportTasks", "documentation":"

The export tasks.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeLimit":{ "type":"integer", "max":50, "min":1 }, "DescribeLogGroupsRequest":{ "type":"structure", "members":{ "accountIdentifiers":{ "shape":"AccountIds", "documentation":"

When `includeLinkedAccounts` is set to `True`, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

" }, "logGroupNamePrefix":{ "shape":"LogGroupName", "documentation":"

The prefix to match.

`logGroupNamePrefix` and `logGroupNamePattern` are mutually exclusive. Only one of these parameters can be passed.

" }, "logGroupNamePattern":{ "shape":"LogGroupNamePattern", "documentation":"

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify `Foo`, log groups named `FooBar`, `aws/Foo`, and `GroupFoo` would match, but `foo`, `F/o/o` and `Froo` would not match.

If you specify `logGroupNamePattern` in your request, then only `arn`, `creationTime`, and `logGroupName` are included in the response.

`logGroupNamePattern` and `logGroupNamePrefix` are mutually exclusive. Only one of these parameters can be passed.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

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

" }, "includeLinkedAccounts":{ "shape":"IncludeLinkedAccounts", "documentation":"

If you are using a monitoring account, set this to `True` to have the operation return log groups in the accounts listed in `accountIdentifiers`.

If this parameter is set to `true` and `accountIdentifiers` contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

" }, "logGroupClass":{ "shape":"LogGroupClass", "documentation":"

Specifies the log group class for this log group. There are two classes:

- The `Standard` log class supports all CloudWatch Logs features.

- The `Infrequent Access` log class supports a subset of CloudWatch Logs features and incurs lower costs.

For details about the features supported by each class, see Log classes

" } } }, "DescribeLogGroupsResponse":{ "type":"structure", "members":{ "logGroups":{ "shape":"LogGroups", "documentation":"

The log groups.

If the `retentionInDays` value is not included for a log group, then that log group's events do not expire.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeLogStreamsRequest":{ "type":"structure", "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

You must include either `logGroupIdentifier` or `logGroupName`, but not both.

" }, "logGroupIdentifier":{ "shape":"LogGroupIdentifier", "documentation":"

Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either `logGroupIdentifier` or `logGroupName`, but not both.

" }, "logStreamNamePrefix":{ "shape":"LogStreamName", "documentation":"

The prefix to match.

If `orderBy` is `LastEventTime`, you cannot specify this parameter.

" }, "orderBy":{ "shape":"OrderBy", "documentation":"

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

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

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

" }, "descending":{ "shape":"Descending", "documentation":"

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

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

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

" } } }, "DescribeLogStreamsResponse":{ "type":"structure", "members":{ "logStreams":{ "shape":"LogStreams", "documentation":"

The log streams.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeMetricFiltersRequest":{ "type":"structure", "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterNamePrefix":{ "shape":"FilterName", "documentation":"

The prefix to match. CloudWatch Logs uses the value that you set here only if you also include the `logGroupName` parameter in your request.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

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

" }, "metricName":{ "shape":"MetricName", "documentation":"

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

" }, "metricNamespace":{ "shape":"MetricNamespace", "documentation":"

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

" } } }, "DescribeMetricFiltersResponse":{ "type":"structure", "members":{ "metricFilters":{ "shape":"MetricFilters", "documentation":"

The metric filters.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeQueriesMaxResults":{ "type":"integer", "max":1000, "min":1 }, "DescribeQueriesRequest":{ "type":"structure", "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

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

" }, "status":{ "shape":"QueryStatus", "documentation":"

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

" }, "maxResults":{ "shape":"DescribeQueriesMaxResults", "documentation":"

Limits the number of returned queries to the specified number.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeQueriesResponse":{ "type":"structure", "members":{ "queries":{ "shape":"QueryInfoList", "documentation":"

The list of queries that match the request.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeQueryDefinitionsRequest":{ "type":"structure", "members":{ "queryDefinitionNamePrefix":{ "shape":"QueryDefinitionName", "documentation":"

Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.

" }, "maxResults":{ "shape":"QueryListMaxResults", "documentation":"

Limits the number of returned query definitions to the specified number.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeQueryDefinitionsResponse":{ "type":"structure", "members":{ "queryDefinitions":{ "shape":"QueryDefinitionList", "documentation":"

The list of query definitions that match your request.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeResourcePoliciesRequest":{ "type":"structure", "members":{ "nextToken":{"shape":"NextToken"}, "limit":{ "shape":"DescribeLimit", "documentation":"

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

" } } }, "DescribeResourcePoliciesResponse":{ "type":"structure", "members":{ "resourcePolicies":{ "shape":"ResourcePolicies", "documentation":"

The resource policies that exist in this account.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeSubscriptionFiltersRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterNamePrefix":{ "shape":"FilterName", "documentation":"

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

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

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

" } } }, "DescribeSubscriptionFiltersResponse":{ "type":"structure", "members":{ "subscriptionFilters":{ "shape":"SubscriptionFilters", "documentation":"

The subscription filters.

" }, "nextToken":{"shape":"NextToken"} } }, "Description":{ "type":"string", "min":1 }, "Destination":{ "type":"structure", "members":{ "destinationName":{ "shape":"DestinationName", "documentation":"

The name of the destination.

" }, "targetArn":{ "shape":"TargetArn", "documentation":"

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

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

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

" }, "accessPolicy":{ "shape":"AccessPolicy", "documentation":"

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

" }, "arn":{ "shape":"Arn", "documentation":"

The ARN of this destination.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

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

" } }, "documentation":"

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

" }, "DestinationArn":{ "type":"string", "min":1 }, "DestinationName":{ "type":"string", "max":512, "min":1, "pattern":"[^:*]*" }, "Destinations":{ "type":"list", "member":{"shape":"Destination"} }, "DetectorName":{ "type":"string", "min":1 }, "Dimensions":{ "type":"map", "key":{"shape":"DimensionsKey"}, "value":{"shape":"DimensionsValue"} }, "DimensionsKey":{ "type":"string", "max":255 }, "DimensionsValue":{ "type":"string", "max":255 }, "DisassociateKmsKeyRequest":{ "type":"structure", "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

In your `DisassociateKmsKey` operation, you must specify either the `resourceIdentifier` parameter or the `logGroup` parameter, but you can't specify both.

" }, "resourceIdentifier":{ "shape":"ResourceIdentifier", "documentation":"

Specifies the target for this operation. You must specify one of the following:

- Specify the ARN of a log group to stop having CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log group. After you run this operation, CloudWatch Logs encrypts ingested log events with the default CloudWatch Logs method. The log group ARN must be in the following format. Replace REGION and ACCOUNT_ID with your Region and account ID.

  `arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME`

- Specify the following ARN to stop using this key to encrypt the results of future StartQuery operations in this account. Replace REGION and ACCOUNT_ID with your Region and account ID.

  `arn:aws:logs:REGION:ACCOUNT_ID:query-result:*`

In your `DisssociateKmsKey` operation, you must specify either the `resourceIdentifier` parameter or the `logGroup` parameter, but you can't specify both.

" } } }, "Distribution":{ "type":"string", "documentation":"

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

", "enum":[ "Random", "ByLogStream" ] }, "DynamicTokenPosition":{"type":"integer"}, "EncryptionKey":{ "type":"string", "max":256 }, "Enumerations":{ "type":"map", "key":{"shape":"TokenString"}, "value":{"shape":"TokenValue"} }, "EpochMillis":{ "type":"long", "min":0 }, "EvaluationFrequency":{ "type":"string", "enum":[ "ONE_MIN", "FIVE_MIN", "TEN_MIN", "FIFTEEN_MIN", "THIRTY_MIN", "ONE_HOUR" ] }, "EventId":{"type":"string"}, "EventMessage":{ "type":"string", "min":1 }, "EventNumber":{"type":"long"}, "EventsLimit":{ "type":"integer", "max":10000, "min":1 }, "ExportDestinationBucket":{ "type":"string", "max":512, "min":1 }, "ExportDestinationPrefix":{"type":"string"}, "ExportTask":{ "type":"structure", "members":{ "taskId":{ "shape":"ExportTaskId", "documentation":"

The ID of the export task.

" }, "taskName":{ "shape":"ExportTaskName", "documentation":"

The name of the export task.

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

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

" }, "from":{ "shape":"Timestamp", "documentation":"

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

" }, "to":{ "shape":"Timestamp", "documentation":"

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

" }, "destination":{ "shape":"ExportDestinationBucket", "documentation":"

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

" }, "destinationPrefix":{ "shape":"ExportDestinationPrefix", "documentation":"

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

" }, "status":{ "shape":"ExportTaskStatus", "documentation":"

The status of the export task.

" }, "executionInfo":{ "shape":"ExportTaskExecutionInfo", "documentation":"

Execution information about the export task.

" } }, "documentation":"

Represents an export task.

" }, "ExportTaskExecutionInfo":{ "type":"structure", "members":{ "creationTime":{ "shape":"Timestamp", "documentation":"

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

" }, "completionTime":{ "shape":"Timestamp", "documentation":"

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

" } }, "documentation":"

Represents the status of an export task.

" }, "ExportTaskId":{ "type":"string", "max":512, "min":1 }, "ExportTaskName":{ "type":"string", "max":512, "min":1 }, "ExportTaskStatus":{ "type":"structure", "members":{ "code":{ "shape":"ExportTaskStatusCode", "documentation":"

The status code of the export task.

" }, "message":{ "shape":"ExportTaskStatusMessage", "documentation":"

The status message related to the status code.

" } }, "documentation":"

Represents the status of an export task.

" }, "ExportTaskStatusCode":{ "type":"string", "enum":[ "CANCELLED", "COMPLETED", "FAILED", "PENDING", "PENDING_CANCEL", "RUNNING" ] }, "ExportTaskStatusMessage":{"type":"string"}, "ExportTasks":{ "type":"list", "member":{"shape":"ExportTask"} }, "ExtractedValues":{ "type":"map", "key":{"shape":"Token"}, "value":{"shape":"Value"} }, "Field":{"type":"string"}, "FilterCount":{"type":"integer"}, "FilterLogEventsRequest":{ "type":"structure", "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group to search.

You must include either `logGroupIdentifier` or `logGroupName`, but not both.

" }, "logGroupIdentifier":{ "shape":"LogGroupIdentifier", "documentation":"

Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either `logGroupIdentifier` or `logGroupName`, but not both.

" }, "logStreamNames":{ "shape":"InputLogStreamNames", "documentation":"

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

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

" }, "logStreamNamePrefix":{ "shape":"LogStreamName", "documentation":"

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

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

" }, "startTime":{ "shape":"Timestamp", "documentation":"

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

" }, "endTime":{ "shape":"Timestamp", "documentation":"

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

" }, "filterPattern":{ "shape":"FilterPattern", "documentation":"

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

If not provided, all the events are matched.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" }, "limit":{ "shape":"EventsLimit", "documentation":"

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

" }, "interleaved":{ "shape":"Interleaved", "documentation":"

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

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

", "deprecated":true, "deprecatedMessage":"Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group." }, "unmask":{ "shape":"Unmask", "documentation":"

Specify `true` to display the log event fields with all sensitive data unmasked and visible. The default is `false`.

To use this operation with this parameter, you must be signed into an account with the `logs:Unmask` permission.

" } } }, "FilterLogEventsResponse":{ "type":"structure", "members":{ "events":{ "shape":"FilteredLogEvents", "documentation":"

The matched events.

" }, "searchedLogStreams":{ "shape":"SearchedLogStreams", "documentation":"

Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.

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

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "FilterName":{ "type":"string", "max":512, "min":1, "pattern":"[^:*]*" }, "FilterPattern":{ "type":"string", "documentation":"

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

", "max":1024, "min":0 }, "FilteredLogEvent":{ "type":"structure", "members":{ "logStreamName":{ "shape":"LogStreamName", "documentation":"

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

" }, "timestamp":{ "shape":"Timestamp", "documentation":"

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

" }, "message":{ "shape":"EventMessage", "documentation":"

The data contained in the log event.

" }, "ingestionTime":{ "shape":"Timestamp", "documentation":"

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

" }, "eventId":{ "shape":"EventId", "documentation":"

The ID of the event.

" } }, "documentation":"

Represents a matched event.

" }, "FilteredLogEvents":{ "type":"list", "member":{"shape":"FilteredLogEvent"} }, "ForceUpdate":{"type":"boolean"}, "GetDataProtectionPolicyRequest":{ "type":"structure", "required":["logGroupIdentifier"], "members":{ "logGroupIdentifier":{ "shape":"LogGroupIdentifier", "documentation":"

The name or ARN of the log group that contains the data protection policy that you want to see.

" } } }, "GetDataProtectionPolicyResponse":{ "type":"structure", "members":{ "logGroupIdentifier":{ "shape":"LogGroupIdentifier", "documentation":"

The log group name or ARN that you specified in your request.

" }, "policyDocument":{ "shape":"DataProtectionPolicyDocument", "documentation":"

The data protection policy document for this log group.

" }, "lastUpdatedTime":{ "shape":"Timestamp", "documentation":"

The date and time that this policy was most recently updated.

" } } }, "GetDeliveryDestinationPolicyRequest":{ "type":"structure", "required":["deliveryDestinationName"], "members":{ "deliveryDestinationName":{ "shape":"DeliveryDestinationName", "documentation":"

The name of the delivery destination that you want to retrieve the policy of.

" } } }, "GetDeliveryDestinationPolicyResponse":{ "type":"structure", "members":{ "policy":{ "shape":"Policy", "documentation":"

The IAM policy for this delivery destination.

" } } }, "GetDeliveryDestinationRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"DeliveryDestinationName", "documentation":"

The name of the delivery destination that you want to retrieve.

" } } }, "GetDeliveryDestinationResponse":{ "type":"structure", "members":{ "deliveryDestination":{ "shape":"DeliveryDestination", "documentation":"

A structure containing information about the delivery destination.

" } } }, "GetDeliveryRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"DeliveryId", "documentation":"

The ID of the delivery that you want to retrieve.

" } } }, "GetDeliveryResponse":{ "type":"structure", "members":{ "delivery":{ "shape":"Delivery", "documentation":"

A structure that contains information about the delivery.

" } } }, "GetDeliverySourceRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"DeliverySourceName", "documentation":"

The name of the delivery source that you want to retrieve.

" } } }, "GetDeliverySourceResponse":{ "type":"structure", "members":{ "deliverySource":{ "shape":"DeliverySource", "documentation":"

A structure containing information about the delivery source.

" } } }, "GetLogAnomalyDetectorRequest":{ "type":"structure", "required":["anomalyDetectorArn"], "members":{ "anomalyDetectorArn":{ "shape":"AnomalyDetectorArn", "documentation":"

The ARN of the anomaly detector to retrieve information about. You can find the ARNs of log anomaly detectors in your account by using the ListLogAnomalyDetectors operation.

" } } }, "GetLogAnomalyDetectorResponse":{ "type":"structure", "members":{ "detectorName":{ "shape":"DetectorName", "documentation":"

The name of the log anomaly detector

" }, "logGroupArnList":{ "shape":"LogGroupArnList", "documentation":"

An array of structures, where each structure contains the ARN of a log group associated with this anomaly detector.

" }, "evaluationFrequency":{ "shape":"EvaluationFrequency", "documentation":"

Specifies how often the anomaly detector runs and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then setting `evaluationFrequency` to `FIFTEEN_MIN` might be appropriate.

" }, "filterPattern":{"shape":"FilterPattern"}, "anomalyDetectorStatus":{ "shape":"AnomalyDetectorStatus", "documentation":"

Specifies whether the anomaly detector is currently active. To change its status, use the `enabled` parameter in the UpdateLogAnomalyDetector operation.

" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

The ID of the KMS key assigned to this anomaly detector, if any.

" }, "creationTimeStamp":{ "shape":"EpochMillis", "documentation":"

The date and time when this anomaly detector was created.

" }, "lastModifiedTimeStamp":{ "shape":"EpochMillis", "documentation":"

The date and time when this anomaly detector was most recently modified.

" }, "anomalyVisibilityTime":{ "shape":"AnomalyVisibilityTime", "documentation":"

The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined and the anomaly detector model will treat new occurrences of similar event as normal.

" } } }, "GetLogEventsRequest":{ "type":"structure", "required":["logStreamName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

You must include either `logGroupIdentifier` or `logGroupName`, but not both.

" }, "logGroupIdentifier":{ "shape":"LogGroupIdentifier", "documentation":"

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either `logGroupIdentifier` or `logGroupName`, but not both.

" }, "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

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

" }, "endTime":{ "shape":"Timestamp", "documentation":"

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

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" }, "limit":{ "shape":"EventsLimit", "documentation":"

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

" }, "startFromHead":{ "shape":"StartFromHead", "documentation":"

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

If you are using a previous `nextForwardToken` value as the `nextToken` in this operation, you must specify `true` for `startFromHead`.

" }, "unmask":{ "shape":"Unmask", "documentation":"

Specify `true` to display the log event fields with all sensitive data unmasked and visible. The default is `false`.

To use this operation with this parameter, you must be signed into an account with the `logs:Unmask` permission.

" } } }, "GetLogEventsResponse":{ "type":"structure", "members":{ "events":{ "shape":"OutputLogEvents", "documentation":"

The events.

" }, "nextForwardToken":{ "shape":"NextToken", "documentation":"

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

" }, "nextBackwardToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "GetLogGroupFieldsRequest":{ "type":"structure", "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group to search.

You must include either `logGroupIdentifier` or `logGroupName`, but not both.

" }, "time":{ "shape":"Timestamp", "documentation":"

The time to set as the center of the query. If you specify `time`, the 8 minutes before and 8 minutes after this time are searched. If you omit `time`, the most recent 15 minutes up to the current time are searched.

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

" }, "logGroupIdentifier":{ "shape":"LogGroupIdentifier", "documentation":"

Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.

You must include either `logGroupIdentifier` or `logGroupName`, but not both.

" } } }, "GetLogGroupFieldsResponse":{ "type":"structure", "members":{ "logGroupFields":{ "shape":"LogGroupFieldList", "documentation":"

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

" } } }, "GetLogRecordRequest":{ "type":"structure", "required":["logRecordPointer"], "members":{ "logRecordPointer":{ "shape":"LogRecordPointer", "documentation":"

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

" }, "unmask":{ "shape":"Unmask", "documentation":"

Specify `true` to display the log event fields with all sensitive data unmasked and visible. The default is `false`.

To use this operation with this parameter, you must be signed into an account with the `logs:Unmask` permission.

" } } }, "GetLogRecordResponse":{ "type":"structure", "members":{ "logRecord":{ "shape":"LogRecord", "documentation":"

The requested log event, as a JSON string.

" } } }, "GetQueryResultsRequest":{ "type":"structure", "required":["queryId"], "members":{ "queryId":{ "shape":"QueryId", "documentation":"

The ID number of the query.

" } } }, "GetQueryResultsResponse":{ "type":"structure", "members":{ "results":{ "shape":"QueryResults", "documentation":"

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

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

" }, "statistics":{ "shape":"QueryStatistics", "documentation":"

Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.

" }, "status":{ "shape":"QueryStatus", "documentation":"

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

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

" }, "encryptionKey":{ "shape":"EncryptionKey", "documentation":"

If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when StartQuery stores them.

" } } }, "Histogram":{ "type":"map", "key":{"shape":"Time"}, "value":{"shape":"Count"} }, "IncludeLinkedAccounts":{"type":"boolean"}, "InheritedProperties":{ "type":"list", "member":{"shape":"InheritedProperty"} }, "InheritedProperty":{ "type":"string", "enum":["ACCOUNT_DATA_PROTECTION"] }, "InputLogEvent":{ "type":"structure", "required":[ "timestamp", "message" ], "members":{ "timestamp":{ "shape":"Timestamp", "documentation":"

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

" }, "message":{ "shape":"EventMessage", "documentation":"

The raw event message. Each log event can be no larger than 256 KB.

" } }, "documentation":"

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

" }, "InputLogEvents":{ "type":"list", "member":{"shape":"InputLogEvent"}, "max":10000, "min":1 }, "InputLogStreamNames":{ "type":"list", "member":{"shape":"LogStreamName"}, "max":100, "min":1 }, "Integer":{"type":"integer"}, "Interleaved":{"type":"boolean"}, "InvalidOperationException":{ "type":"structure", "members":{ }, "documentation":"

The operation is not valid on the specified resource.

", "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ }, "documentation":"

A parameter is specified incorrectly.

", "exception":true }, "InvalidSequenceTokenException":{ "type":"structure", "members":{ "expectedSequenceToken":{"shape":"SequenceToken"} }, "documentation":"

The sequence token is not valid. You can get the correct sequence token in the `expectedSequenceToken` field in the `InvalidSequenceTokenException` message.

`PutLogEvents` actions are now always accepted and never return `InvalidSequenceTokenException` regardless of receiving an invalid sequence token.

", "exception":true }, "IsSampled":{"type":"boolean"}, "KmsKeyId":{ "type":"string", "max":256 }, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

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

", "exception":true }, "ListAnomaliesLimit":{ "type":"integer", "max":50, "min":1 }, "ListAnomaliesRequest":{ "type":"structure", "members":{ "anomalyDetectorArn":{ "shape":"AnomalyDetectorArn", "documentation":"

Use this to optionally limit the results to only the anomalies found by a certain anomaly detector.

" }, "suppressionState":{ "shape":"SuppressionState", "documentation":"

You can specify this parameter if you want to the operation to return only anomalies that are currently either suppressed or unsuppressed.

" }, "limit":{ "shape":"ListAnomaliesLimit", "documentation":"

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

" }, "nextToken":{"shape":"NextToken"} } }, "ListAnomaliesResponse":{ "type":"structure", "members":{ "anomalies":{ "shape":"Anomalies", "documentation":"

An array of structures, where each structure contains information about one anomaly that a log anomaly detector has found.

" }, "nextToken":{"shape":"NextToken"} } }, "ListLogAnomalyDetectorsLimit":{ "type":"integer", "max":50, "min":1 }, "ListLogAnomalyDetectorsRequest":{ "type":"structure", "members":{ "filterLogGroupArn":{ "shape":"LogGroupArn", "documentation":"

Use this to optionally filter the results to only include anomaly detectors that are associated with the specified log group.

" }, "limit":{ "shape":"ListLogAnomalyDetectorsLimit", "documentation":"

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

" }, "nextToken":{"shape":"NextToken"} } }, "ListLogAnomalyDetectorsResponse":{ "type":"structure", "members":{ "anomalyDetectors":{ "shape":"AnomalyDetectors", "documentation":"

An array of structures, where each structure in the array contains information about one anomaly detector.

" }, "nextToken":{"shape":"NextToken"} } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the resource that you want to view tags for.

The ARN format of a log group is `arn:aws:logs:Region:account-id:log-group:log-group-name`

The ARN format of a destination is `arn:aws:logs:Region:account-id:destination:destination-name`

For more information about ARN format, see CloudWatch Logs resources and operations.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"Tags", "documentation":"

The list of tags associated with the requested resource.>

" } } }, "ListTagsLogGroupRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" } }, "deprecated":true, "deprecatedMessage":"Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" }, "ListTagsLogGroupResponse":{ "type":"structure", "members":{ "tags":{ "shape":"Tags", "documentation":"

The tags for the log group.

" } }, "deprecated":true, "deprecatedMessage":"Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" }, "LiveTailSessionLogEvent":{ "type":"structure", "members":{ "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream that ingested this log event.

" }, "logGroupIdentifier":{ "shape":"LogGroupIdentifier", "documentation":"

The name or ARN of the log group that ingested this log event.

" }, "message":{ "shape":"EventMessage", "documentation":"

The log event message text.

" }, "timestamp":{ "shape":"Timestamp", "documentation":"

The timestamp specifying when this log event was created.

" }, "ingestionTime":{ "shape":"Timestamp", "documentation":"

The timestamp specifying when this log event was ingested into the log group.

" } }, "documentation":"

This object contains the information for one log event returned in a Live Tail stream.

" }, "LiveTailSessionMetadata":{ "type":"structure", "members":{ "sampled":{ "shape":"IsSampled", "documentation":"

If this is `true`, then more than 500 log events matched the request for this update, and the `sessionResults` includes a sample of 500 of those events.

If this is `false`, then 500 or fewer log events matched the request for this update, so no sampling was necessary. In this case, the `sessionResults` array includes all log events that matched your request during this time.

" } }, "documentation":"

This object contains the metadata for one `LiveTailSessionUpdate` structure. It indicates whether that update includes only a sample of 500 log events out of a larger number of ingested log events, or if it contains all of the matching log events ingested during that second of time.

" }, "LiveTailSessionResults":{ "type":"list", "member":{"shape":"LiveTailSessionLogEvent"} }, "LiveTailSessionStart":{ "type":"structure", "members":{ "requestId":{ "shape":"RequestId", "documentation":"

The unique ID generated by CloudWatch Logs to identify this Live Tail session request.

" }, "sessionId":{ "shape":"SessionId", "documentation":"

The unique ID generated by CloudWatch Logs to identify this Live Tail session.

" }, "logGroupIdentifiers":{ "shape":"StartLiveTailLogGroupIdentifiers", "documentation":"

An array of the names and ARNs of the log groups included in this Live Tail session.

" }, "logStreamNames":{ "shape":"InputLogStreamNames", "documentation":"

If your StartLiveTail operation request included a `logStreamNames` parameter that filtered the session to only include certain log streams, these streams are listed here.

" }, "logStreamNamePrefixes":{ "shape":"InputLogStreamNames", "documentation":"

If your StartLiveTail operation request included a `logStreamNamePrefixes` parameter that filtered the session to only include log streams that have names that start with certain prefixes, these prefixes are listed here.

" }, "logEventFilterPattern":{ "shape":"FilterPattern", "documentation":"

An optional pattern to filter the results to include only log events that match the pattern. For example, a filter pattern of `error 404` displays only log events that include both `error` and `404`.

For more information about filter pattern syntax, see Filter and Pattern Syntax.

" } }, "documentation":"

This object contains information about this Live Tail session, including the log groups included and the log stream filters, if any.

", "event":true }, "LiveTailSessionUpdate":{ "type":"structure", "members":{ "sessionMetadata":{ "shape":"LiveTailSessionMetadata", "documentation":"

This object contains the session metadata for a Live Tail session.

" }, "sessionResults":{ "shape":"LiveTailSessionResults", "documentation":"

An array, where each member of the array includes the information for one log event in the Live Tail session.

A `sessionResults` array can include as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500 log events to be included in each `sessionUpdate` structure.

" } }, "documentation":"

This object contains the log events and metadata for a Live Tail session.

", "event":true }, "LogEvent":{ "type":"string", "min":1 }, "LogEventIndex":{"type":"integer"}, "LogGroup":{ "type":"structure", "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

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

" }, "retentionInDays":{"shape":"Days"}, "metricFilterCount":{ "shape":"FilterCount", "documentation":"

The number of metric filters.

" }, "arn":{ "shape":"Arn", "documentation":"

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

" }, "storedBytes":{ "shape":"StoredBytes", "documentation":"

The number of bytes stored.

" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

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

" }, "dataProtectionStatus":{ "shape":"DataProtectionStatus", "documentation":"

Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.

" }, "inheritedProperties":{ "shape":"InheritedProperties", "documentation":"

Displays all the properties that this log group has inherited from account-level settings.

" }, "logGroupClass":{ "shape":"LogGroupClass", "documentation":"

This specifies the log group class for this log group. There are two classes:

- The `Standard` log class supports all CloudWatch Logs features.

- The `Infrequent Access` log class supports a subset of CloudWatch Logs features and incurs lower costs.

For details about the features supported by each class, see Log classes

" } }, "documentation":"

Represents a log group.

" }, "LogGroupArn":{ "type":"string", "max":2048, "min":1, "pattern":"[\\w#+=/:,.@-]*" }, "LogGroupArnList":{ "type":"list", "member":{"shape":"LogGroupArn"} }, "LogGroupClass":{ "type":"string", "enum":[ "STANDARD", "INFREQUENT_ACCESS" ] }, "LogGroupField":{ "type":"structure", "members":{ "name":{ "shape":"Field", "documentation":"

The name of a log field.

" }, "percent":{ "shape":"Percentage", "documentation":"

The percentage of log events queried that contained the field.

" } }, "documentation":"

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

" }, "LogGroupFieldList":{ "type":"list", "member":{"shape":"LogGroupField"} }, "LogGroupIdentifier":{ "type":"string", "max":2048, "min":1, "pattern":"[\\w#+=/:,.@-]*" }, "LogGroupIdentifiers":{ "type":"list", "member":{"shape":"LogGroupIdentifier"} }, "LogGroupName":{ "type":"string", "max":512, "min":1, "pattern":"[\\.\\-_/#A-Za-z0-9]+" }, "LogGroupNamePattern":{ "type":"string", "max":512, "min":0, "pattern":"[\\.\\-_/#A-Za-z0-9]*" }, "LogGroupNames":{ "type":"list", "member":{"shape":"LogGroupName"} }, "LogGroups":{ "type":"list", "member":{"shape":"LogGroup"} }, "LogRecord":{ "type":"map", "key":{"shape":"Field"}, "value":{"shape":"Value"} }, "LogRecordPointer":{"type":"string"}, "LogSamples":{ "type":"list", "member":{"shape":"LogEvent"} }, "LogStream":{ "type":"structure", "members":{ "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

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

" }, "firstEventTimestamp":{ "shape":"Timestamp", "documentation":"

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

" }, "lastEventTimestamp":{ "shape":"Timestamp", "documentation":"

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

" }, "lastIngestionTime":{ "shape":"Timestamp", "documentation":"

The ingestion time, expressed as the number of milliseconds after `Jan 1, 1970 00:00:00 UTC` The `lastIngestionTime` value updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but in rare situations might take longer.

" }, "uploadSequenceToken":{ "shape":"SequenceToken", "documentation":"

The sequence token.

The sequence token is now ignored in `PutLogEvents` actions. `PutLogEvents` actions are always accepted regardless of receiving an invalid sequence token. You don't need to obtain `uploadSequenceToken` to use a `PutLogEvents` action.

" }, "arn":{ "shape":"Arn", "documentation":"

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

" }, "storedBytes":{ "shape":"StoredBytes", "documentation":"

The number of bytes stored.

Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The `storedBytes` parameter for log groups is not affected.

", "deprecated":true, "deprecatedMessage":"Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected." } }, "documentation":"

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

" }, "LogStreamName":{ "type":"string", "max":512, "min":1, "pattern":"[^:*]*" }, "LogStreamSearchedCompletely":{"type":"boolean"}, "LogStreams":{ "type":"list", "member":{"shape":"LogStream"} }, "LogType":{ "type":"string", "max":255, "min":1, "pattern":"[\\w]*" }, "MalformedQueryException":{ "type":"structure", "members":{ "queryCompileError":{"shape":"QueryCompileError"} }, "documentation":"

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

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

", "exception":true }, "Message":{"type":"string"}, "MetricFilter":{ "type":"structure", "members":{ "filterName":{ "shape":"FilterName", "documentation":"

The name of the metric filter.

" }, "filterPattern":{"shape":"FilterPattern"}, "metricTransformations":{ "shape":"MetricTransformations", "documentation":"

The metric transformations.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

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

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" } }, "documentation":"

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

" }, "MetricFilterMatchRecord":{ "type":"structure", "members":{ "eventNumber":{ "shape":"EventNumber", "documentation":"

The event number.

" }, "eventMessage":{ "shape":"EventMessage", "documentation":"

The raw event data.

" }, "extractedValues":{ "shape":"ExtractedValues", "documentation":"

The values extracted from the event data by the filter.

" } }, "documentation":"

Represents a matched event.

" }, "MetricFilterMatches":{ "type":"list", "member":{"shape":"MetricFilterMatchRecord"} }, "MetricFilters":{ "type":"list", "member":{"shape":"MetricFilter"} }, "MetricName":{ "type":"string", "documentation":"

The name of the CloudWatch metric to which the monitored log information should be published. For example, you might publish to a metric named ErrorCount.

", "max":255, "pattern":"[^:*$]*" }, "MetricNamespace":{ "type":"string", "max":255, "pattern":"[^:*$]*" }, "MetricTransformation":{ "type":"structure", "required":[ "metricName", "metricNamespace", "metricValue" ], "members":{ "metricName":{ "shape":"MetricName", "documentation":"

The name of the CloudWatch metric.

" }, "metricNamespace":{ "shape":"MetricNamespace", "documentation":"

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

" }, "metricValue":{ "shape":"MetricValue", "documentation":"

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

" }, "defaultValue":{ "shape":"DefaultValue", "documentation":"

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

" }, "dimensions":{ "shape":"Dimensions", "documentation":"

The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as `IPAddress` or `requestID` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

" }, "unit":{ "shape":"StandardUnit", "documentation":"

The unit to assign to the metric. If you omit this, the unit is set as `None`.

" } }, "documentation":"

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

" }, "MetricTransformations":{ "type":"list", "member":{"shape":"MetricTransformation"}, "max":1, "min":1 }, "MetricValue":{ "type":"string", "documentation":"

The value to publish to the CloudWatch metric. For example, if you're counting the occurrences of a term like `Error`, the value is `1` for each occurrence. If you're counting the bytes transferred, the value is the value in the log event.

", "max":100 }, "NextToken":{ "type":"string", "documentation":"

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

", "min":1 }, "OperationAbortedException":{ "type":"structure", "members":{ }, "documentation":"

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

", "exception":true }, "OrderBy":{ "type":"string", "enum":[ "LogStreamName", "LastEventTime" ] }, "OutputFormat":{ "type":"string", "enum":[ "json", "plain", "w3c", "raw", "parquet" ] }, "OutputLogEvent":{ "type":"structure", "members":{ "timestamp":{ "shape":"Timestamp", "documentation":"

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

" }, "message":{ "shape":"EventMessage", "documentation":"

The data contained in the log event.

" }, "ingestionTime":{ "shape":"Timestamp", "documentation":"

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

" } }, "documentation":"

Represents a log event.

" }, "OutputLogEvents":{ "type":"list", "member":{"shape":"OutputLogEvent"} }, "PatternId":{ "type":"string", "max":32, "min":32 }, "PatternRegex":{ "type":"string", "min":1 }, "PatternString":{ "type":"string", "min":1 }, "PatternToken":{ "type":"structure", "members":{ "dynamicTokenPosition":{ "shape":"DynamicTokenPosition", "documentation":"

For a dynamic token, this indicates where in the pattern that this token appears, related to other dynamic tokens. The dynamic token that appears first has a value of `1`, the one that appears second is `2`, and so on.

" }, "isDynamic":{ "shape":"Boolean", "documentation":"

Specifies whether this is a dynamic token.

" }, "tokenString":{ "shape":"TokenString", "documentation":"

The string represented by this token. If this is a dynamic token, the value will be `<*>`

" }, "enumerations":{ "shape":"Enumerations", "documentation":"

Contains the values found for a dynamic token, and the number of times each value was found.

" } }, "documentation":"

A tructures that contains information about one pattern token related to an anomaly.

For more information about patterns and tokens, see CreateLogAnomalyDetector.

" }, "PatternTokens":{ "type":"list", "member":{"shape":"PatternToken"} }, "Percentage":{ "type":"integer", "max":100, "min":0 }, "Policy":{ "type":"structure", "members":{ "deliveryDestinationPolicy":{ "shape":"DeliveryDestinationPolicy", "documentation":"

The contents of the delivery destination policy.

" } }, "documentation":"

A structure that contains information about one delivery destination policy.

" }, "PolicyDocument":{ "type":"string", "max":5120, "min":1 }, "PolicyName":{"type":"string"}, "PolicyType":{ "type":"string", "enum":[ "DATA_PROTECTION_POLICY", "SUBSCRIPTION_FILTER_POLICY" ] }, "Priority":{ "type":"string", "min":1 }, "PutAccountPolicyRequest":{ "type":"structure", "required":[ "policyName", "policyDocument", "policyType" ], "members":{ "policyName":{ "shape":"PolicyName", "documentation":"

A name for the policy. This must be unique within the account.

" }, "policyDocument":{ "shape":"AccountPolicyDocument", "documentation":"

Specify the policy, in JSON.

Data protection policy

A data protection policy must include two JSON blocks:

- The first block must include both a `DataIdentifer` array and an `Operation` property with an `Audit` action. The `DataIdentifer` array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask.

  The `Operation` property with an `Audit` action is required to find the sensitive data terms. This `Audit` action must contain a `FindingsDestination` object. You can optionally use that `FindingsDestination` object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, they must already exist.

- The second block must include both a `DataIdentifer` array and an `Operation` property with an `Deidentify` action. The `DataIdentifer` array must exactly match the `DataIdentifer` array in the first block of the policy.

  The `Operation` property with the `Deidentify` action is what actually masks the data, and it must contain the `\"MaskConfig\": {}` object. The `\"MaskConfig\": {}` object must be empty.

For an example data protection policy, see the Examples section on this page.

The contents of the two `DataIdentifer` arrays must match exactly.

In addition to the two JSON blocks, the `policyDocument` can also include `Name`, `Description`, and `Version` fields. The `Name` is different than the operation's `policyName` parameter, and is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.

The JSON specified in `policyDocument` can be up to 30,720 characters long.

Subscription filter policy

A subscription filter policy can include the following attributes in a JSON block:

- DestinationArn The ARN of the destination to deliver log events to. Supported destinations are:

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

  - An Kinesis Data 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 Kinesis Data Firehose are supported as logical destinations.

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

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

- DistributionThe method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to `Random` for a more even distribution. This property is only applicable when the destination is an Kinesis Data Streams data stream.

" }, "policyType":{ "shape":"PolicyType", "documentation":"

The type of policy that you're creating or updating.

" }, "scope":{ "shape":"Scope", "documentation":"

Currently the only valid value for this parameter is `ALL`, which specifies that the data protection policy applies to all log groups in the account. If you omit this parameter, the default of `ALL` is used.

" }, "selectionCriteria":{ "shape":"SelectionCriteria", "documentation":"

Use this parameter to apply the subscription filter policy to a subset of log groups in the account. Currently, the only supported filter is `LogGroupName NOT IN []`. The `selectionCriteria` string can be up to 25KB in length. The length is determined by using its UTF-8 bytes.

Using the `selectionCriteria` parameter is useful to help prevent infinite loops. For more information, see Log recursion prevention.

Specifing `selectionCriteria` is valid only when you specify `SUBSCRIPTION_FILTER_POLICY` for `policyType`.

" } } }, "PutAccountPolicyResponse":{ "type":"structure", "members":{ "accountPolicy":{ "shape":"AccountPolicy", "documentation":"

The account policy that you created.

" } } }, "PutDataProtectionPolicyRequest":{ "type":"structure", "required":[ "logGroupIdentifier", "policyDocument" ], "members":{ "logGroupIdentifier":{ "shape":"LogGroupIdentifier", "documentation":"

Specify either the log group name or log group ARN.

" }, "policyDocument":{ "shape":"DataProtectionPolicyDocument", "documentation":"

Specify the data protection policy, in JSON.

This policy must include two JSON blocks:

- The first block must include both a `DataIdentifer` array and an `Operation` property with an `Audit` action. The `DataIdentifer` array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask.

  The `Operation` property with an `Audit` action is required to find the sensitive data terms. This `Audit` action must contain a `FindingsDestination` object. You can optionally use that `FindingsDestination` object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, they must already exist.

- The second block must include both a `DataIdentifer` array and an `Operation` property with an `Deidentify` action. The `DataIdentifer` array must exactly match the `DataIdentifer` array in the first block of the policy.

  The `Operation` property with the `Deidentify` action is what actually masks the data, and it must contain the `\"MaskConfig\": {}` object. The `\"MaskConfig\": {}` object must be empty.

For an example data protection policy, see the Examples section on this page.

The contents of the two `DataIdentifer` arrays must match exactly.

In addition to the two JSON blocks, the `policyDocument` can also include `Name`, `Description`, and `Version` fields. The `Name` is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.

The JSON specified in `policyDocument` can be up to 30,720 characters.

" } } }, "PutDataProtectionPolicyResponse":{ "type":"structure", "members":{ "logGroupIdentifier":{ "shape":"LogGroupIdentifier", "documentation":"

The log group name or ARN that you specified in your request.

" }, "policyDocument":{ "shape":"DataProtectionPolicyDocument", "documentation":"

The data protection policy used for this log group.

" }, "lastUpdatedTime":{ "shape":"Timestamp", "documentation":"

The date and time that this policy was most recently updated.

" } } }, "PutDeliveryDestinationPolicyRequest":{ "type":"structure", "required":[ "deliveryDestinationName", "deliveryDestinationPolicy" ], "members":{ "deliveryDestinationName":{ "shape":"DeliveryDestinationName", "documentation":"

The name of the delivery destination to assign this policy to.

" }, "deliveryDestinationPolicy":{ "shape":"DeliveryDestinationPolicy", "documentation":"

The contents of the policy.

" } } }, "PutDeliveryDestinationPolicyResponse":{ "type":"structure", "members":{ "policy":{ "shape":"Policy", "documentation":"

The contents of the policy that you just created.

" } } }, "PutDeliveryDestinationRequest":{ "type":"structure", "required":[ "name", "deliveryDestinationConfiguration" ], "members":{ "name":{ "shape":"DeliveryDestinationName", "documentation":"

A name for this delivery destination. This name must be unique for all delivery destinations in your account.

" }, "outputFormat":{ "shape":"OutputFormat", "documentation":"

The format for the logs that this delivery destination will receive.

" }, "deliveryDestinationConfiguration":{ "shape":"DeliveryDestinationConfiguration", "documentation":"

A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

" }, "tags":{ "shape":"Tags", "documentation":"

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources

" } } }, "PutDeliveryDestinationResponse":{ "type":"structure", "members":{ "deliveryDestination":{ "shape":"DeliveryDestination", "documentation":"

A structure containing information about the delivery destination that you just created or updated.

" } } }, "PutDeliverySourceRequest":{ "type":"structure", "required":[ "name", "resourceArn", "logType" ], "members":{ "name":{ "shape":"DeliverySourceName", "documentation":"

A name for this delivery source. This name must be unique for all delivery sources in your account.

" }, "resourceArn":{ "shape":"Arn", "documentation":"

The ARN of the Amazon Web Services resource that is generating and sending logs. For example, `arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234`

" }, "logType":{ "shape":"LogType", "documentation":"

Defines the type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.

" }, "tags":{ "shape":"Tags", "documentation":"

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources

" } } }, "PutDeliverySourceResponse":{ "type":"structure", "members":{ "deliverySource":{ "shape":"DeliverySource", "documentation":"

A structure containing information about the delivery source that was just created or updated.

" } } }, "PutDestinationPolicyRequest":{ "type":"structure", "required":[ "destinationName", "accessPolicy" ], "members":{ "destinationName":{ "shape":"DestinationName", "documentation":"

A name for an existing destination.

" }, "accessPolicy":{ "shape":"AccessPolicy", "documentation":"

An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes.

" }, "forceUpdate":{ "shape":"ForceUpdate", "documentation":"

Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual Amazon Web Services accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying `true` for `forceUpdate`, you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription

If you omit this parameter, the default of `false` is used.

" } } }, "PutDestinationRequest":{ "type":"structure", "required":[ "destinationName", "targetArn", "roleArn" ], "members":{ "destinationName":{ "shape":"DestinationName", "documentation":"

A name for the destination.

" }, "targetArn":{ "shape":"TargetArn", "documentation":"

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

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

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

" }, "tags":{ "shape":"Tags", "documentation":"

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources

" } } }, "PutDestinationResponse":{ "type":"structure", "members":{ "destination":{ "shape":"Destination", "documentation":"

The destination.

" } } }, "PutLogEventsRequest":{ "type":"structure", "required":[ "logGroupName", "logStreamName", "logEvents" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" }, "logEvents":{ "shape":"InputLogEvents", "documentation":"

The log events.

" }, "sequenceToken":{ "shape":"SequenceToken", "documentation":"

The sequence token obtained from the response of the previous `PutLogEvents` call.

The `sequenceToken` parameter is now ignored in `PutLogEvents` actions. `PutLogEvents` actions are now accepted and never return `InvalidSequenceTokenException` or `DataAlreadyAcceptedException` even if the sequence token is not valid.

" } } }, "PutLogEventsResponse":{ "type":"structure", "members":{ "nextSequenceToken":{ "shape":"SequenceToken", "documentation":"

The next sequence token.

This field has been deprecated.

The sequence token is now ignored in `PutLogEvents` actions. `PutLogEvents` actions are always accepted even if the sequence token is not valid. You can use parallel `PutLogEvents` actions on the same log stream and you do not need to wait for the response of a previous `PutLogEvents` action to obtain the `nextSequenceToken` value.

" }, "rejectedLogEventsInfo":{ "shape":"RejectedLogEventsInfo", "documentation":"

The rejected events.

" } } }, "PutMetricFilterRequest":{ "type":"structure", "required":[ "logGroupName", "filterName", "filterPattern", "metricTransformations" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterName":{ "shape":"FilterName", "documentation":"

A name for the metric filter.

" }, "filterPattern":{ "shape":"FilterPattern", "documentation":"

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

" }, "metricTransformations":{ "shape":"MetricTransformations", "documentation":"

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

" } } }, "PutQueryDefinitionRequest":{ "type":"structure", "required":[ "name", "queryString" ], "members":{ "name":{ "shape":"QueryDefinitionName", "documentation":"

A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the `queryDefinitionNamePrefix` parameter of DescribeQueryDefinitions.

" }, "queryDefinitionId":{ "shape":"QueryId", "documentation":"

If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

" }, "logGroupNames":{ "shape":"LogGroupNames", "documentation":"

Use this parameter to include specific log groups as part of your query definition.

If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

" }, "queryString":{ "shape":"QueryDefinitionString", "documentation":"

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

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.

", "idempotencyToken":true } } }, "PutQueryDefinitionResponse":{ "type":"structure", "members":{ "queryDefinitionId":{ "shape":"QueryId", "documentation":"

The ID of the query definition.

" } } }, "PutResourcePolicyRequest":{ "type":"structure", "members":{ "policyName":{ "shape":"PolicyName", "documentation":"

Name of the new policy. This parameter is required.

" }, "policyDocument":{ "shape":"PolicyDocument", "documentation":"

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

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

CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.

In the example resource policy, you would replace the value of `SourceArn` with the resource making the call from Route 53 to CloudWatch Logs. You would also replace the value of `SourceAccount` with the Amazon Web Services account ID making that call.

`{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Sid\": \"Route53LogsToCloudWatchLogs\", \"Effect\": \"Allow\", \"Principal\": { \"Service\": [ \"route53.amazonaws.com\" ] }, \"Action\": \"logs:PutLogEvents\", \"Resource\": \"logArn\", \"Condition\": { \"ArnLike\": { \"aws:SourceArn\": \"myRoute53ResourceArn\" }, \"StringEquals\": { \"aws:SourceAccount\": \"myAwsAccountId\" } } } ] }`

" } } }, "PutResourcePolicyResponse":{ "type":"structure", "members":{ "resourcePolicy":{ "shape":"ResourcePolicy", "documentation":"

The new policy.

" } } }, "PutRetentionPolicyRequest":{ "type":"structure", "required":[ "logGroupName", "retentionInDays" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "retentionInDays":{"shape":"Days"} } }, "PutSubscriptionFilterRequest":{ "type":"structure", "required":[ "logGroupName", "filterName", "filterPattern", "destinationArn" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterName":{ "shape":"FilterName", "documentation":"

A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in `filterName`. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.

" }, "filterPattern":{ "shape":"FilterPattern", "documentation":"

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

" }, "destinationArn":{ "shape":"DestinationArn", "documentation":"

The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

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

- A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.

  If you're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

- A Kinesis Data Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.

- A Lambda function belonging to the same account as the subscription filter, for same-account delivery.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

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

" }, "distribution":{ "shape":"Distribution", "documentation":"

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

" } } }, "QueryCharOffset":{"type":"integer"}, "QueryCompileError":{ "type":"structure", "members":{ "location":{ "shape":"QueryCompileErrorLocation", "documentation":"

Reserved.

" }, "message":{ "shape":"Message", "documentation":"

Reserved.

" } }, "documentation":"

Reserved.

" }, "QueryCompileErrorLocation":{ "type":"structure", "members":{ "startCharOffset":{ "shape":"QueryCharOffset", "documentation":"

Reserved.

" }, "endCharOffset":{ "shape":"QueryCharOffset", "documentation":"

Reserved.

" } }, "documentation":"

Reserved.

" }, "QueryDefinition":{ "type":"structure", "members":{ "queryDefinitionId":{ "shape":"QueryId", "documentation":"

The unique ID of the query definition.

" }, "name":{ "shape":"QueryDefinitionName", "documentation":"

The name of the query definition.

" }, "queryString":{ "shape":"QueryDefinitionString", "documentation":"

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

" }, "lastModified":{ "shape":"Timestamp", "documentation":"

The date that the query definition was most recently modified.

" }, "logGroupNames":{ "shape":"LogGroupNames", "documentation":"

If this query definition contains a list of log groups that it is limited to, that list appears here.

" } }, "documentation":"

This structure contains details about a saved CloudWatch Logs Insights query definition.

" }, "QueryDefinitionList":{ "type":"list", "member":{"shape":"QueryDefinition"} }, "QueryDefinitionName":{ "type":"string", "max":255, "min":1 }, "QueryDefinitionString":{ "type":"string", "max":10000, "min":1 }, "QueryId":{ "type":"string", "max":256, "min":0 }, "QueryInfo":{ "type":"structure", "members":{ "queryId":{ "shape":"QueryId", "documentation":"

The unique ID number of this query.

" }, "queryString":{ "shape":"QueryString", "documentation":"

The query string used in this query.

" }, "status":{ "shape":"QueryStatus", "documentation":"

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

" }, "createTime":{ "shape":"Timestamp", "documentation":"

The date and time that this query was created.

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group scanned by this query.

" } }, "documentation":"

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

" }, "QueryInfoList":{ "type":"list", "member":{"shape":"QueryInfo"} }, "QueryListMaxResults":{ "type":"integer", "max":1000, "min":1 }, "QueryResults":{ "type":"list", "member":{"shape":"ResultRows"} }, "QueryStatistics":{ "type":"structure", "members":{ "recordsMatched":{ "shape":"StatsValue", "documentation":"

The number of log events that matched the query string.

" }, "recordsScanned":{ "shape":"StatsValue", "documentation":"

The total number of log events scanned during the query.

" }, "bytesScanned":{ "shape":"StatsValue", "documentation":"

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

" } }, "documentation":"

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

" }, "QueryStatus":{ "type":"string", "enum":[ "Scheduled", "Running", "Complete", "Failed", "Cancelled", "Timeout", "Unknown" ] }, "QueryString":{ "type":"string", "max":10000, "min":0 }, "RejectedLogEventsInfo":{ "type":"structure", "members":{ "tooNewLogEventStartIndex":{ "shape":"LogEventIndex", "documentation":"

The log events that are too new.

" }, "tooOldLogEventEndIndex":{ "shape":"LogEventIndex", "documentation":"

The log events that are dated too far in the past.

" }, "expiredLogEventEndIndex":{ "shape":"LogEventIndex", "documentation":"

The expired log events.

" } }, "documentation":"

Represents the rejected events.

" }, "RequestId":{ "type":"string", "max":256, "min":0 }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

The specified resource already exists.

", "exception":true }, "ResourceArns":{ "type":"list", "member":{"shape":"Arn"} }, "ResourceIdentifier":{ "type":"string", "max":2048, "min":1, "pattern":"[\\w+=/:,.@\\-\\*]*" }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified resource does not exist.

", "exception":true }, "ResourcePolicies":{ "type":"list", "member":{"shape":"ResourcePolicy"} }, "ResourcePolicy":{ "type":"structure", "members":{ "policyName":{ "shape":"PolicyName", "documentation":"

The name of the resource policy.

" }, "policyDocument":{ "shape":"PolicyDocument", "documentation":"

The details of the policy.

" }, "lastUpdatedTime":{ "shape":"Timestamp", "documentation":"

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

" } }, "documentation":"

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

" }, "ResultField":{ "type":"structure", "members":{ "field":{ "shape":"Field", "documentation":"

The log event field.

" }, "value":{ "shape":"Value", "documentation":"

The value of this field.

" } }, "documentation":"

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

For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.

" }, "ResultRows":{ "type":"list", "member":{"shape":"ResultField"} }, "RoleArn":{ "type":"string", "min":1 }, "Scope":{ "type":"string", "enum":["ALL"] }, "SearchedLogStream":{ "type":"structure", "members":{ "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" }, "searchedCompletely":{ "shape":"LogStreamSearchedCompletely", "documentation":"

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

" } }, "documentation":"

Represents the search status of a log stream.

" }, "SearchedLogStreams":{ "type":"list", "member":{"shape":"SearchedLogStream"} }, "SelectionCriteria":{"type":"string"}, "SequenceToken":{ "type":"string", "min":1 }, "Service":{ "type":"string", "max":255, "min":1, "pattern":"[\\w]*" }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ }, "documentation":"

This request exceeds a service quota.

", "exception":true }, "ServiceUnavailableException":{ "type":"structure", "members":{ }, "documentation":"

The service cannot complete the request.

", "exception":true, "fault":true }, "SessionId":{ "type":"string", "max":256, "min":0 }, "SessionStreamingException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"

his exception is returned if an unknown error occurs during a Live Tail session.

", "exception":true }, "SessionTimeoutException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"

This exception is returned in a Live Tail stream when the Live Tail session times out. Live Tail sessions time out after three hours.

", "exception":true }, "StandardUnit":{ "type":"string", "enum":[ "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" ] }, "StartFromHead":{"type":"boolean"}, "StartLiveTailLogGroupIdentifiers":{ "type":"list", "member":{"shape":"LogGroupIdentifier"}, "max":10, "min":1 }, "StartLiveTailRequest":{ "type":"structure", "required":["logGroupIdentifiers"], "members":{ "logGroupIdentifiers":{ "shape":"StartLiveTailLogGroupIdentifiers", "documentation":"

An array where each item in the array is a log group to include in the Live Tail session.

Specify each log group by its ARN.

If you specify an ARN, the ARN can't end with an asterisk (*).

You can include up to 10 log groups.

" }, "logStreamNames":{ "shape":"InputLogStreamNames", "documentation":"

If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session.

If you specify this field, you can't also specify the `logStreamNamePrefixes` field.

You can specify this parameter only if you specify only one log group in `logGroupIdentifiers`.

" }, "logStreamNamePrefixes":{ "shape":"InputLogStreamNames", "documentation":"

If you specify this parameter, then only log events in the log streams that have names that start with the prefixes that you specify here are included in the Live Tail session.

If you specify this field, you can't also specify the `logStreamNames` field.

You can specify this parameter only if you specify only one log group in `logGroupIdentifiers`.

" }, "logEventFilterPattern":{ "shape":"FilterPattern", "documentation":"

An optional pattern to use to filter the results to include only log events that match the pattern. For example, a filter pattern of `error 404` causes only log events that include both `error` and `404` to be included in the Live Tail stream.

Regular expression filter patterns are supported.

For more information about filter pattern syntax, see Filter and Pattern Syntax.

" } } }, "StartLiveTailResponse":{ "type":"structure", "members":{ "responseStream":{ "shape":"StartLiveTailResponseStream", "documentation":"

An object that includes the stream returned by your request. It can include both log events and exceptions.

" } } }, "StartLiveTailResponseStream":{ "type":"structure", "members":{ "sessionStart":{ "shape":"LiveTailSessionStart", "documentation":"

This object contains information about this Live Tail session, including the log groups included and the log stream filters, if any.

" }, "sessionUpdate":{ "shape":"LiveTailSessionUpdate", "documentation":"

This object contains the log events and session metadata.

" }, "SessionTimeoutException":{ "shape":"SessionTimeoutException", "documentation":"

This exception is returned in the stream when the Live Tail session times out. Live Tail sessions time out after three hours.

" }, "SessionStreamingException":{ "shape":"SessionStreamingException", "documentation":"

This exception is returned if an unknown error occurs.

" } }, "documentation":"

This object includes the stream returned by your StartLiveTail request.

", "eventstream":true }, "StartQueryRequest":{ "type":"structure", "required":[ "startTime", "endTime", "queryString" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The log group on which to perform the query.

A `StartQuery` operation must include exactly one of the following parameters: `logGroupName`, `logGroupNames`, or `logGroupIdentifiers`.

" }, "logGroupNames":{ "shape":"LogGroupNames", "documentation":"

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

A `StartQuery` operation must include exactly one of the following parameters: `logGroupName`, `logGroupNames`, or `logGroupIdentifiers`.

" }, "logGroupIdentifiers":{ "shape":"LogGroupIdentifiers", "documentation":"

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A `StartQuery` operation must include exactly one of the following parameters: `logGroupName`, `logGroupNames`, or `logGroupIdentifiers`.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

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

" }, "endTime":{ "shape":"Timestamp", "documentation":"

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

" }, "queryString":{ "shape":"QueryString", "documentation":"

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

" }, "limit":{ "shape":"EventsLimit", "documentation":"

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

" } } }, "StartQueryResponse":{ "type":"structure", "members":{ "queryId":{ "shape":"QueryId", "documentation":"

The unique ID of the query.

" } } }, "State":{ "type":"string", "enum":[ "Active", "Suppressed", "Baseline" ] }, "StatsValue":{"type":"double"}, "StopQueryRequest":{ "type":"structure", "required":["queryId"], "members":{ "queryId":{ "shape":"QueryId", "documentation":"

The ID number of the query to stop. To find this ID number, use `DescribeQueries`.

" } } }, "StopQueryResponse":{ "type":"structure", "members":{ "success":{ "shape":"Success", "documentation":"

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

" } } }, "StoredBytes":{ "type":"long", "min":0 }, "SubscriptionFilter":{ "type":"structure", "members":{ "filterName":{ "shape":"FilterName", "documentation":"

The name of the subscription filter.

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterPattern":{"shape":"FilterPattern"}, "destinationArn":{ "shape":"DestinationArn", "documentation":"

The Amazon Resource Name (ARN) of the destination.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

" }, "distribution":{"shape":"Distribution"}, "creationTime":{ "shape":"Timestamp", "documentation":"

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

" } }, "documentation":"

Represents a subscription filter.

" }, "SubscriptionFilters":{ "type":"list", "member":{"shape":"SubscriptionFilter"} }, "Success":{"type":"boolean"}, "SuppressionPeriod":{ "type":"structure", "members":{ "value":{ "shape":"Integer", "documentation":"

Specifies the number of seconds, minutes or hours to suppress this anomaly. There is no maximum.

" }, "suppressionUnit":{ "shape":"SuppressionUnit", "documentation":"

Specifies whether the value of `value` is in seconds, minutes, or hours.

" } }, "documentation":"

If you are suppressing an anomaly temporariliy, this structure defines how long the suppression period is to be.

" }, "SuppressionState":{ "type":"string", "enum":[ "SUPPRESSED", "UNSUPPRESSED" ] }, "SuppressionType":{ "type":"string", "enum":[ "LIMITED", "INFINITE" ] }, "SuppressionUnit":{ "type":"string", "enum":[ "SECONDS", "MINUTES", "HOURS" ] }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":0 }, "TagList":{ "type":"list", "member":{"shape":"TagKey"}, "min":1 }, "TagLogGroupRequest":{ "type":"structure", "required":[ "logGroupName", "tags" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "tags":{ "shape":"Tags", "documentation":"

The key-value pairs to use for the tags.

" } }, "deprecated":true, "deprecatedMessage":"Please use the generic tagging API model TagResourceRequest" }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the resource that you're adding tags to.

The ARN format of a log group is `arn:aws:logs:Region:account-id:log-group:log-group-name`

The ARN format of a destination is `arn:aws:logs:Region:account-id:destination:destination-name`

For more information about ARN format, see CloudWatch Logs resources and operations.

" }, "tags":{ "shape":"Tags", "documentation":"

The list of key-value pairs to associate with the resource.

" } } }, "TagValue":{ "type":"string", "max":256, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":1 }, "TargetArn":{ "type":"string", "min":1 }, "TestEventMessages":{ "type":"list", "member":{"shape":"EventMessage"}, "max":50, "min":1 }, "TestMetricFilterRequest":{ "type":"structure", "required":[ "filterPattern", "logEventMessages" ], "members":{ "filterPattern":{"shape":"FilterPattern"}, "logEventMessages":{ "shape":"TestEventMessages", "documentation":"

The log event messages to test.

" } } }, "TestMetricFilterResponse":{ "type":"structure", "members":{ "matches":{ "shape":"MetricFilterMatches", "documentation":"

The matched events.

" } } }, "ThrottlingException":{ "type":"structure", "members":{ }, "documentation":"

The request was throttled because of quota limits.

", "exception":true }, "Time":{ "type":"string", "min":1 }, "Timestamp":{ "type":"long", "min":0 }, "Token":{"type":"string"}, "TokenString":{ "type":"string", "min":1 }, "TokenValue":{"type":"long"}, "TooManyTagsException":{ "type":"structure", "members":{ "message":{"shape":"Message"}, "resourceName":{ "shape":"AmazonResourceName", "documentation":"

The name of the resource.

" } }, "documentation":"

A resource can have no more than 50 tags.

", "exception":true }, "Unmask":{"type":"boolean"}, "UnrecognizedClientException":{ "type":"structure", "members":{ }, "documentation":"

The most likely cause is an Amazon Web Services access key ID or secret key that's not valid.

", "exception":true }, "UntagLogGroupRequest":{ "type":"structure", "required":[ "logGroupName", "tags" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "tags":{ "shape":"TagList", "documentation":"

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

" } }, "deprecated":true, "deprecatedMessage":"Please use the generic tagging API model UntagResourceRequest" }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the CloudWatch Logs resource that you're removing tags from.

The ARN format of a log group is `arn:aws:logs:Region:account-id:log-group:log-group-name`

The ARN format of a destination is `arn:aws:logs:Region:account-id:destination:destination-name`

For more information about ARN format, see CloudWatch Logs resources and operations.

" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

The list of tag keys to remove from the resource.

" } } }, "UpdateAnomalyRequest":{ "type":"structure", "required":["anomalyDetectorArn"], "members":{ "anomalyId":{ "shape":"AnomalyId", "documentation":"

If you are suppressing or unsuppressing an anomaly, specify its unique ID here. You can find anomaly IDs by using the ListAnomalies operation.

" }, "patternId":{ "shape":"PatternId", "documentation":"

If you are suppressing or unsuppressing an pattern, specify its unique ID here. You can find pattern IDs by using the ListAnomalies operation.

" }, "anomalyDetectorArn":{ "shape":"AnomalyDetectorArn", "documentation":"

The ARN of the anomaly detector that this operation is to act on.

" }, "suppressionType":{ "shape":"SuppressionType", "documentation":"

Use this to specify whether the suppression to be temporary or infinite. If you specify `LIMITED`, you must also specify a `suppressionPeriod`. If you specify `INFINITE`, any value for `suppressionPeriod` is ignored.

" }, "suppressionPeriod":{ "shape":"SuppressionPeriod", "documentation":"

If you are temporarily suppressing an anomaly or pattern, use this structure to specify how long the suppression is to last.

" } } }, "UpdateLogAnomalyDetectorRequest":{ "type":"structure", "required":[ "anomalyDetectorArn", "enabled" ], "members":{ "anomalyDetectorArn":{ "shape":"AnomalyDetectorArn", "documentation":"

The ARN of the anomaly detector that you want to update.

" }, "evaluationFrequency":{ "shape":"EvaluationFrequency", "documentation":"

Specifies how often the anomaly detector runs and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then setting `evaluationFrequency` to `FIFTEEN_MIN` might be appropriate.

" }, "filterPattern":{"shape":"FilterPattern"}, "anomalyVisibilityTime":{ "shape":"AnomalyVisibilityTime", "documentation":"

The number of days to use as the life cycle of anomalies. After this time, anomalies are automatically baselined and the anomaly detector model will treat new occurrences of similar event as normal. Therefore, if you do not correct the cause of an anomaly during this time, it will be considered normal going forward and will not be detected.

" }, "enabled":{ "shape":"Boolean", "documentation":"

Use this parameter to pause or restart the anomaly detector.

" } } }, "ValidationException":{ "type":"structure", "members":{ }, "documentation":"

One of the parameters for the request is not valid.

", "exception":true }, "Value":{"type":"string"} }, "documentation":"

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.

You can use CloudWatch Logs to:

- Monitor logs from EC2 instances in real time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs. Then, it can send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring so no code changes are required. For example, you can monitor application logs for specific literal terms (such as \"NullReferenceException\"). You can also count the number of occurrences of a literal term at a particular position in log data (such as \"404\" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.

- Monitor CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.

- Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events earlier than this setting are automatically deleted. The CloudWatch Logs agent helps to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

" }