From 1429c43213899b0e92513d3218dc83aeac02e754 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 25 Oct 2024 18:16:09 +0000 Subject: [PATCH] feat(client-cloudwatch-logs): Adding inferred token name for dynamic tokens in Anomalies. --- clients/client-cloudwatch-logs/README.md | 2 +- .../src/commands/CreateDeliveryCommand.ts | 2 +- .../src/commands/DescribeLogGroupsCommand.ts | 2 +- .../src/commands/ListAnomaliesCommand.ts | 1 + .../src/commands/PutRetentionPolicyCommand.ts | 4 +- .../src/commands/TagLogGroupCommand.ts | 2 +- .../src/commands/UntagLogGroupCommand.ts | 2 +- .../src/commands/UpdateAnomalyCommand.ts | 4 +- .../src/models/models_0.ts | 27 +- .../aws-models/cloudwatch-logs.json | 19808 ++++++++-------- 10 files changed, 9941 insertions(+), 9913 deletions(-) diff --git a/clients/client-cloudwatch-logs/README.md b/clients/client-cloudwatch-logs/README.md index 127209ebfe1ab..e49fad768511e 100644 --- a/clients/client-cloudwatch-logs/README.md +++ b/clients/client-cloudwatch-logs/README.md @@ -44,7 +44,7 @@ into the log service. You can then access the raw log data when you need it.

## Installing -To install the this package, simply type add or install @aws-sdk/client-cloudwatch-logs +To install this package, simply type add or install @aws-sdk/client-cloudwatch-logs using your favorite package manager: - `npm install @aws-sdk/client-cloudwatch-logs` diff --git a/clients/client-cloudwatch-logs/src/commands/CreateDeliveryCommand.ts b/clients/client-cloudwatch-logs/src/commands/CreateDeliveryCommand.ts index 1b82f15d880cc..6947c96726004 100644 --- a/clients/client-cloudwatch-logs/src/commands/CreateDeliveryCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/CreateDeliveryCommand.ts @@ -63,7 +63,7 @@ export interface CreateDeliveryCommandOutput extends CreateDeliveryResponse, __M * *

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.

+ *

To update an existing delivery configuration, use UpdateDeliveryConfiguration.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudwatch-logs/src/commands/DescribeLogGroupsCommand.ts b/clients/client-cloudwatch-logs/src/commands/DescribeLogGroupsCommand.ts index 5c17f2ec0428d..ad9cc4f849fa2 100644 --- a/clients/client-cloudwatch-logs/src/commands/DescribeLogGroupsCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/DescribeLogGroupsCommand.ts @@ -30,7 +30,7 @@ export interface DescribeLogGroupsCommandOutput extends DescribeLogGroupsRespons /** *

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

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 diff --git a/clients/client-cloudwatch-logs/src/commands/ListAnomaliesCommand.ts b/clients/client-cloudwatch-logs/src/commands/ListAnomaliesCommand.ts index 360bf4d4a154f..961ee8a368487 100644 --- a/clients/client-cloudwatch-logs/src/commands/ListAnomaliesCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/ListAnomaliesCommand.ts @@ -75,6 +75,7 @@ export interface ListAnomaliesCommandOutput extends ListAnomaliesResponse, __Met * // enumerations: { // Enumerations * // "": Number("long"), * // }, + * // inferredTokenName: "STRING_VALUE", * // }, * // ], * // logGroupArnList: [ // LogGroupArnList // required diff --git a/clients/client-cloudwatch-logs/src/commands/PutRetentionPolicyCommand.ts b/clients/client-cloudwatch-logs/src/commands/PutRetentionPolicyCommand.ts index be66063a875bf..18592297a5c13 100644 --- a/clients/client-cloudwatch-logs/src/commands/PutRetentionPolicyCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/PutRetentionPolicyCommand.ts @@ -32,11 +32,11 @@ export interface PutRetentionPolicyCommandOutput extends __MetadataBearer {} * 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 + *

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. + * 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, diff --git a/clients/client-cloudwatch-logs/src/commands/TagLogGroupCommand.ts b/clients/client-cloudwatch-logs/src/commands/TagLogGroupCommand.ts index d6a4274327f2d..e134bad35bdb2 100644 --- a/clients/client-cloudwatch-logs/src/commands/TagLogGroupCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/TagLogGroupCommand.ts @@ -37,7 +37,7 @@ export interface TagLogGroupCommandOutput extends __MetadataBearer {} * 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 + *

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 diff --git a/clients/client-cloudwatch-logs/src/commands/UntagLogGroupCommand.ts b/clients/client-cloudwatch-logs/src/commands/UntagLogGroupCommand.ts index 996d647100e54..7d60f4a9c6554 100644 --- a/clients/client-cloudwatch-logs/src/commands/UntagLogGroupCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/UntagLogGroupCommand.ts @@ -35,7 +35,7 @@ export interface UntagLogGroupCommandOutput extends __MetadataBearer {} *

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

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

diff --git a/clients/client-cloudwatch-logs/src/commands/UpdateAnomalyCommand.ts b/clients/client-cloudwatch-logs/src/commands/UpdateAnomalyCommand.ts index ded16722abd64..ee7991ad2e371 100644 --- a/clients/client-cloudwatch-logs/src/commands/UpdateAnomalyCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/UpdateAnomalyCommand.ts @@ -29,9 +29,9 @@ export interface UpdateAnomalyCommandOutput extends __MetadataBearer {} /** *

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

+ * 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 diff --git a/clients/client-cloudwatch-logs/src/models/models_0.ts b/clients/client-cloudwatch-logs/src/models/models_0.ts index 6a2dfb65955e6..e01b5ca2740c9 100644 --- a/clients/client-cloudwatch-logs/src/models/models_0.ts +++ b/clients/client-cloudwatch-logs/src/models/models_0.ts @@ -175,6 +175,17 @@ export interface PatternToken { * @public */ enumerations?: Record; + + /** + *

A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of + * the inferredTokenName gives you a clearer idea of the content of this token. The number part of + * the inferredTokenName shows where in the pattern this token appears, compared to other dynamic tokens. + * CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.

+ *

For example, an inferred token name of IPAddress-3 means that the token represents an IP address, and this + * token is the third dynamic token in the pattern.

+ * @public + */ + inferredTokenName?: string; } /** @@ -713,7 +724,7 @@ export interface ConfigurationTemplate { deliveryDestinationType?: DeliveryDestinationType; /** - *

A mapping that displays the default value of each property within a delivery’s configuration, + *

A mapping that displays the default value of each property within a delivery's configuration, * if it is not specified in the request.

* @public */ @@ -792,7 +803,7 @@ export interface CreateDeliveryRequest { /** *

The list of record fields to be delivered to the destination, in order. - * If the delivery’s log source has mandatory fields, they must be included in this list.

+ * If the delivery's log source has mandatory fields, they must be included in this list.

* @public */ recordFields?: string[]; @@ -805,7 +816,7 @@ export interface CreateDeliveryRequest { fieldDelimiter?: string; /** - *

This structure contains parameters that are valid only when the delivery’s delivery destination is an S3 bucket.

+ *

This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket.

* @public */ s3DeliveryConfiguration?: S3DeliveryConfiguration; @@ -825,7 +836,7 @@ export interface CreateDeliveryRequest { *

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.

+ *

To update an existing delivery configuration, use UpdateDeliveryConfiguration.

* @public */ export interface Delivery { @@ -1005,6 +1016,8 @@ export interface CreateExportTaskRequest { /** *

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

+ *

The length of this parameter must comply with the S3 object key name length limits. The object key name is a sequence of Unicode characters with UTF-8 encoding, + * and can be up to 1,024 bytes.

* @public */ destinationPrefix?: string; @@ -5325,7 +5338,7 @@ export interface StartQueryRequest { /** *

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.

+ * only the specified fields and their values are returned. The default is 10,000.

* @public */ limit?: number; @@ -5634,7 +5647,7 @@ export interface UpdateDeliveryConfigurationRequest { /** *

The list of record fields to be delivered to the destination, in order. - * If the delivery’s log source has mandatory fields, they must be included in this list.

+ * If the delivery's log source has mandatory fields, they must be included in this list.

* @public */ recordFields?: string[]; @@ -5647,7 +5660,7 @@ export interface UpdateDeliveryConfigurationRequest { fieldDelimiter?: string; /** - *

This structure contains parameters that are valid only when the delivery’s delivery destination is an S3 bucket.

+ *

This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket.

* @public */ s3DeliveryConfiguration?: S3DeliveryConfiguration; diff --git a/codegen/sdk-codegen/aws-models/cloudwatch-logs.json b/codegen/sdk-codegen/aws-models/cloudwatch-logs.json index e512433e3a87b..5b28a4597bfca 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch-logs.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch-logs.json @@ -1,10018 +1,10032 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.cloudwatchlogs#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#AccessPolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.cloudwatchlogs#AccountIds": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.cloudwatchlogs#AccountPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicy" + } + }, + "com.amazonaws.cloudwatchlogs#AccountPolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of the account policy.

" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", + "traits": { + "smithy.api#documentation": "

The policy document for this account policy.

\n

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

" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "

The type of policy for this account policy.

" + } + }, + "scope": { + "target": "com.amazonaws.cloudwatchlogs#Scope", + "traits": { + "smithy.api#documentation": "

The scope of the account policy.

" + } + }, + "selectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#SelectionCriteria", + "traits": { + "smithy.api#documentation": "

The log group selection criteria for this subscription filter policy.

" + } + }, + "accountId": { + "target": "com.amazonaws.cloudwatchlogs#AccountId", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#AccountPolicyDocument": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#AllowedActionForAllowVendedLogsDeliveryForResource": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#AllowedFieldDelimiters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter" + } + }, + "com.amazonaws.cloudwatchlogs#AllowedFields": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#RecordField" + } + }, + "com.amazonaws.cloudwatchlogs#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^[\\w+=/:,.@-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#Anomalies": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Anomaly" + } + }, + "com.amazonaws.cloudwatchlogs#Anomaly": { + "type": "structure", + "members": { + "anomalyId": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyId", + "traits": { + "smithy.api#documentation": "

The unique ID that CloudWatch Logs assigned to this anomaly.

", + "smithy.api#required": {} + } + }, + "patternId": { + "target": "com.amazonaws.cloudwatchlogs#PatternId", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN of the anomaly detector that identified this anomaly.

", + "smithy.api#required": {} + } + }, + "patternString": { + "target": "com.amazonaws.cloudwatchlogs#PatternString", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "patternRegex": { + "target": "com.amazonaws.cloudwatchlogs#PatternRegex", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "priority": { + "target": "com.amazonaws.cloudwatchlogs#Priority", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "firstSeen": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "lastSeen": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cloudwatchlogs#Description", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "active": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether this anomaly is still ongoing.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.cloudwatchlogs#State", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "histogram": { + "target": "com.amazonaws.cloudwatchlogs#Histogram", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "logSamples": { + "target": "com.amazonaws.cloudwatchlogs#LogSamples", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "patternTokens": { + "target": "com.amazonaws.cloudwatchlogs#PatternTokens", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "logGroupArnList": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "suppressed": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "suppressedDate": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

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

" + } + }, + "suppressedUntil": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

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

" + } + }, + "isPatternLevelSuppression": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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

\n

For more information about patterns and anomalies, see CreateLogAnomalyDetector.\n

" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetector": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN of the anomaly detector.

" + } + }, + "detectorName": { + "target": "com.amazonaws.cloudwatchlogs#DetectorName", + "traits": { + "smithy.api#documentation": "

The name of the anomaly detector.

" + } + }, + "logGroupArnList": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "anomalyDetectorStatus": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "creationTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The date and time when this anomaly detector was created.

" + } + }, + "lastModifiedTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

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

" + } + }, + "anomalyVisibilityTime": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about one anomaly detector in the account.

" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + }, + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } + }, + "ANALYZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANALYZING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAUSED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetector" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + } + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 7, + "max": 90 + } + } + }, + "com.amazonaws.cloudwatchlogs#Arn": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#AssociateKmsKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

\n
    \n
  • \n

    Specify the logGroupName parameter to cause all log events stored in the log group to\n be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.

    \n

    Associating a KMS key with a log group overrides any existing\n 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\n using the KMS key. This association is stored as long as the data encrypted\n with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

    \n

    Associating\n 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\n results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier\n parameter that specifies a query-result resource.

    \n
    • \n
  • \n

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

    \n

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

    \n

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

    \n
    • \n
\n \n

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

\n \n \n

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

\n \n

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

\n

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\n InvalidParameterException error.

" + } + }, + "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

\n

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

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "resourceIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "

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

\n
    \n
  • \n

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

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:query-result:*\n

    \n
    • \n
  • \n

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

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME\n \n

    \n
    • \n
\n

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#Boolean": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#CancelExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CancelExportTaskRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels the specified export task.

\n

The task must be in the PENDING or RUNNING state.

" + } + }, + "com.amazonaws.cloudwatchlogs#CancelExportTaskRequest": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The ID of the export task.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 128 + }, + "smithy.api#pattern": "^\\S{36,128}$" + } + }, + "com.amazonaws.cloudwatchlogs#ConfigurationTemplate": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.cloudwatchlogs#Service", + "traits": { + "smithy.api#documentation": "

A string specifying which service this configuration template applies to. For more information about supported services see \n Enable logging from Amazon Web Services \n services..

" + } + }, + "logType": { + "target": "com.amazonaws.cloudwatchlogs#LogType", + "traits": { + "smithy.api#documentation": "

A string specifying which log type this configuration template applies to.

" + } + }, + "resourceType": { + "target": "com.amazonaws.cloudwatchlogs#ResourceType", + "traits": { + "smithy.api#documentation": "

A string specifying which resource type this configuration template applies to.

" + } + }, + "deliveryDestinationType": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", + "traits": { + "smithy.api#documentation": "

A string specifying which destination type this configuration template applies to.

" + } + }, + "defaultDeliveryConfigValues": { + "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplateDeliveryConfigValues", + "traits": { + "smithy.api#documentation": "

A mapping that displays the default value of each property within a delivery's configuration,\n if it is not specified in the request.

" + } + }, + "allowedFields": { + "target": "com.amazonaws.cloudwatchlogs#AllowedFields", + "traits": { + "smithy.api#documentation": "

The allowed fields that a caller can use in the recordFields parameter of a CreateDelivery or \n UpdateDeliveryConfiguration operation.

" + } + }, + "allowedOutputFormats": { + "target": "com.amazonaws.cloudwatchlogs#OutputFormats", + "traits": { + "smithy.api#documentation": "

The list of delivery destination output formats that are supported by this log source.

" + } + }, + "allowedActionForAllowVendedLogsDeliveryForResource": { + "target": "com.amazonaws.cloudwatchlogs#AllowedActionForAllowVendedLogsDeliveryForResource", + "traits": { + "smithy.api#documentation": "

The action permissions that a caller needs to have to be able to successfully create a delivery source on the \n desired resource type when calling PutDeliverySource.

" + } + }, + "allowedFieldDelimiters": { + "target": "com.amazonaws.cloudwatchlogs#AllowedFieldDelimiters", + "traits": { + "smithy.api#documentation": "

The valid values that a caller can use as field delimiters when calling CreateDelivery or \n UpdateDeliveryConfiguration \n on a delivery that delivers in Plain, W3C, or Raw format.

" + } + }, + "allowedSuffixPathFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "

The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure containing information about the deafult settings and available settings that you can use to configure a delivery or a \n delivery destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#ConfigurationTemplateDeliveryConfigValues": { + "type": "structure", + "members": { + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "

The default record fields that will be delivered when a list of record fields is not provided in \n a CreateDelivery operation.

" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

The default field delimiter that is used in a CreateDelivery operation when\n the field delimiter is not specified in that operation. The field delimiter is used only when \n the final output delivery is in Plain, W3C, or Raw format.

" + } + }, + "s3DeliveryConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

The delivery parameters that are used when you create a delivery to a delivery destination that is an S3 Bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure contains the default values that are used for each configuration parameter when you use\n CreateDelivery to create a deliver under the current service type, resource type, and log type.

" + } + }, + "com.amazonaws.cloudwatchlogs#ConfigurationTemplates": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplate" + } + }, + "com.amazonaws.cloudwatchlogs#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

This operation attempted to create a resource that already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#Count": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#CreateDelivery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateDeliveryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateDeliveryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

\n

To update an existing delivery configuration, use UpdateDeliveryConfiguration.

" + } + }, + "com.amazonaws.cloudwatchlogs#CreateDeliveryRequest": { + "type": "structure", + "members": { + "deliverySourceName": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "deliveryDestinationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "

The list of record fields to be delivered to the destination, in order. \n If the delivery's log source has mandatory fields, they must be included in this list.

" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

The field delimiter to use between record fields when the final output format of a delivery\n is in Plain, W3C, or Raw format.

" + } + }, + "s3DeliveryConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateDeliveryResponse": { + "type": "structure", + "members": { + "delivery": { + "target": "com.amazonaws.cloudwatchlogs#Delivery", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateExportTaskRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateExportTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

\n

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

\n

This is an asynchronous call. If all the required information is provided, this \n operation initiates an export task and responds with the ID of the task. After the task has started,\n you can use DescribeExportTasks to get the status of the export task. Each account can\n only have one active (RUNNING or PENDING) export task at a time.\n To cancel an export task, use CancelExportTask.

\n

You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate log data for each export task, specify a prefix to be used as the Amazon\n S3 key prefix for all exported objects.

\n \n

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

\n " + } + }, + "com.amazonaws.cloudwatchlogs#CreateExportTaskRequest": { + "type": "structure", + "members": { + "taskName": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskName", + "traits": { + "smithy.api#documentation": "

The name of the export task.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "from": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "to": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

\n

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

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "destinationPrefix": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", + "traits": { + "smithy.api#documentation": "

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

\n

The length of this parameter must comply with the S3 object key name length limits. The object key name is a sequence of Unicode characters with UTF-8 encoding, \n and can be up to 1,024 bytes.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateExportTaskResponse": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The ID of the export task.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n

The following is an example of a pattern:

\n

\n [INFO] Request time: <*> ms\n

\n

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

\n \n

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

\n " + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorRequest": { + "type": "structure", + "members": { + "logGroupArnList": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "detectorName": { + "target": "com.amazonaws.cloudwatchlogs#DetectorName", + "traits": { + "smithy.api#documentation": "

A name for this anomaly detector.

" + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "anomalyVisibilityTime": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorResponse": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

\n
    \n
  • \n

    Log group names must be unique within a Region for an Amazon Web Services\n account.

    \n
    • \n
  • \n

    Log group names can be between 1 and 512 characters long.

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

\n

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

\n

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\n InvalidParameterException error.

\n \n

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

\n " + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

A name for the log group.

", + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The key-value pairs to use for the tags.

\n

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

" + } + }, + "logGroupClass": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", + "traits": { + "smithy.api#documentation": "

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

\n
    \n
  • \n

    The Standard log class supports all CloudWatch Logs features.

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

\n \n

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

\n \n

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogStreamRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a log stream for the specified log group. A log stream is a sequence of log events\n that originate from a single source, such as an application instance or a resource that is \n being monitored.

\n

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

\n

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

\n
    \n
  • \n

    Log stream names must be unique within the log group.

    \n
    • \n
  • \n

    Log stream names can be between 1 and 512 characters long.

    \n
    • \n
  • \n

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

    \n
    • \n
" + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogStreamRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DataAlreadyAcceptedException": { + "type": "structure", + "members": { + "expectedSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken" + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The event was already logged.

\n \n

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

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#DataProtectionStatus": { + "type": "enum", + "members": { + "ACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#Days": { + "type": "integer", + "traits": { + "smithy.api#documentation": "

The number of days to retain the log events in the specified log group.\n 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.

\n

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DefaultValue": { + "type": "double" + }, + "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups\n or a subset of log groups in the account. Log-group level policies will still be in effect.

\n

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteAccountPolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of the policy to delete.

", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "

The type of policy to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the data protection policy from the specified log group.

\n

For more information about data protection policies, see PutDataProtectionPolicy.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicyRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDelivery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicyRequest": { + "type": "structure", + "members": { + "deliveryDestinationName": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliverySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliverySourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliverySourceRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDestinationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified destination, and eventually disables all the\n subscription filters that publish to it. This operation does not delete the \n physical resource encapsulated by the destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDestinationRequest": { + "type": "structure", + "members": { + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the destination.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetectorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified CloudWatch Logs anomaly detector.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetectorRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteMetricFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteMetricFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified metric filter.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteMetricFilterRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the metric filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteQueryDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

Each DeleteQueryDefinition operation can delete one query definition.

\n

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionRequest": { + "type": "structure", + "members": { + "queryDefinitionId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionResponse": { + "type": "structure", + "members": { + "success": { + "target": "com.amazonaws.cloudwatchlogs#Success", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteResourcePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified retention policy.

\n

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicyRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified subscription filter.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilterRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the subscription filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#Deliveries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Delivery" + } + }, + "com.amazonaws.cloudwatchlogs#Delivery": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "

The unique ID that identifies this delivery in your account.

" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "deliverySourceName": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "deliveryDestinationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "deliveryDestinationType": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "

The record fields used in this delivery.

" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

The field delimiter that is used between record fields when the final output format of a delivery\n is in Plain, W3C, or Raw format.

" + } + }, + "s3DeliveryConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The tags that have been assigned to this delivery.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure contains information about one delivery in your account.

\n

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

\n

For more information, see CreateDelivery.

\n

To update an existing delivery configuration, use UpdateDeliveryConfiguration.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestination": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

The name of this delivery destination.

" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "deliveryDestinationType": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "outputFormat": { + "target": "com.amazonaws.cloudwatchlogs#OutputFormat", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "deliveryDestinationConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The tags that have been assigned to this delivery destination.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure contains information about one delivery destination in your account. \n A delivery destination is an Amazon Web Services resource that represents an \n Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, are supported as Firehose delivery destinations.

\n

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

    Create a delivery destination, which is a logical object that represents the actual\n delivery destination.

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration": { + "type": "structure", + "members": { + "destinationResourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about one logs delivery destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[\\w-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 51200 + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "CWL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CWL" + } + }, + "FH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FH" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Za-z]+$" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySource": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the delivery source.

" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "resourceArns": { + "target": "com.amazonaws.cloudwatchlogs#ResourceArns", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "service": { + "target": "com.amazonaws.cloudwatchlogs#Service", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service that is sending logs.

" + } + }, + "logType": { + "target": "com.amazonaws.cloudwatchlogs#LogType", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The tags that have been assigned to this delivery source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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

\n

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

\n

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[\\w-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySource" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySuffixPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#Descending": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest": { + "type": "structure", + "members": { + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "accountIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#AccountIds", + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse": { + "type": "structure", + "members": { + "accountPolicies": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicies", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "configurationTemplates", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesRequest": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.cloudwatchlogs#Service", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter the response to include only the \n configuration templates that apply to the Amazon Web Services service that you specify here.

" + } + }, + "logTypes": { + "target": "com.amazonaws.cloudwatchlogs#LogTypes", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter the response to include only the \n configuration templates that apply to the log types that you specify here.

" + } + }, + "resourceTypes": { + "target": "com.amazonaws.cloudwatchlogs#ResourceTypes", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter the response to include only the \n configuration templates that apply to the resource types that you specify here.

" + } + }, + "deliveryDestinationTypes": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationTypes", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter the response to include only the \n configuration templates that apply to the delivery destination types that you specify here.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

Use this parameter to limit the number of configuration templates that are returned\n in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesResponse": { + "type": "structure", + "members": { + "configurationTemplates": { + "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplates", + "traits": { + "smithy.api#documentation": "

An array of objects, where each object describes one configuration template that matches\n the filters that you specified in the request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

\n

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

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deliveries", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveriesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveriesResponse": { + "type": "structure", + "members": { + "deliveries": { + "target": "com.amazonaws.cloudwatchlogs#Deliveries", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deliveryDestinations", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsResponse": { + "type": "structure", + "members": { + "deliveryDestinations": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinations", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliverySources": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deliverySources", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesResponse": { + "type": "structure", + "members": { + "deliverySources": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySources", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDestinationsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "destinations", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDestinationsRequest": { + "type": "structure", + "members": { + "DestinationNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse": { + "type": "structure", + "members": { + "destinations": { + "target": "com.amazonaws.cloudwatchlogs#Destinations", + "traits": { + "smithy.api#documentation": "

The destinations.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeExportTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasksRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeExportTasksRequest": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "statusCode": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeExportTasksResponse": { + "type": "structure", + "members": { + "exportTasks": { + "target": "com.amazonaws.cloudwatchlogs#ExportTasks", + "traits": { + "smithy.api#documentation": "

The export tasks.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

\n

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

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "logGroups", + "pageSize": "limit" + }, + "smithy.test#smokeTests": [ + { + "id": "DescribeLogGroupsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } ] + } }, - "shapes": { - "com.amazonaws.cloudwatchlogs#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#AccessPolicy": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#AccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^\\d{12}$" - } - }, - "com.amazonaws.cloudwatchlogs#AccountIds": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#AccountId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.cloudwatchlogs#AccountPolicies": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#AccountPolicy" - } - }, - "com.amazonaws.cloudwatchlogs#AccountPolicy": { - "type": "structure", - "members": { - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "

The name of the account policy.

" - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", - "traits": { - "smithy.api#documentation": "

The policy document for this account policy.

\n

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

" - } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "policyType": { - "target": "com.amazonaws.cloudwatchlogs#PolicyType", - "traits": { - "smithy.api#documentation": "

The type of policy for this account policy.

" - } - }, - "scope": { - "target": "com.amazonaws.cloudwatchlogs#Scope", - "traits": { - "smithy.api#documentation": "

The scope of the account policy.

" - } - }, - "selectionCriteria": { - "target": "com.amazonaws.cloudwatchlogs#SelectionCriteria", - "traits": { - "smithy.api#documentation": "

The log group selection criteria for this subscription filter policy.

" - } - }, - "accountId": { - "target": "com.amazonaws.cloudwatchlogs#AccountId", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#AccountPolicyDocument": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#AllowedActionForAllowVendedLogsDeliveryForResource": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#AllowedFieldDelimiters": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter" - } - }, - "com.amazonaws.cloudwatchlogs#AllowedFields": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#RecordField" - } - }, - "com.amazonaws.cloudwatchlogs#AmazonResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1011 - }, - "smithy.api#pattern": "^[\\w+=/:,.@-]*$" - } - }, - "com.amazonaws.cloudwatchlogs#Anomalies": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#Anomaly" - } - }, - "com.amazonaws.cloudwatchlogs#Anomaly": { - "type": "structure", - "members": { - "anomalyId": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyId", - "traits": { - "smithy.api#documentation": "

The unique ID that CloudWatch Logs assigned to this anomaly.

", - "smithy.api#required": {} - } - }, - "patternId": { - "target": "com.amazonaws.cloudwatchlogs#PatternId", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "

The ARN of the anomaly detector that identified this anomaly.

", - "smithy.api#required": {} - } - }, - "patternString": { - "target": "com.amazonaws.cloudwatchlogs#PatternString", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "patternRegex": { - "target": "com.amazonaws.cloudwatchlogs#PatternRegex", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "priority": { - "target": "com.amazonaws.cloudwatchlogs#Priority", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "firstSeen": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "lastSeen": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.cloudwatchlogs#Description", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "active": { - "target": "com.amazonaws.cloudwatchlogs#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether this anomaly is still ongoing.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.cloudwatchlogs#State", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "histogram": { - "target": "com.amazonaws.cloudwatchlogs#Histogram", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "logSamples": { - "target": "com.amazonaws.cloudwatchlogs#LogSamples", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "patternTokens": { - "target": "com.amazonaws.cloudwatchlogs#PatternTokens", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "logGroupArnList": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "suppressed": { - "target": "com.amazonaws.cloudwatchlogs#Boolean", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "suppressedDate": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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

" - } - }, - "suppressedUntil": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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

" - } - }, - "isPatternLevelSuppression": { - "target": "com.amazonaws.cloudwatchlogs#Boolean", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

\n

For more information about patterns and anomalies, see CreateLogAnomalyDetector.\n

" - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyDetector": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "

The ARN of the anomaly detector.

" - } - }, - "detectorName": { - "target": "com.amazonaws.cloudwatchlogs#DetectorName", - "traits": { - "smithy.api#documentation": "

The name of the anomaly detector.

" - } - }, - "logGroupArnList": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "evaluationFrequency": { - "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern" - }, - "anomalyDetectorStatus": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "creationTimeStamp": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The date and time when this anomaly detector was created.

" - } - }, - "lastModifiedTimeStamp": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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

" - } - }, - "anomalyVisibilityTime": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about one anomaly detector in the account.

" - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus": { - "type": "enum", - "members": { - "INITIALIZING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INITIALIZING" - } - }, - "TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRAINING" - } - }, - "ANALYZING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANALYZING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "PAUSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PAUSED" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyDetectors": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetector" - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - } - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 7, - "max": 90 - } - } - }, - "com.amazonaws.cloudwatchlogs#Arn": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#AssociateKmsKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n
    \n
  • \n

    Specify the logGroupName parameter to cause all log events stored in the log group to\n be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.

    \n

    Associating a KMS key with a log group overrides any existing\n 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\n using the KMS key. This association is stored as long as the data encrypted\n with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

    \n

    Associating\n 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\n results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier\n parameter that specifies a query-result resource.

    \n
    • \n
  • \n

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

    \n

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

    \n

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

    \n
    • \n
\n \n

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

\n \n \n

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

\n \n

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

\n

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\n InvalidParameterException error.

" - } - }, - "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

\n

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

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "resourceIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#ResourceIdentifier", - "traits": { - "smithy.api#documentation": "

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

\n
    \n
  • \n

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

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:query-result:*\n

    \n
    • \n
  • \n

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

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME\n \n

    \n
    • \n
\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#Boolean": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#CancelExportTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#CancelExportTaskRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels the specified export task.

\n

The task must be in the PENDING or RUNNING state.

" - } - }, - "com.amazonaws.cloudwatchlogs#CancelExportTaskRequest": { - "type": "structure", - "members": { - "taskId": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", - "traits": { - "smithy.api#documentation": "

The ID of the export task.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 128 - }, - "smithy.api#pattern": "^\\S{36,128}$" - } - }, - "com.amazonaws.cloudwatchlogs#ConfigurationTemplate": { - "type": "structure", - "members": { - "service": { - "target": "com.amazonaws.cloudwatchlogs#Service", - "traits": { - "smithy.api#documentation": "

A string specifying which service this configuration template applies to. For more information about supported services see \n Enable logging from Amazon Web Services \n services..

" - } - }, - "logType": { - "target": "com.amazonaws.cloudwatchlogs#LogType", - "traits": { - "smithy.api#documentation": "

A string specifying which log type this configuration template applies to.

" - } - }, - "resourceType": { - "target": "com.amazonaws.cloudwatchlogs#ResourceType", - "traits": { - "smithy.api#documentation": "

A string specifying which resource type this configuration template applies to.

" - } - }, - "deliveryDestinationType": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", - "traits": { - "smithy.api#documentation": "

A string specifying which destination type this configuration template applies to.

" - } - }, - "defaultDeliveryConfigValues": { - "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplateDeliveryConfigValues", - "traits": { - "smithy.api#documentation": "

A mapping that displays the default value of each property within a delivery’s configuration,\n if it is not specified in the request.

" - } - }, - "allowedFields": { - "target": "com.amazonaws.cloudwatchlogs#AllowedFields", - "traits": { - "smithy.api#documentation": "

The allowed fields that a caller can use in the recordFields parameter of a CreateDelivery or \n UpdateDeliveryConfiguration operation.

" - } - }, - "allowedOutputFormats": { - "target": "com.amazonaws.cloudwatchlogs#OutputFormats", - "traits": { - "smithy.api#documentation": "

The list of delivery destination output formats that are supported by this log source.

" - } - }, - "allowedActionForAllowVendedLogsDeliveryForResource": { - "target": "com.amazonaws.cloudwatchlogs#AllowedActionForAllowVendedLogsDeliveryForResource", - "traits": { - "smithy.api#documentation": "

The action permissions that a caller needs to have to be able to successfully create a delivery source on the \n desired resource type when calling PutDeliverySource.

" - } - }, - "allowedFieldDelimiters": { - "target": "com.amazonaws.cloudwatchlogs#AllowedFieldDelimiters", - "traits": { - "smithy.api#documentation": "

The valid values that a caller can use as field delimiters when calling CreateDelivery or \n UpdateDeliveryConfiguration \n on a delivery that delivers in Plain, W3C, or Raw format.

" - } - }, - "allowedSuffixPathFields": { - "target": "com.amazonaws.cloudwatchlogs#RecordFields", - "traits": { - "smithy.api#documentation": "

The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure containing information about the deafult settings and available settings that you can use to configure a delivery or a \n delivery destination.

" - } - }, - "com.amazonaws.cloudwatchlogs#ConfigurationTemplateDeliveryConfigValues": { - "type": "structure", - "members": { - "recordFields": { - "target": "com.amazonaws.cloudwatchlogs#RecordFields", - "traits": { - "smithy.api#documentation": "

The default record fields that will be delivered when a list of record fields is not provided in \n a CreateDelivery operation.

" - } - }, - "fieldDelimiter": { - "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", - "traits": { - "smithy.api#documentation": "

The default field delimiter that is used in a CreateDelivery operation when\n the field delimiter is not specified in that operation. The field delimiter is used only when \n the final output delivery is in Plain, W3C, or Raw format.

" - } - }, - "s3DeliveryConfiguration": { - "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", - "traits": { - "smithy.api#documentation": "

The delivery parameters that are used when you create a delivery to a delivery destination that is an S3 Bucket.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This structure contains the default values that are used for each configuration parameter when you use\n CreateDelivery to create a deliver under the current service type, resource type, and log type.

" - } - }, - "com.amazonaws.cloudwatchlogs#ConfigurationTemplates": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplate" - } - }, - "com.amazonaws.cloudwatchlogs#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

This operation attempted to create a resource that already exists.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#Count": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.cloudwatchlogs#CreateDelivery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#CreateDeliveryRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#CreateDeliveryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#CreateDeliveryRequest": { - "type": "structure", - "members": { - "deliverySourceName": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "deliveryDestinationArn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "recordFields": { - "target": "com.amazonaws.cloudwatchlogs#RecordFields", - "traits": { - "smithy.api#documentation": "

The list of record fields to be delivered to the destination, in order. \n If the delivery’s log source has mandatory fields, they must be included in this list.

" - } - }, - "fieldDelimiter": { - "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", - "traits": { - "smithy.api#documentation": "

The field delimiter to use between record fields when the final output format of a delivery\n is in Plain, W3C, or Raw format.

" - } - }, - "s3DeliveryConfiguration": { - "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", - "traits": { - "smithy.api#documentation": "

This structure contains parameters that are valid only when the delivery’s delivery destination is an S3 bucket.

" - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateDeliveryResponse": { - "type": "structure", - "members": { - "delivery": { - "target": "com.amazonaws.cloudwatchlogs#Delivery", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateExportTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#CreateExportTaskRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#CreateExportTaskResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n

This is an asynchronous call. If all the required information is provided, this \n operation initiates an export task and responds with the ID of the task. After the task has started,\n you can use DescribeExportTasks to get the status of the export task. Each account can\n only have one active (RUNNING or PENDING) export task at a time.\n To cancel an export task, use CancelExportTask.

\n

You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate log data for each export task, specify a prefix to be used as the Amazon\n S3 key prefix for all exported objects.

\n \n

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

\n " - } - }, - "com.amazonaws.cloudwatchlogs#CreateExportTaskRequest": { - "type": "structure", - "members": { - "taskName": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskName", - "traits": { - "smithy.api#documentation": "

The name of the export task.

" - } - }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "logStreamNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "from": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "to": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

\n

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

", - "smithy.api#required": {} - } - }, - "destination": { - "target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "destinationPrefix": { - "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateExportTaskResponse": { - "type": "structure", - "members": { - "taskId": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", - "traits": { - "smithy.api#documentation": "

The ID of the export task.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n

The following is an example of a pattern:

\n

\n [INFO] Request time: <*> ms\n

\n

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

\n \n

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

\n " - } - }, - "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorRequest": { - "type": "structure", - "members": { - "logGroupArnList": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "detectorName": { - "target": "com.amazonaws.cloudwatchlogs#DetectorName", - "traits": { - "smithy.api#documentation": "

A name for this anomaly detector.

" - } - }, - "evaluationFrequency": { - "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "anomalyVisibilityTime": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorResponse": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateLogGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n
    \n
  • \n

    Log group names must be unique within a Region for an Amazon Web Services\n account.

    \n
    • \n
  • \n

    Log group names can be between 1 and 512 characters long.

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

\n

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

\n

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\n InvalidParameterException error.

\n \n

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

\n " - } - }, - "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

A name for the log group.

", - "smithy.api#required": {} - } - }, - "kmsKeyId": { - "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

The key-value pairs to use for the tags.

\n

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

" - } - }, - "logGroupClass": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", - "traits": { - "smithy.api#documentation": "

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

\n
    \n
  • \n

    The Standard log class supports all CloudWatch Logs features.

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

\n \n

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

\n \n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateLogStream": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#CreateLogStreamRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a log stream for the specified log group. A log stream is a sequence of log events\n that originate from a single source, such as an application instance or a resource that is \n being monitored.

\n

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

\n

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

\n
    \n
  • \n

    Log stream names must be unique within the log group.

    \n
    • \n
  • \n

    Log stream names can be between 1 and 512 characters long.

    \n
    • \n
  • \n

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

    \n
    • \n
" - } - }, - "com.amazonaws.cloudwatchlogs#CreateLogStreamRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "

The name of the log stream.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DataAlreadyAcceptedException": { - "type": "structure", - "members": { - "expectedSequenceToken": { - "target": "com.amazonaws.cloudwatchlogs#SequenceToken" - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

The event was already logged.

\n \n

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

\n ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#DataProtectionStatus": { - "type": "enum", - "members": { - "ACTIVATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVATED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "ARCHIVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARCHIVED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#Days": { - "type": "integer", - "traits": { - "smithy.api#documentation": "

The number of days to retain the log events in the specified log group.\n 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.

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DefaultValue": { - "type": "double" - }, - "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups\n or a subset of log groups in the account. Log-group level policies will still be in effect.

\n

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteAccountPolicyRequest": { - "type": "structure", - "members": { - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "

The name of the policy to delete.

", - "smithy.api#required": {} - } - }, - "policyType": { - "target": "com.amazonaws.cloudwatchlogs#PolicyType", - "traits": { - "smithy.api#documentation": "

The type of policy to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the data protection policy from the specified log group.

\n

For more information about data protection policies, see PutDataProtectionPolicy.

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicyRequest": { - "type": "structure", - "members": { - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDelivery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicyRequest": { - "type": "structure", - "members": { - "deliveryDestinationName": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliveryRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryId", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliverySource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliverySourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliverySourceRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteDestinationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified destination, and eventually disables all the\n subscription filters that publish to it. This operation does not delete the \n physical resource encapsulated by the destination.

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDestinationRequest": { - "type": "structure", - "members": { - "destinationName": { - "target": "com.amazonaws.cloudwatchlogs#DestinationName", - "traits": { - "smithy.api#documentation": "

The name of the destination.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetectorRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified CloudWatch Logs anomaly detector.

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetectorRequest": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogGroupRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogStream": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "

The name of the log stream.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteMetricFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteMetricFilterRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified metric filter.

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteMetricFilterRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the metric filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteQueryDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

Each DeleteQueryDefinition operation can delete one query definition.

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionRequest": { - "type": "structure", - "members": { - "queryDefinitionId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionResponse": { - "type": "structure", - "members": { - "success": { - "target": "com.amazonaws.cloudwatchlogs#Success", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteResourcePolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteResourcePolicyRequest": { - "type": "structure", - "members": { - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified retention policy.

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicyRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilterRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified subscription filter.

" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilterRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the subscription filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#Deliveries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#Delivery" - } - }, - "com.amazonaws.cloudwatchlogs#Delivery": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryId", - "traits": { - "smithy.api#documentation": "

The unique ID that identifies this delivery in your account.

" - } - }, - "arn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "deliverySourceName": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "deliveryDestinationArn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "deliveryDestinationType": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "recordFields": { - "target": "com.amazonaws.cloudwatchlogs#RecordFields", - "traits": { - "smithy.api#documentation": "

The record fields used in this delivery.

" - } - }, - "fieldDelimiter": { - "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", - "traits": { - "smithy.api#documentation": "

The field delimiter that is used between record fields when the final output format of a delivery\n is in Plain, W3C, or Raw format.

" - } - }, - "s3DeliveryConfiguration": { - "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", - "traits": { - "smithy.api#documentation": "

This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

" - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

The tags that have been assigned to this delivery.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This structure contains information about one delivery in your account.

\n

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

\n

For more information, see CreateDelivery.

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestination": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "

The name of this delivery destination.

" - } - }, - "arn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "deliveryDestinationType": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "outputFormat": { - "target": "com.amazonaws.cloudwatchlogs#OutputFormat", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "deliveryDestinationConfiguration": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

The tags that have been assigned to this delivery destination.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This structure contains information about one delivery destination in your account. \n A delivery destination is an Amazon Web Services resource that represents an \n Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, are supported as Firehose delivery destinations.

\n

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

    Create a delivery destination, which is a logical object that represents the actual\n delivery destination.

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration": { - "type": "structure", - "members": { - "destinationResourceArn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information about one logs delivery destination.

" - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestinationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 60 - }, - "smithy.api#pattern": "^[\\w-]*$" - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 51200 - } - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestinationType": { - "type": "enum", - "members": { - "S3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3" - } - }, - "CWL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CWL" - } - }, - "FH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FH" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestinationTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 3 - } - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestinations": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination" - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9A-Za-z]+$" - } - }, - "com.amazonaws.cloudwatchlogs#DeliverySource": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the delivery source.

" - } - }, - "arn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "resourceArns": { - "target": "com.amazonaws.cloudwatchlogs#ResourceArns", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "service": { - "target": "com.amazonaws.cloudwatchlogs#Service", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services service that is sending logs.

" - } - }, - "logType": { - "target": "com.amazonaws.cloudwatchlogs#LogType", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

The tags that have been assigned to this delivery source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DeliverySourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 60 - }, - "smithy.api#pattern": "^[\\w-]*$" - } - }, - "com.amazonaws.cloudwatchlogs#DeliverySources": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySource" - } - }, - "com.amazonaws.cloudwatchlogs#DeliverySuffixPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.cloudwatchlogs#Descending": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#DescribeAccountPolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest": { - "type": "structure", - "members": { - "policyType": { - "target": "com.amazonaws.cloudwatchlogs#PolicyType", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "accountIdentifiers": { - "target": "com.amazonaws.cloudwatchlogs#AccountIds", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse": { - "type": "structure", - "members": { - "accountPolicies": { - "target": "com.amazonaws.cloudwatchlogs#AccountPolicies", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplates": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "configurationTemplates", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesRequest": { - "type": "structure", - "members": { - "service": { - "target": "com.amazonaws.cloudwatchlogs#Service", - "traits": { - "smithy.api#documentation": "

Use this parameter to filter the response to include only the \n configuration templates that apply to the Amazon Web Services service that you specify here.

" - } - }, - "logTypes": { - "target": "com.amazonaws.cloudwatchlogs#LogTypes", - "traits": { - "smithy.api#documentation": "

Use this parameter to filter the response to include only the \n configuration templates that apply to the log types that you specify here.

" - } - }, - "resourceTypes": { - "target": "com.amazonaws.cloudwatchlogs#ResourceTypes", - "traits": { - "smithy.api#documentation": "

Use this parameter to filter the response to include only the \n configuration templates that apply to the resource types that you specify here.

" - } - }, - "deliveryDestinationTypes": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationTypes", - "traits": { - "smithy.api#documentation": "

Use this parameter to filter the response to include only the \n configuration templates that apply to the delivery destination types that you specify here.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

Use this parameter to limit the number of configuration templates that are returned\n in the response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesResponse": { - "type": "structure", - "members": { - "configurationTemplates": { - "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplates", - "traits": { - "smithy.api#documentation": "

An array of objects, where each object describes one configuration template that matches\n the filters that you specified in the request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveries": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveriesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveriesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "deliveries", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveriesRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveriesResponse": { - "type": "structure", - "members": { - "deliveries": { - "target": "com.amazonaws.cloudwatchlogs#Deliveries", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinations": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "deliveryDestinations", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsResponse": { - "type": "structure", - "members": { - "deliveryDestinations": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinations", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliverySources": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "deliverySources", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesResponse": { - "type": "structure", - "members": { - "deliverySources": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySources", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDestinations": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDestinationsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "destinations", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDestinationsRequest": { - "type": "structure", - "members": { - "DestinationNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#DestinationName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse": { - "type": "structure", - "members": { - "destinations": { - "target": "com.amazonaws.cloudwatchlogs#Destinations", - "traits": { - "smithy.api#documentation": "

The destinations.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeExportTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasksRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DescribeExportTasksRequest": { - "type": "structure", - "members": { - "taskId": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "statusCode": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeExportTasksResponse": { - "type": "structure", - "members": { - "exportTasks": { - "target": "com.amazonaws.cloudwatchlogs#ExportTasks", - "traits": { - "smithy.api#documentation": "

The export tasks.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLogGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "logGroups", - "pageSize": "limit" - }, - "smithy.test#smokeTests": [ - { - "id": "DescribeLogGroupsSuccess", - "params": {}, - "vendorParams": { - "region": "us-west-2" - }, - "vendorParamsShape": "aws.test#AwsVendorParams", - "expect": { - "success": {} - } - } - ] - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest": { - "type": "structure", - "members": { - "accountIdentifiers": { - "target": "com.amazonaws.cloudwatchlogs#AccountIds", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "logGroupNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The prefix to match.

\n \n

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

\n " - } - }, - "logGroupNamePattern": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupNamePattern", - "traits": { - "smithy.api#documentation": "

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

\n

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

\n \n

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

\n " - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "includeLinkedAccounts": { - "target": "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "logGroupClass": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", - "traits": { - "smithy.api#documentation": "

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

\n
    \n
  • \n

    The Standard log class supports all CloudWatch Logs features.

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLogGroupsResponse": { - "type": "structure", - "members": { - "logGroups": { - "target": "com.amazonaws.cloudwatchlogs#LogGroups", - "traits": { - "smithy.api#documentation": "

The log groups.

\n

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLogStreams": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLogStreamsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLogStreamsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the log streams for the specified log group. \n You can list all the log streams or filter the results by prefix.\n You can also control how the results are ordered.

\n

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

\n

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

\n

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

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "logStreams", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLogStreamsRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

\n \n

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

\n " - } - }, - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n " - } - }, - "logStreamNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "

The prefix to match.

\n

If orderBy is LastEventTime, you cannot specify this\n parameter.

" - } - }, - "orderBy": { - "target": "com.amazonaws.cloudwatchlogs#OrderBy", - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

" - } - }, - "descending": { - "target": "com.amazonaws.cloudwatchlogs#Descending", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLogStreamsResponse": { - "type": "structure", - "members": { - "logStreams": { - "target": "com.amazonaws.cloudwatchlogs#LogStreams", - "traits": { - "smithy.api#documentation": "

The log streams.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeMetricFilters": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the specified metric filters. You can list all of the metric filters or filter\n the results by log name, prefix, metric name, or metric namespace. The results are\n ASCII-sorted by filter name.

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "metricFilters", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

" - } - }, - "filterNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "metricName": { - "target": "com.amazonaws.cloudwatchlogs#MetricName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "metricNamespace": { - "target": "com.amazonaws.cloudwatchlogs#MetricNamespace", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersResponse": { - "type": "structure", - "members": { - "metricFilters": { - "target": "com.amazonaws.cloudwatchlogs#MetricFilters", - "traits": { - "smithy.api#documentation": "

The metric filters.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueries": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueriesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueriesRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "status": { - "target": "com.amazonaws.cloudwatchlogs#QueryStatus", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "maxResults": { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesMaxResults", - "traits": { - "smithy.api#documentation": "

Limits the number of returned queries to the specified number.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueriesResponse": { - "type": "structure", - "members": { - "queries": { - "target": "com.amazonaws.cloudwatchlogs#QueryInfoList", - "traits": { - "smithy.api#documentation": "

The list of queries that match the request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitions": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsRequest": { - "type": "structure", - "members": { - "queryDefinitionNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "maxResults": { - "target": "com.amazonaws.cloudwatchlogs#QueryListMaxResults", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsResponse": { - "type": "structure", - "members": { - "queryDefinitions": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionList", - "traits": { - "smithy.api#documentation": "

The list of query definitions that match your request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeResourcePolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the resource policies in this account.

" - } - }, - "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesResponse": { - "type": "structure", - "members": { - "resourcePolicies": { - "target": "com.amazonaws.cloudwatchlogs#ResourcePolicies", - "traits": { - "smithy.api#documentation": "

The resource policies that exist in this account.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFilters": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix.\n The results are ASCII-sorted by filter name.

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "subscriptionFilters", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "filterNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersResponse": { - "type": "structure", - "members": { - "subscriptionFilters": { - "target": "com.amazonaws.cloudwatchlogs#SubscriptionFilters", - "traits": { - "smithy.api#documentation": "

The subscription filters.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#Destination": { - "type": "structure", - "members": { - "destinationName": { - "target": "com.amazonaws.cloudwatchlogs#DestinationName", - "traits": { - "smithy.api#documentation": "

The name of the destination.

" - } - }, - "targetArn": { - "target": "com.amazonaws.cloudwatchlogs#TargetArn", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "roleArn": { - "target": "com.amazonaws.cloudwatchlogs#RoleArn", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "accessPolicy": { - "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "arn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of this destination.

" - } - }, - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DestinationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#DestinationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[^:*]*$" - } - }, - "com.amazonaws.cloudwatchlogs#Destinations": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#Destination" - } - }, - "com.amazonaws.cloudwatchlogs#DetectorName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#Dimensions": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#DimensionsKey" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#DimensionsValue" - } - }, - "com.amazonaws.cloudwatchlogs#DimensionsKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.cloudwatchlogs#DimensionsValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.cloudwatchlogs#DisassociateKmsKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates the specified KMS key from the specified log\n group or from all CloudWatch Logs Insights query results in the account.

\n

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

    Specify the resourceIdentifier parameter with the query-result\n resource to stop using the KMS key to encrypt the results of all\n future StartQuery\n 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\n the account are still encrypted with that key. Therefore, CloudWatch Logs will need\n permissions for the key whenever that data is accessed.

    \n
    • \n
\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

\n

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

" - } - }, - "resourceIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#ResourceIdentifier", - "traits": { - "smithy.api#documentation": "

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

\n
    \n
  • \n

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

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME\n \n

    \n
    • \n
  • \n

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

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:query-result:*\n

    \n
    • \n
\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#Distribution": { - "type": "enum", - "members": { - "Random": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Random" - } - }, - "ByLogStream": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ByLogStream" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#DynamicTokenPosition": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.cloudwatchlogs#EncryptionKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.cloudwatchlogs#Entity": { - "type": "structure", - "members": { - "keyAttributes": { - "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributes", - "traits": { - "smithy.api#documentation": "

Reserved for internal use.

" - } - }, - "attributes": { - "target": "com.amazonaws.cloudwatchlogs#EntityAttributes", - "traits": { - "smithy.api#documentation": "

Reserved for internal use.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Reserved for internal use.

" - } - }, - "com.amazonaws.cloudwatchlogs#EntityAttributes": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#EntityAttributesKey" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#EntityAttributesValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityAttributesKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityAttributesValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityKeyAttributes": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 3 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType": { - "type": "enum", - "members": { - "INVALID_ENTITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidEntity" - } - }, - "INVALID_TYPE_VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidTypeValue" - } - }, - "INVALID_KEY_ATTRIBUTE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidKeyAttributes" - } - }, - "INVALID_ATTRIBUTES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidAttributes" - } - }, - "ENTITY_SIZE_TOO_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EntitySizeTooLarge" - } - }, - "UNSUPPORTED_LOG_GROUP_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UnsupportedLogGroupType" - } - }, - "MISSING_REQUIRED_FIELDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MissingRequiredFields" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#Enumerations": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#TokenString" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#TokenValue" - } - }, - "com.amazonaws.cloudwatchlogs#EpochMillis": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.cloudwatchlogs#EvaluationFrequency": { - "type": "enum", - "members": { - "ONE_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONE_MIN" - } - }, - "FIVE_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIVE_MIN" - } - }, - "TEN_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEN_MIN" - } - }, - "FIFTEEN_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIFTEEN_MIN" - } - }, - "THIRTY_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THIRTY_MIN" - } - }, - "ONE_HOUR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONE_HOUR" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#EventId": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#EventMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#EventNumber": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.cloudwatchlogs#EventsLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.cloudwatchlogs#ExportDestinationBucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#ExportTask": { - "type": "structure", - "members": { - "taskId": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", - "traits": { - "smithy.api#documentation": "

The ID of the export task.

" - } - }, - "taskName": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskName", - "traits": { - "smithy.api#documentation": "

The name of the export task.

" - } - }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "from": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "to": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "destination": { - "target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "destinationPrefix": { - "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "status": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatus", - "traits": { - "smithy.api#documentation": "

The status of the export task.

" - } - }, - "executionInfo": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo", - "traits": { - "smithy.api#documentation": "

Execution information about the export task.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents an export task.

" - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo": { - "type": "structure", - "members": { - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "completionTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents the status of an export task.

" - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskStatus": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode", - "traits": { - "smithy.api#documentation": "

The status code of the export task.

" - } - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message related to the status code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents the status of an export task.

" - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode": { - "type": "enum", - "members": { - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "PENDING_CANCEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_CANCEL" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskStatusMessage": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#ExportTasks": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#ExportTask" - } - }, - "com.amazonaws.cloudwatchlogs#ExtractedValues": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#Token" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#Value" - } - }, - "com.amazonaws.cloudwatchlogs#Field": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#FieldDelimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.cloudwatchlogs#FieldHeader": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.cloudwatchlogs#FilterCount": { - "type": "integer" - }, - "com.amazonaws.cloudwatchlogs#FilterLogEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#FilterLogEventsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#FilterLogEventsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n

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

\n

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

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#FilterLogEventsRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group to search.

\n \n

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

\n " - } - }, - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#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\n and you are using a monitoring account, you must use the log group ARN.

\n \n

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

\n " - } - }, - "logStreamNames": { - "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "logStreamNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "startTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "endTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", - "traits": { - "smithy.api#documentation": "

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

\n

If not provided, all the events are matched.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#EventsLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "interleaved": { - "target": "com.amazonaws.cloudwatchlogs#Interleaved", - "traits": { - "smithy.api#deprecated": { - "message": "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." - }, - "smithy.api#documentation": "

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

\n

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

" - } - }, - "unmask": { - "target": "com.amazonaws.cloudwatchlogs#Unmask", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#FilterLogEventsResponse": { - "type": "structure", - "members": { - "events": { - "target": "com.amazonaws.cloudwatchlogs#FilteredLogEvents", - "traits": { - "smithy.api#documentation": "

The matched events.

" - } - }, - "searchedLogStreams": { - "target": "com.amazonaws.cloudwatchlogs#SearchedLogStreams", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#FilterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[^:*]*$" - } - }, - "com.amazonaws.cloudwatchlogs#FilterPattern": { - "type": "string", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.cloudwatchlogs#FilteredLogEvent": { - "type": "structure", - "members": { - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage", - "traits": { - "smithy.api#documentation": "

The data contained in the log event.

" - } - }, - "ingestionTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "eventId": { - "target": "com.amazonaws.cloudwatchlogs#EventId", - "traits": { - "smithy.api#documentation": "

The ID of the event.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a matched event.

" - } - }, - "com.amazonaws.cloudwatchlogs#FilteredLogEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#FilteredLogEvent" - } - }, - "com.amazonaws.cloudwatchlogs#ForceUpdate": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a log group data protection policy.

" - } - }, - "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyRequest": { - "type": "structure", - "members": { - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyResponse": { - "type": "structure", - "members": { - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", - "traits": { - "smithy.api#documentation": "

The data protection policy document for this log group.

" - } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDelivery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves complete information about one delivery destination.

" - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyRequest": { - "type": "structure", - "members": { - "deliveryDestinationName": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyResponse": { - "type": "structure", - "members": { - "policy": { - "target": "com.amazonaws.cloudwatchlogs#Policy", - "traits": { - "smithy.api#documentation": "

The IAM policy for this delivery destination.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationResponse": { - "type": "structure", - "members": { - "deliveryDestination": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination", - "traits": { - "smithy.api#documentation": "

A structure containing information about the delivery destination.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryId", - "traits": { - "smithy.api#documentation": "

The ID of the delivery that you want to retrieve.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryResponse": { - "type": "structure", - "members": { - "delivery": { - "target": "com.amazonaws.cloudwatchlogs#Delivery", - "traits": { - "smithy.api#documentation": "

A structure that contains information about the delivery.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliverySource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliverySourceRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliverySourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves complete information about one delivery source.

" - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliverySourceRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliverySourceResponse": { - "type": "structure", - "members": { - "deliverySource": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySource", - "traits": { - "smithy.api#documentation": "

A structure containing information about the delivery source.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves information about the log anomaly detector that you specify.

" - } - }, - "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorRequest": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorResponse": { - "type": "structure", - "members": { - "detectorName": { - "target": "com.amazonaws.cloudwatchlogs#DetectorName", - "traits": { - "smithy.api#documentation": "

The name of the log anomaly detector

" - } - }, - "logGroupArnList": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "evaluationFrequency": { - "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern" - }, - "anomalyDetectorStatus": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "creationTimeStamp": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The date and time when this anomaly detector was created.

" - } - }, - "lastModifiedTimeStamp": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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

" - } - }, - "anomalyVisibilityTime": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetLogEventsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetLogEventsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextForwardToken", - "items": "events", - "pageSize": "limit" - }, - "smithy.test#smokeTests": [ - { - "id": "GetLogEventsFailure", - "params": { - "logGroupName": "fakegroup", - "logStreamName": "fakestream" - }, - "vendorParams": { - "region": "us-west-2" - }, - "vendorParamsShape": "aws.test#AwsVendorParams", - "expect": { - "failure": {} - } - } - ] - } - }, - "com.amazonaws.cloudwatchlogs#GetLogEventsRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

\n \n

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

\n " - } - }, - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n " - } - }, - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "

The name of the log stream.

", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "endTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#EventsLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "startFromHead": { - "target": "com.amazonaws.cloudwatchlogs#StartFromHead", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "unmask": { - "target": "com.amazonaws.cloudwatchlogs#Unmask", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogEventsResponse": { - "type": "structure", - "members": { - "events": { - "target": "com.amazonaws.cloudwatchlogs#OutputLogEvents", - "traits": { - "smithy.api#documentation": "

The events.

" - } - }, - "nextForwardToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextBackwardToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogGroupFields": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group to search.

\n \n

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

\n " - } - }, - "time": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsResponse": { - "type": "structure", - "members": { - "logGroupFields": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupFieldList", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogRecord": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetLogRecordRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetLogRecordResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

The full unparsed log event is returned within @message.

" - } - }, - "com.amazonaws.cloudwatchlogs#GetLogRecordRequest": { - "type": "structure", - "members": { - "logRecordPointer": { - "target": "com.amazonaws.cloudwatchlogs#LogRecordPointer", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "unmask": { - "target": "com.amazonaws.cloudwatchlogs#Unmask", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogRecordResponse": { - "type": "structure", - "members": { - "logRecord": { - "target": "com.amazonaws.cloudwatchlogs#LogRecord", - "traits": { - "smithy.api#documentation": "

The requested log event, as a JSON string.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetQueryResults": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the results from the specified query.

\n

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

\n

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

\n

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#GetQueryResultsRequest": { - "type": "structure", - "members": { - "queryId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "

The ID number of the query.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse": { - "type": "structure", - "members": { - "results": { - "target": "com.amazonaws.cloudwatchlogs#QueryResults", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "statistics": { - "target": "com.amazonaws.cloudwatchlogs#QueryStatistics", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "status": { - "target": "com.amazonaws.cloudwatchlogs#QueryStatus", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "encryptionKey": { - "target": "com.amazonaws.cloudwatchlogs#EncryptionKey", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#Histogram": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#Time" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#Count" - } - }, - "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#InheritedProperties": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#InheritedProperty" - } - }, - "com.amazonaws.cloudwatchlogs#InheritedProperty": { - "type": "enum", - "members": { - "ACCOUNT_DATA_PROTECTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT_DATA_PROTECTION" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#InputLogEvent": { - "type": "structure", - "members": { - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#InputLogEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#InputLogEvent" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.cloudwatchlogs#InputLogStreamNames": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.cloudwatchlogs#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.cloudwatchlogs#Interleaved": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#InvalidOperationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

The operation is not valid on the specified resource.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#InvalidParameterException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

A parameter is specified incorrectly.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#InvalidSequenceTokenException": { - "type": "structure", - "members": { - "expectedSequenceToken": { - "target": "com.amazonaws.cloudwatchlogs#SequenceToken" - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#IsSampled": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.cloudwatchlogs#KmsKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.cloudwatchlogs#LimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#ListAnomalies": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "anomalies", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#ListAnomaliesLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.cloudwatchlogs#ListAnomaliesRequest": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "suppressionState": { - "target": "com.amazonaws.cloudwatchlogs#SuppressionState", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListAnomaliesResponse": { - "type": "structure", - "members": { - "anomalies": { - "target": "com.amazonaws.cloudwatchlogs#Anomalies", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "anomalyDetectors", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsRequest": { - "type": "structure", - "members": { - "filterLogGroupArn": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupArn", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsLimit", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsResponse": { - "type": "structure", - "members": { - "anomalyDetectors": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectors", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

The list of tags associated with the requested resource.>

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsLogGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroupRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API ListTagsForResource" - }, - "smithy.api#documentation": "\n

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

\n \n

Lists the tags for the specified log group.

" - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsLogGroupRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsLogGroupResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

The tags for the log group.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#LiveTailSessionLogEvent": { - "type": "structure", - "members": { - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage", - "traits": { - "smithy.api#documentation": "

The log event message text.

" - } - }, - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp specifying when this log event was created.

" - } - }, - "ingestionTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#LiveTailSessionMetadata": { - "type": "structure", - "members": { - "sampled": { - "target": "com.amazonaws.cloudwatchlogs#IsSampled", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#LiveTailSessionResults": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionLogEvent" - } - }, - "com.amazonaws.cloudwatchlogs#LiveTailSessionStart": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.cloudwatchlogs#RequestId", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "sessionId": { - "target": "com.amazonaws.cloudwatchlogs#SessionId", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "logGroupIdentifiers": { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "logStreamNames": { - "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "logStreamNamePrefixes": { - "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "logEventFilterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#LiveTailSessionUpdate": { - "type": "structure", - "members": { - "sessionMetadata": { - "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionMetadata", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "sessionResults": { - "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionResults", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#LogEvent": { - "type": "structure", - "members": { - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The time stamp of the log event.

" - } - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage", - "traits": { - "smithy.api#documentation": "

The message content of the log event.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This structure contains the information for one sample log event that is associated \n with an anomaly found by a log anomaly detector.

" - } - }, - "com.amazonaws.cloudwatchlogs#LogEventIndex": { - "type": "integer" - }, - "com.amazonaws.cloudwatchlogs#LogGroup": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

" - } - }, - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "retentionInDays": { - "target": "com.amazonaws.cloudwatchlogs#Days" - }, - "metricFilterCount": { - "target": "com.amazonaws.cloudwatchlogs#FilterCount", - "traits": { - "smithy.api#documentation": "

The number of metric filters.

" - } - }, - "arn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log group. This version of the ARN includes a trailing :* after the log group name.

\n

Use this version to refer to the ARN in IAM policies when specifying permissions for most API actions. The exception is when specifying permissions for TagResource, UntagResource, and \n ListTagsForResource. \n The permissions for those three actions require the ARN version that doesn't include a trailing :*.

" - } - }, - "storedBytes": { - "target": "com.amazonaws.cloudwatchlogs#StoredBytes", - "traits": { - "smithy.api#documentation": "

The number of bytes stored.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "dataProtectionStatus": { - "target": "com.amazonaws.cloudwatchlogs#DataProtectionStatus", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "inheritedProperties": { - "target": "com.amazonaws.cloudwatchlogs#InheritedProperties", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "logGroupClass": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", - "traits": { - "smithy.api#documentation": "

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

\n
    \n
  • \n

    The Standard log class supports all CloudWatch Logs features.

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

" - } - }, - "logGroupArn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing :* after the log group name.

\n

Use this version to refer to the ARN in the following situations:

\n
    \n
  • \n

    In the logGroupIdentifier input field in many CloudWatch Logs APIs.

    \n
    • \n
  • \n

    In the resourceArn field in tagging APIs

    \n
    • \n
  • \n

    In IAM policies, when specifying permissions for TagResource, UntagResource, and \n ListTagsForResource.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a log group.

" - } - }, - "com.amazonaws.cloudwatchlogs#LogGroupArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" - } - }, - "com.amazonaws.cloudwatchlogs#LogGroupArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupArn" - } - }, - "com.amazonaws.cloudwatchlogs#LogGroupClass": { - "type": "enum", - "members": { - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STANDARD" - } - }, - "INFREQUENT_ACCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFREQUENT_ACCESS" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#LogGroupField": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#Field", - "traits": { - "smithy.api#documentation": "

The name of a log field.

" - } - }, - "percent": { - "target": "com.amazonaws.cloudwatchlogs#Percentage", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of log events queried that contained the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

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

The name of the log stream.

" - } - }, - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "firstEventTimestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "lastEventTimestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "lastIngestionTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "uploadSequenceToken": { - "target": "com.amazonaws.cloudwatchlogs#SequenceToken", - "traits": { - "smithy.api#documentation": "

The sequence token.

\n \n

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

\n " - } - }, - "arn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "storedBytes": { - "target": "com.amazonaws.cloudwatchlogs#StoredBytes", - "traits": { - "smithy.api#deprecated": { - "message": "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." - }, - "smithy.api#documentation": "

The number of bytes stored.

\n

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#LogStreamName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[^:*]*$" - } - }, - "com.amazonaws.cloudwatchlogs#LogStreamSearchedCompletely": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#LogStreams": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#LogStream" - } - }, - "com.amazonaws.cloudwatchlogs#LogType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\w]*$" - } - }, - "com.amazonaws.cloudwatchlogs#LogTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#LogType" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.cloudwatchlogs#Logs_20140328": { - "type": "service", - "version": "2014-03-28", - "operations": [ - { - "target": "com.amazonaws.cloudwatchlogs#AssociateKmsKey" - }, - { - "target": "com.amazonaws.cloudwatchlogs#CancelExportTask" - }, - { - "target": "com.amazonaws.cloudwatchlogs#CreateDelivery" - }, - { - "target": "com.amazonaws.cloudwatchlogs#CreateExportTask" - }, - { - "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetector" - }, - { - "target": "com.amazonaws.cloudwatchlogs#CreateLogGroup" - }, - { - "target": "com.amazonaws.cloudwatchlogs#CreateLogStream" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteDelivery" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestination" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliverySource" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteDestination" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetector" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogGroup" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogStream" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteMetricFilter" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinition" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteResourcePolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilter" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPolicies" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplates" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveries" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinations" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySources" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeDestinations" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasks" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroups" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeLogStreams" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFilters" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueries" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitions" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePolicies" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFilters" - }, - { - "target": "com.amazonaws.cloudwatchlogs#DisassociateKmsKey" - }, - { - "target": "com.amazonaws.cloudwatchlogs#FilterLogEvents" - }, - { - "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#GetDelivery" - }, - { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestination" - }, - { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#GetDeliverySource" - }, - { - "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector" - }, - { - "target": "com.amazonaws.cloudwatchlogs#GetLogEvents" - }, - { - "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFields" - }, - { - "target": "com.amazonaws.cloudwatchlogs#GetLogRecord" - }, - { - "target": "com.amazonaws.cloudwatchlogs#GetQueryResults" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ListAnomalies" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ListTagsForResource" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroup" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestination" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDeliverySource" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDestination" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDestinationPolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutLogEvents" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutMetricFilter" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinition" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutRetentionPolicy" - }, - { - "target": "com.amazonaws.cloudwatchlogs#PutSubscriptionFilter" - }, - { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTail" - }, - { - "target": "com.amazonaws.cloudwatchlogs#StartQuery" - }, - { - "target": "com.amazonaws.cloudwatchlogs#StopQuery" - }, - { - "target": "com.amazonaws.cloudwatchlogs#TagLogGroup" - }, - { - "target": "com.amazonaws.cloudwatchlogs#TagResource" - }, - { - "target": "com.amazonaws.cloudwatchlogs#TestMetricFilter" - }, - { - "target": "com.amazonaws.cloudwatchlogs#UntagLogGroup" - }, - { - "target": "com.amazonaws.cloudwatchlogs#UntagResource" - }, - { - "target": "com.amazonaws.cloudwatchlogs#UpdateAnomaly" - }, - { - "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfiguration" - }, - { - "target": "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetector" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "CloudWatch Logs", - "arnNamespace": "logs", - "cloudFormationName": "Logs", - "cloudTrailEventSource": "logs.amazonaws.com", - "docId": "logs-2014-03-28", - "endpointPrefix": "logs" - }, - "aws.auth#sigv4": { - "name": "logs" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from\n EC2 instances, CloudTrail, and other sources. You can then retrieve the associated\n log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use\n CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch\n Logs SDK.

\n

You can use CloudWatch Logs to:

\n
    \n
  • \n

    \n Monitor logs from EC2 instances in real time: You\n can use CloudWatch Logs to monitor applications and systems using log data. For example,\n CloudWatch Logs can track the number of errors that occur in your application logs. Then,\n it can send you a notification whenever the rate of errors exceeds a threshold that you\n specify. CloudWatch Logs uses your log data for monitoring so no code changes are\n required. For example, you can monitor application logs for specific literal terms (such\n as \"NullReferenceException\"). You can also count the number of occurrences of a literal\n term at a particular position in log data (such as \"404\" status codes in an Apache access\n log). When the term you are searching for is found, CloudWatch Logs reports the data to a\n CloudWatch metric that you specify.

    \n
    • \n
  • \n

    \n Monitor CloudTrail logged events: You can\n create alarms in CloudWatch and receive notifications of particular API activity as\n captured by CloudTrail. You can use the notification to perform troubleshooting.

    \n
    • \n
  • \n

    \n Archive log data: You can use CloudWatch Logs to\n store your log data in highly durable storage. You can change the log retention setting so\n that any log events earlier than this setting are automatically deleted. The CloudWatch\n Logs agent helps to quickly send both rotated and non-rotated log data off of a host and\n into the log service. You can then access the raw log data when you need it.

    \n
    • \n
", - "smithy.api#title": "Amazon CloudWatch Logs", - "smithy.api#xmlNamespace": { - "uri": "http://monitoring.amazonaws.com/doc/2014-03-28/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://logs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-gov-east-1" - ] - } - ], - "endpoint": { - "url": "https://logs.us-gov-east-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-gov-west-1" - ] - } - ], - "endpoint": { - "url": "https://logs.us-gov-west-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://logs-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://logs.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://logs.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.cloudwatchlogs#MalformedQueryException": { - "type": "structure", - "members": { - "queryCompileError": { - "target": "com.amazonaws.cloudwatchlogs#QueryCompileError" - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

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

\n

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

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#Message": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#MetricFilter": { - "type": "structure", - "members": { - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the metric filter.

" - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern" - }, - "metricTransformations": { - "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", - "traits": { - "smithy.api#documentation": "

The metric transformations.

" - } - }, - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#MetricFilterMatchRecord": { - "type": "structure", - "members": { - "eventNumber": { - "target": "com.amazonaws.cloudwatchlogs#EventNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The event number.

" - } - }, - "eventMessage": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage", - "traits": { - "smithy.api#documentation": "

The raw event data.

" - } - }, - "extractedValues": { - "target": "com.amazonaws.cloudwatchlogs#ExtractedValues", - "traits": { - "smithy.api#documentation": "

The values extracted from the event data by the filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a matched event.

" - } - }, - "com.amazonaws.cloudwatchlogs#MetricFilterMatches": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#MetricFilterMatchRecord" - } - }, - "com.amazonaws.cloudwatchlogs#MetricFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#MetricFilter" - } - }, - "com.amazonaws.cloudwatchlogs#MetricName": { - "type": "string", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[^:*$]*$" - } - }, - "com.amazonaws.cloudwatchlogs#MetricNamespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[^:*$]*$" - } - }, - "com.amazonaws.cloudwatchlogs#MetricTransformation": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.cloudwatchlogs#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the CloudWatch metric.

", - "smithy.api#required": {} - } - }, - "metricNamespace": { - "target": "com.amazonaws.cloudwatchlogs#MetricNamespace", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "metricValue": { - "target": "com.amazonaws.cloudwatchlogs#MetricValue", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "defaultValue": { - "target": "com.amazonaws.cloudwatchlogs#DefaultValue", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "dimensions": { - "target": "com.amazonaws.cloudwatchlogs#Dimensions", - "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n

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

\n

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

\n " - } - }, - "unit": { - "target": "com.amazonaws.cloudwatchlogs#StandardUnit", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#MetricTransformations": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#MetricTransformation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#MetricValue": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The value to publish to the CloudWatch metric. For example, if you're counting the\n occurrences of a term like Error, the value is 1 for each\n occurrence. If you're counting the bytes transferred, the value is the value in the log\n event.

", - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.cloudwatchlogs#NextToken": { - "type": "string", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#OperationAbortedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#OrderBy": { - "type": "enum", - "members": { - "LogStreamName": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LogStreamName" - } - }, - "LastEventTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastEventTime" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#OutputFormat": { - "type": "enum", - "members": { - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "json" - } - }, - "PLAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "plain" - } - }, - "W3C": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "w3c" - } - }, - "RAW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "raw" - } - }, - "PARQUET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "parquet" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#OutputFormats": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#OutputFormat" - } - }, - "com.amazonaws.cloudwatchlogs#OutputLogEvent": { - "type": "structure", - "members": { - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage", - "traits": { - "smithy.api#documentation": "

The data contained in the log event.

" - } - }, - "ingestionTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a log event.

" - } - }, - "com.amazonaws.cloudwatchlogs#OutputLogEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#OutputLogEvent" - } - }, - "com.amazonaws.cloudwatchlogs#PatternId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 32, - "max": 32 - } - } - }, - "com.amazonaws.cloudwatchlogs#PatternRegex": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#PatternString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#PatternToken": { - "type": "structure", - "members": { - "dynamicTokenPosition": { - "target": "com.amazonaws.cloudwatchlogs#DynamicTokenPosition", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For a dynamic token, this indicates where in the pattern that this token appears, related\n to other dynamic tokens. The dynamic token that appears first has a value of 1, the \n one that appears second is 2, and so on.

" - } - }, - "isDynamic": { - "target": "com.amazonaws.cloudwatchlogs#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether this is a dynamic token.

" - } - }, - "tokenString": { - "target": "com.amazonaws.cloudwatchlogs#TokenString", - "traits": { - "smithy.api#documentation": "

The string represented by this token. If this is a dynamic token, the\n value will be <*>\n

" - } - }, - "enumerations": { - "target": "com.amazonaws.cloudwatchlogs#Enumerations", - "traits": { - "smithy.api#documentation": "

Contains the values found for a dynamic token, and the number of times each value was found.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information about one pattern token related to \n an anomaly.

\n

For more information about patterns and tokens, see CreateLogAnomalyDetector.\n

" - } - }, - "com.amazonaws.cloudwatchlogs#PatternTokens": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#PatternToken" - } - }, - "com.amazonaws.cloudwatchlogs#Percentage": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.cloudwatchlogs#Policy": { - "type": "structure", - "members": { - "deliveryDestinationPolicy": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy", - "traits": { - "smithy.api#documentation": "

The contents of the delivery destination policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information about one delivery destination policy.

" - } - }, - "com.amazonaws.cloudwatchlogs#PolicyDocument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5120 - } - } - }, - "com.amazonaws.cloudwatchlogs#PolicyName": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#PolicyType": { - "type": "enum", - "members": { - "DATA_PROTECTION_POLICY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_PROTECTION_POLICY" - } - }, - "SUBSCRIPTION_FILTER_POLICY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUBSCRIPTION_FILTER_POLICY" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#Priority": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#PutAccountPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

\n Data protection policy\n

\n

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

\n \n

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

\n \n

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

\n

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

\n

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

\n

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

\n

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

\n

\n Subscription filter policy\n

\n

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

\n

The following destinations are supported for subscription filters:

\n
    \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest": { - "type": "structure", - "members": { - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "

A name for the policy. This must be unique within the account.

", - "smithy.api#required": {} - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", - "traits": { - "smithy.api#documentation": "

Specify the policy, in JSON.

\n

\n Data protection policy\n

\n

A data protection policy must include two JSON blocks:

\n
    \n
  • \n

    The first block must include both a DataIdentifer array and an \n Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that\n you want to mask. For more information about the available options, see \n Types of data that you can mask.

    \n

    The Operation property with an Audit action is required to find the \n sensitive data terms. This Audit action must contain a FindingsDestination\n object. You can optionally use that FindingsDestination object to list one or more \n destinations to send audit findings to. If you specify destinations such as log groups, \n Firehose streams, and S3 buckets, they must already exist.

    \n
    • \n
  • \n

    The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.

    \n

    The Operation property with the Deidentify action is what actually masks the \n data, and it must \n contain the \n \"MaskConfig\": {} object. The \n \"MaskConfig\": {} object must be empty.

    \n
    • \n
\n

For an example data protection policy, see the Examples section on this page.

\n \n

The contents of the two DataIdentifer arrays must match exactly.

\n \n

In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is different than the \n operation's policyName parameter, and is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.

\n

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

\n

\n Subscription filter policy\n

\n

A subscription filter policy can include the following attributes in a JSON block:

\n
    \n
  • \n

    \n DestinationArn The ARN of the destination\n to deliver log events to. Supported destinations are:

    \n
      \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "policyType": { - "target": "com.amazonaws.cloudwatchlogs#PolicyType", - "traits": { - "smithy.api#documentation": "

The type of policy that you're creating or updating.

", - "smithy.api#required": {} - } - }, - "scope": { - "target": "com.amazonaws.cloudwatchlogs#Scope", - "traits": { - "smithy.api#documentation": "

Currently the only valid value for this parameter is ALL, which specifies that the data \n protection policy applies to all log groups in the account. If you omit this parameter, the default\n of ALL is used.

" - } - }, - "selectionCriteria": { - "target": "com.amazonaws.cloudwatchlogs#SelectionCriteria", - "traits": { - "smithy.api#documentation": "

Use this parameter to apply the subscription filter policy to a subset of log groups in the account.\n Currently, the only supported filter is LogGroupName NOT IN []. The selectionCriteria\n string can be up to 25KB in length. The length is determined by using its UTF-8 bytes.

\n

Using the selectionCriteria parameter is useful to help prevent infinite loops. \n For more information, see Log recursion prevention.

\n

Specifing selectionCriteria is valid only when you specify SUBSCRIPTION_FILTER_POLICY\n for policyType.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutAccountPolicyResponse": { - "type": "structure", - "members": { - "accountPolicy": { - "target": "com.amazonaws.cloudwatchlogs#AccountPolicy", - "traits": { - "smithy.api#documentation": "

The account policy that you created.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n \n

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

\n

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyRequest": { - "type": "structure", - "members": { - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "

Specify either the log group name or log group ARN.

", - "smithy.api#required": {} - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", - "traits": { - "smithy.api#documentation": "

Specify the data protection policy, in JSON.

\n

This policy must include two JSON blocks:

\n
    \n
  • \n

    The first block must include both a DataIdentifer array and an \n Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that\n you want to mask. For more information about the available options, see \n Types of data that you can mask.

    \n

    The Operation property with an Audit action is required to find the \n sensitive data terms. This Audit action must contain a FindingsDestination\n object. You can optionally use that FindingsDestination object to list one or more \n destinations to send audit findings to. If you specify destinations such as log groups, \n Firehose streams, and S3 buckets, they must already exist.

    \n
    • \n
  • \n

    The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.

    \n

    The Operation property with the Deidentify action is what actually masks the \n data, and it must \n contain the \n \"MaskConfig\": {} object. The \n \"MaskConfig\": {} object must be empty.

    \n
    • \n
\n

For an example data protection policy, see the Examples section on this page.

\n \n

The contents of the two DataIdentifer arrays must match exactly.

\n \n

In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.

\n

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyResponse": { - "type": "structure", - "members": { - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", - "traits": { - "smithy.api#documentation": "

The data protection policy used for this log group.

" - } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

    Use PutDeliveryDestination to create a delivery destination, which is a logical object that represents the actual\n delivery destination.

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

\n

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyRequest": { - "type": "structure", - "members": { - "deliveryDestinationName": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "

The name of the delivery destination to assign this policy to.

", - "smithy.api#required": {} - } - }, - "deliveryDestinationPolicy": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy", - "traits": { - "smithy.api#documentation": "

The contents of the policy.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyResponse": { - "type": "structure", - "members": { - "policy": { - "target": "com.amazonaws.cloudwatchlogs#Policy", - "traits": { - "smithy.api#documentation": "

The contents of the policy that you just created.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "

A name for this delivery destination. This name must be unique for all delivery destinations in your account.

", - "smithy.api#required": {} - } - }, - "outputFormat": { - "target": "com.amazonaws.cloudwatchlogs#OutputFormat", - "traits": { - "smithy.api#documentation": "

The format for the logs that this delivery destination will receive.

" - } - }, - "deliveryDestinationConfiguration": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationResponse": { - "type": "structure", - "members": { - "deliveryDestination": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination", - "traits": { - "smithy.api#documentation": "

A structure containing information about the delivery destination that you just created or updated.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliverySource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliverySourceRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliverySourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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:

\n
    \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

\n

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliverySourceRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", - "traits": { - "smithy.api#documentation": "

A name for this delivery source. This name must be unique for all delivery sources in your account.

", - "smithy.api#required": {} - } - }, - "resourceArn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Web Services resource that is generating and sending logs. \n For example, arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234\n

", - "smithy.api#required": {} - } - }, - "logType": { - "target": "com.amazonaws.cloudwatchlogs#LogType", - "traits": { - "smithy.api#documentation": "

Defines the type of log that the source is sending.

\n
    \n
  • \n

    For Amazon Bedrock, the valid value is \n APPLICATION_LOGS.

    \n
    • \n
  • \n

    For Amazon CodeWhisperer, the valid value is \n EVENT_LOGS.

    \n
    • \n
  • \n

    For IAM Identity Center, the valid value is \n ERROR_LOGS.

    \n
    • \n
  • \n

    For Amazon WorkMail, the valid values are \n ACCESS_CONTROL_LOGS, AUTHENTICATION_LOGS, WORKMAIL_AVAILABILITY_PROVIDER_LOGS, and WORKMAIL_MAILBOX_ACCESS_LOGS.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliverySourceResponse": { - "type": "structure", - "members": { - "deliverySource": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySource", - "traits": { - "smithy.api#documentation": "

A structure containing information about the delivery source that was just created or updated.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutDestinationRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutDestinationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With\n a destination, you can subscribe to a real-time stream of log events for a different account,\n ingested using PutLogEvents.

\n

Through an access policy, a destination controls what is written to it.\n By default, PutDestination does not set any access policy with the destination,\n which means a cross-account user cannot call PutSubscriptionFilter against\n this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#PutDestinationPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates an access policy associated with an existing\n destination. An access policy is an IAM policy document that is used\n to authorize claims to register a subscription filter against a given destination.

" - } - }, - "com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest": { - "type": "structure", - "members": { - "destinationName": { - "target": "com.amazonaws.cloudwatchlogs#DestinationName", - "traits": { - "smithy.api#documentation": "

A name for an existing destination.

", - "smithy.api#required": {} - } - }, - "accessPolicy": { - "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", - "traits": { - "smithy.api#documentation": "

An IAM policy document that authorizes cross-account users to deliver their log events\n to the associated destination. This can be up to 5120 bytes.

", - "smithy.api#required": {} - } - }, - "forceUpdate": { - "target": "com.amazonaws.cloudwatchlogs#ForceUpdate", - "traits": { - "smithy.api#documentation": "

Specify true if you are updating an existing destination policy to grant permission to\n an organization ID instead of granting permission to individual Amazon Web Services accounts. Before\n you update a destination policy this way, you must first update the subscription\n filters in the accounts that send logs to this destination. If you do not, the subscription\n filters might stop working. By specifying true\n for forceUpdate, you are affirming that you have already updated the subscription \n filters.\n For more information, see \n Updating an existing cross-account subscription\n

\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDestinationRequest": { - "type": "structure", - "members": { - "destinationName": { - "target": "com.amazonaws.cloudwatchlogs#DestinationName", - "traits": { - "smithy.api#documentation": "

A name for the destination.

", - "smithy.api#required": {} - } - }, - "targetArn": { - "target": "com.amazonaws.cloudwatchlogs#TargetArn", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.cloudwatchlogs#RoleArn", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDestinationResponse": { - "type": "structure", - "members": { - "destination": { - "target": "com.amazonaws.cloudwatchlogs#Destination", - "traits": { - "smithy.api#documentation": "

The destination.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutLogEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutLogEventsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutLogEventsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#DataAlreadyAcceptedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#InvalidSequenceTokenException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#UnrecognizedClientException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n \n

The batch of events must satisfy the following constraints:

\n
    \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

    Each log event can be no larger than 256 KB.

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n \n

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

    \n     \n
    • \n
\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#PutLogEventsRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "

The name of the log stream.

", - "smithy.api#required": {} - } - }, - "logEvents": { - "target": "com.amazonaws.cloudwatchlogs#InputLogEvents", - "traits": { - "smithy.api#documentation": "

The log events.

", - "smithy.api#required": {} - } - }, - "sequenceToken": { - "target": "com.amazonaws.cloudwatchlogs#SequenceToken", - "traits": { - "smithy.api#documentation": "

The sequence token obtained from the response of the previous PutLogEvents\n call.

\n \n

The sequenceToken parameter is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are now accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid.

\n " - } - }, - "entity": { - "target": "com.amazonaws.cloudwatchlogs#Entity", - "traits": { - "smithy.api#documentation": "

Reserved for internal use.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutLogEventsResponse": { - "type": "structure", - "members": { - "nextSequenceToken": { - "target": "com.amazonaws.cloudwatchlogs#SequenceToken", - "traits": { - "smithy.api#documentation": "

The next sequence token.

\n \n

This field has been deprecated.

\n

The sequence token is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are always accepted even if the sequence token is not valid. You can use\n parallel PutLogEvents actions on the same log stream and you do not need\n to wait for the response of a previous PutLogEvents action to obtain \n the nextSequenceToken value.

\n " - } - }, - "rejectedLogEventsInfo": { - "target": "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo", - "traits": { - "smithy.api#documentation": "

The rejected events.

" - } - }, - "rejectedEntityInfo": { - "target": "com.amazonaws.cloudwatchlogs#RejectedEntityInfo", - "traits": { - "smithy.api#documentation": "

Reserved for internal use.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutMetricFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

Using regular expressions to create metric filters is supported. For these filters, \n there is a quotas of quota of two regular expression patterns within a single filter pattern. There\n is also a quota of five regular expression patterns per log group.\n For more information about using regular expressions in metric filters, \n see \n Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.

\n

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

\n \n

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

\n

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

\n

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

\n " - } - }, - "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "

A name for the metric filter.

", - "smithy.api#required": {} - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "metricTransformations": { - "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutQueryDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

" - } - }, - "com.amazonaws.cloudwatchlogs#PutQueryDefinitionRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", - "traits": { - "smithy.api#documentation": "

A name for the query definition. If you are saving numerous query definitions, we\n recommend that you name them. This way, you can find the ones you want by using the first part\n of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

", - "smithy.api#required": {} - } - }, - "queryDefinitionId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "

If you are updating a query definition, use this parameter to specify the ID of the query\n definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query\n definitions.

\n

If you are creating a query definition, do not specify this parameter. CloudWatch\n generates a unique ID for the new query definition and include it in the response to this\n operation.

" - } - }, - "logGroupNames": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", - "traits": { - "smithy.api#documentation": "

Use this parameter to include specific log groups as part of your query definition.

\n

If you are updating a query definition and you omit this parameter, then the updated\n definition will contain no log groups.

" - } - }, - "queryString": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", - "traits": { - "smithy.api#documentation": "

The query string to use for this definition. \n For more information, see CloudWatch Logs Insights Query Syntax.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.cloudwatchlogs#ClientToken", - "traits": { - "smithy.api#documentation": "

Used as an idempotency token, to avoid returning an exception if the service receives the same \n request twice because of a network\n\n error.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutQueryDefinitionResponse": { - "type": "structure", - "members": { - "queryDefinitionId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "

The ID of the query definition.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest": { - "type": "structure", - "members": { - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "

Name of the new policy. This parameter is required.

" - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", - "traits": { - "smithy.api#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.\n This parameter is required.

\n

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

\n

CloudWatch Logs also supports aws:SourceArn\n and aws:SourceAccount\ncondition context keys.

\n

In the example resource policy, you would replace the value of SourceArn with\n the resource making the call from Route 53 to CloudWatch Logs. You would also\n replace the value of SourceAccount with the Amazon Web Services account ID making\n that call.

\n

\n

\n {\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n },\n \"Action\": \"logs:PutLogEvents\",\n \"Resource\": \"logArn\",\n \"Condition\": {\n \"ArnLike\": {\n \"aws:SourceArn\": \"myRoute53ResourceArn\"\n },\n \"StringEquals\": {\n \"aws:SourceAccount\": \"myAwsAccountId\"\n }\n }\n }\n ]\n}\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutResourcePolicyResponse": { - "type": "structure", - "members": { - "resourcePolicy": { - "target": "com.amazonaws.cloudwatchlogs#ResourcePolicy", - "traits": { - "smithy.api#documentation": "

The new policy.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest": { + "type": "structure", + "members": { + "accountIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#AccountIds", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "logGroupNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The prefix to match.

\n \n

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

\n " + } + }, + "logGroupNamePattern": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNamePattern", + "traits": { + "smithy.api#documentation": "

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

\n

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

\n \n

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

\n " + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "includeLinkedAccounts": { + "target": "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts", + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "logGroupClass": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", + "traits": { + "smithy.api#documentation": "

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

\n
    \n
  • \n

    The Standard log class supports all CloudWatch Logs features.

    \n
    • \n
  • \n

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

    \n
    • \n
\n

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogGroupsResponse": { + "type": "structure", + "members": { + "logGroups": { + "target": "com.amazonaws.cloudwatchlogs#LogGroups", + "traits": { + "smithy.api#documentation": "

The log groups.

\n

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogStreams": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogStreamsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogStreamsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the log streams for the specified log group. \n You can list all the log streams or filter the results by prefix.\n You can also control how the results are ordered.

\n

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

\n

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

\n

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

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "logStreams", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogStreamsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

\n \n

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

\n " + } + }, + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

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

\n \n

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

\n " + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The prefix to match.

\n

If orderBy is LastEventTime, you cannot specify this\n parameter.

" + } + }, + "orderBy": { + "target": "com.amazonaws.cloudwatchlogs#OrderBy", + "traits": { + "smithy.api#documentation": "

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

\n

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

\n

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

" + } + }, + "descending": { + "target": "com.amazonaws.cloudwatchlogs#Descending", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogStreamsResponse": { + "type": "structure", + "members": { + "logStreams": { + "target": "com.amazonaws.cloudwatchlogs#LogStreams", + "traits": { + "smithy.api#documentation": "

The log streams.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeMetricFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the specified metric filters. You can list all of the metric filters or filter\n the results by log name, prefix, metric name, or metric namespace. The results are\n ASCII-sorted by filter name.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "metricFilters", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

" + } + }, + "filterNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "metricName": { + "target": "com.amazonaws.cloudwatchlogs#MetricName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "metricNamespace": { + "target": "com.amazonaws.cloudwatchlogs#MetricNamespace", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersResponse": { + "type": "structure", + "members": { + "metricFilters": { + "target": "com.amazonaws.cloudwatchlogs#MetricFilters", + "traits": { + "smithy.api#documentation": "

The metric filters.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueriesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueriesRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesMaxResults", + "traits": { + "smithy.api#documentation": "

Limits the number of returned queries to the specified number.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueriesResponse": { + "type": "structure", + "members": { + "queries": { + "target": "com.amazonaws.cloudwatchlogs#QueryInfoList", + "traits": { + "smithy.api#documentation": "

The list of queries that match the request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsRequest": { + "type": "structure", + "members": { + "queryDefinitionNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#QueryListMaxResults", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsResponse": { + "type": "structure", + "members": { + "queryDefinitions": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionList", + "traits": { + "smithy.api#documentation": "

The list of query definitions that match your request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeResourcePolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the resource policies in this account.

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesResponse": { + "type": "structure", + "members": { + "resourcePolicies": { + "target": "com.amazonaws.cloudwatchlogs#ResourcePolicies", + "traits": { + "smithy.api#documentation": "

The resource policies that exist in this account.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix.\n The results are ASCII-sorted by filter name.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "subscriptionFilters", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "filterNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersResponse": { + "type": "structure", + "members": { + "subscriptionFilters": { + "target": "com.amazonaws.cloudwatchlogs#SubscriptionFilters", + "traits": { + "smithy.api#documentation": "

The subscription filters.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Destination": { + "type": "structure", + "members": { + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the destination.

" + } + }, + "targetArn": { + "target": "com.amazonaws.cloudwatchlogs#TargetArn", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "accessPolicy": { + "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of this destination.

" + } + }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DestinationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#DestinationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[^:*]*$" + } + }, + "com.amazonaws.cloudwatchlogs#Destinations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Destination" + } + }, + "com.amazonaws.cloudwatchlogs#DetectorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Dimensions": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#DimensionsKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#DimensionsValue" + } + }, + "com.amazonaws.cloudwatchlogs#DimensionsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchlogs#DimensionsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchlogs#DisassociateKmsKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates the specified KMS key from the specified log\n group or from all CloudWatch Logs Insights query results in the account.

\n

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

    Specify the resourceIdentifier parameter with the query-result\n resource to stop using the KMS key to encrypt the results of all\n future StartQuery\n 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\n the account are still encrypted with that key. Therefore, CloudWatch Logs will need\n permissions for the key whenever that data is accessed.

    \n
    • \n
\n

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

\n

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

" + } + }, + "resourceIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "

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

\n
    \n
  • \n

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

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME\n \n

    \n
    • \n
  • \n

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

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:query-result:*\n

    \n
    • \n
\n

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#Distribution": { + "type": "enum", + "members": { + "Random": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Random" + } + }, + "ByLogStream": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ByLogStream" + } + } + }, + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#DynamicTokenPosition": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#EncryptionKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#Entity": { + "type": "structure", + "members": { + "keyAttributes": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributes", + "traits": { + "smithy.api#documentation": "

Reserved for internal use.

" + } + }, + "attributes": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributes", + "traits": { + "smithy.api#documentation": "

Reserved for internal use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reserved for internal use.

" + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributesKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributesValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributesKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributesValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType": { + "type": "enum", + "members": { + "INVALID_ENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidEntity" + } + }, + "INVALID_TYPE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidTypeValue" + } + }, + "INVALID_KEY_ATTRIBUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidKeyAttributes" + } + }, + "INVALID_ATTRIBUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidAttributes" + } + }, + "ENTITY_SIZE_TOO_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EntitySizeTooLarge" + } + }, + "UNSUPPORTED_LOG_GROUP_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsupportedLogGroupType" + } + }, + "MISSING_REQUIRED_FIELDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingRequiredFields" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#Enumerations": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#TokenString" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#TokenValue" + } + }, + "com.amazonaws.cloudwatchlogs#EpochMillis": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudwatchlogs#EvaluationFrequency": { + "type": "enum", + "members": { + "ONE_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_MIN" + } + }, + "FIVE_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIVE_MIN" + } + }, + "TEN_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEN_MIN" + } + }, + "FIFTEEN_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIFTEEN_MIN" + } + }, + "THIRTY_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIRTY_MIN" + } + }, + "ONE_HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_HOUR" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#EventId": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#EventMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#EventNumber": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#EventsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportDestinationBucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#ExportTask": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The ID of the export task.

" + } + }, + "taskName": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskName", + "traits": { + "smithy.api#documentation": "

The name of the export task.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "from": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "to": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "destination": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "destinationPrefix": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatus", + "traits": { + "smithy.api#documentation": "

The status of the export task.

" + } + }, + "executionInfo": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo", + "traits": { + "smithy.api#documentation": "

Execution information about the export task.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an export task.

" + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo": { + "type": "structure", + "members": { + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "completionTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the status of an export task.

" + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskStatus": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode", + "traits": { + "smithy.api#documentation": "

The status code of the export task.

" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message related to the status code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the status of an export task.

" + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode": { + "type": "enum", + "members": { + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "PENDING_CANCEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CANCEL" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskStatusMessage": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#ExportTasks": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ExportTask" + } + }, + "com.amazonaws.cloudwatchlogs#ExtractedValues": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#Token" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#Value" + } + }, + "com.amazonaws.cloudwatchlogs#Field": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#FieldDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#FieldHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.cloudwatchlogs#FilterCount": { + "type": "integer" + }, + "com.amazonaws.cloudwatchlogs#FilterLogEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#FilterLogEventsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#FilterLogEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n

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

\n

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

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#FilterLogEventsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group to search.

\n \n

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

\n " + } + }, + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#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\n and you are using a monitoring account, you must use the log group ARN.

\n \n

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

\n " + } + }, + "logStreamNames": { + "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "startTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "endTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

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

\n

If not provided, all the events are matched.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "interleaved": { + "target": "com.amazonaws.cloudwatchlogs#Interleaved", + "traits": { + "smithy.api#deprecated": { + "message": "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." + }, + "smithy.api#documentation": "

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

\n

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

" + } + }, + "unmask": { + "target": "com.amazonaws.cloudwatchlogs#Unmask", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

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

\n

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#FilterLogEventsResponse": { + "type": "structure", + "members": { + "events": { + "target": "com.amazonaws.cloudwatchlogs#FilteredLogEvents", + "traits": { + "smithy.api#documentation": "

The matched events.

" + } + }, + "searchedLogStreams": { + "target": "com.amazonaws.cloudwatchlogs#SearchedLogStreams", + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#FilterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[^:*]*$" + } + }, + "com.amazonaws.cloudwatchlogs#FilterPattern": { + "type": "string", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.cloudwatchlogs#FilteredLogEvent": { + "type": "structure", + "members": { + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The data contained in the log event.

" + } + }, + "ingestionTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "eventId": { + "target": "com.amazonaws.cloudwatchlogs#EventId", + "traits": { + "smithy.api#documentation": "

The ID of the event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a matched event.

" + } + }, + "com.amazonaws.cloudwatchlogs#FilteredLogEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#FilteredLogEvent" + } + }, + "com.amazonaws.cloudwatchlogs#ForceUpdate": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a log group data protection policy.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyResponse": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", + "traits": { + "smithy.api#documentation": "

The data protection policy document for this log group.

" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDelivery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

\n

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

" + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves complete information about one delivery destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyRequest": { + "type": "structure", + "members": { + "deliveryDestinationName": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyResponse": { + "type": "structure", + "members": { + "policy": { + "target": "com.amazonaws.cloudwatchlogs#Policy", + "traits": { + "smithy.api#documentation": "

The IAM policy for this delivery destination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationResponse": { + "type": "structure", + "members": { + "deliveryDestination": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination", + "traits": { + "smithy.api#documentation": "

A structure containing information about the delivery destination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "

The ID of the delivery that you want to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryResponse": { + "type": "structure", + "members": { + "delivery": { + "target": "com.amazonaws.cloudwatchlogs#Delivery", + "traits": { + "smithy.api#documentation": "

A structure that contains information about the delivery.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliverySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliverySourceRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliverySourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves complete information about one delivery source.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliverySourceRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliverySourceResponse": { + "type": "structure", + "members": { + "deliverySource": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySource", + "traits": { + "smithy.api#documentation": "

A structure containing information about the delivery source.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the log anomaly detector that you specify.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorResponse": { + "type": "structure", + "members": { + "detectorName": { + "target": "com.amazonaws.cloudwatchlogs#DetectorName", + "traits": { + "smithy.api#documentation": "

The name of the log anomaly detector

" + } + }, + "logGroupArnList": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "anomalyDetectorStatus": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "creationTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The date and time when this anomaly detector was created.

" + } + }, + "lastModifiedTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

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

" + } + }, + "anomalyVisibilityTime": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogEventsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextForwardToken", + "items": "events", + "pageSize": "limit" + }, + "smithy.test#smokeTests": [ + { + "id": "GetLogEventsFailure", + "params": { + "logGroupName": "fakegroup", + "logStreamName": "fakestream" + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ] + } + }, + "com.amazonaws.cloudwatchlogs#GetLogEventsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

\n \n

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

\n " + } + }, + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

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

\n \n

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

\n " + } + }, + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "endTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimit", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "startFromHead": { + "target": "com.amazonaws.cloudwatchlogs#StartFromHead", + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "unmask": { + "target": "com.amazonaws.cloudwatchlogs#Unmask", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

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

\n

To use this operation with this parameter, you must be signed into an account with the logs:Unmask\n permission.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogEventsResponse": { + "type": "structure", + "members": { + "events": { + "target": "com.amazonaws.cloudwatchlogs#OutputLogEvents", + "traits": { + "smithy.api#documentation": "

The events.

" + } + }, + "nextForwardToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items in the forward direction. The token expires after\n 24 hours. If you have reached the end of the stream, it returns the same token you passed\n in.

" + } + }, + "nextBackwardToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items in the backward direction. The token expires after\n 24 hours. This token is not null. If you have reached the end of the stream, it returns the\n same token you passed in.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogGroupFields": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the fields that are included in log events in the specified log group.\n Includes the percentage of log events that contain each field. The search is limited to a time\n period that you specify.

\n

You can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must specify one of these parameters, but you can't specify both.\n

\n

In the results, fields that start with @ are fields generated by CloudWatch\n Logs. For example, @timestamp is the timestamp of each log event. For more\n information about the fields that are generated by CloudWatch logs, see Supported\n Logs and Discovered Fields.

\n

The response results are sorted by the frequency percentage, starting \n with the highest percentage.

\n

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group to search.

\n \n

\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n

\n " + } + }, + "time": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time to set as the center of the query. If you specify time, the 8 minutes before and\n 8 minutes after this time are searched. If you omit time, the most recent 15 minutes\n up to the current time are searched.

\n

The time value is specified as epoch time, which is the number of seconds\n since January 1, 1970, 00:00:00 UTC.

" + } + }, + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

Specify either the name or ARN of the log group to view. If the log group is in a source account and\n you are using a monitoring account, you must specify the ARN.

\n \n

\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsResponse": { + "type": "structure", + "members": { + "logGroupFields": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupFieldList", + "traits": { + "smithy.api#documentation": "

The array of fields found in the query. Each object in the array contains the name of the\n field, along with the percentage of time it appeared in the log events that were\n queried.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogRecord": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogRecordRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogRecordResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves all of the fields and values of a single log event. All fields are retrieved,\n even if the original query that produced the logRecordPointer retrieved only a\n subset of fields. Fields are returned as field name/field value pairs.

\n

The full unparsed log event is returned within @message.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetLogRecordRequest": { + "type": "structure", + "members": { + "logRecordPointer": { + "target": "com.amazonaws.cloudwatchlogs#LogRecordPointer", + "traits": { + "smithy.api#documentation": "

The pointer corresponding to the log event record you want to retrieve. You get this from\n the response of a GetQueryResults operation. In that response, the value of the\n @ptr field for a log event is the value to use as logRecordPointer\n to retrieve that complete log event record.

", + "smithy.api#required": {} + } + }, + "unmask": { + "target": "com.amazonaws.cloudwatchlogs#Unmask", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specify true to display the log event fields with all sensitive data unmasked and visible.\n The default is false.

\n

To use this operation with this parameter, you must be signed into an account with the logs:Unmask\n permission.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogRecordResponse": { + "type": "structure", + "members": { + "logRecord": { + "target": "com.amazonaws.cloudwatchlogs#LogRecord", + "traits": { + "smithy.api#documentation": "

The requested log event, as a JSON string.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetQueryResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the results from the specified query.

\n

Only the fields requested in the query are returned, along with a @ptr\n field, which is the identifier for the log record. You can use the value of @ptr\n in a GetLogRecord\n operation to get the full log record.

\n

\n GetQueryResults does not start running a query. To run a query, use StartQuery. For more information about how long results of previous queries\n are available, see CloudWatch Logs quotas.

\n

If the value of the Status field in the output is Running, this operation \n returns only partial results. If you see a value of Scheduled or Running for the status, \n you can retry the operation later to see the final results.

\n

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start \n queries in linked source accounts. For more information, see \n CloudWatch cross-account observability.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetQueryResultsRequest": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The ID number of the query.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse": { + "type": "structure", + "members": { + "results": { + "target": "com.amazonaws.cloudwatchlogs#QueryResults", + "traits": { + "smithy.api#documentation": "

The log events that matched the query criteria during the most recent time it ran.

\n

The results value is an array of arrays. Each log event is one object in the\n top-level array. Each of these log event objects is an array of\n field/value pairs.

" + } + }, + "statistics": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatistics", + "traits": { + "smithy.api#documentation": "

Includes the number of log events scanned by the query, the number of log events that\n matched the query criteria, and the total number of bytes in the scanned log events. These\n values reflect the full raw results of the query.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of the most recent running of the query. Possible values are Cancelled, \n Complete, Failed, Running, Scheduled, \n Timeout, and Unknown.

\n

Queries time out after 60 minutes of runtime. To avoid having your queries time out,\n reduce the time range being searched or partition your query into a number of queries.

" + } + }, + "encryptionKey": { + "target": "com.amazonaws.cloudwatchlogs#EncryptionKey", + "traits": { + "smithy.api#documentation": "

If you associated an KMS key with the CloudWatch Logs Insights\n query results in this account, this field displays the ARN of the key that's used to encrypt\n the query results when StartQuery stores\n them.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#Histogram": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#Time" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#Count" + } + }, + "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#InferredTokenName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#InheritedProperties": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#InheritedProperty" + } + }, + "com.amazonaws.cloudwatchlogs#InheritedProperty": { + "type": "enum", + "members": { + "ACCOUNT_DATA_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_DATA_PROTECTION" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#InputLogEvent": { + "type": "structure", + "members": { + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the event occurred, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The raw event message. Each log event can be no larger than 256 KB.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a log event, which is a record of activity that was recorded \n by the application or resource being monitored.

" + } + }, + "com.amazonaws.cloudwatchlogs#InputLogEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#InputLogEvent" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.cloudwatchlogs#InputLogStreamNames": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#Interleaved": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#InvalidOperationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The operation is not valid on the specified resource.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

A parameter is specified incorrectly.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#InvalidSequenceTokenException": { + "type": "structure", + "members": { + "expectedSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken" + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The sequence token is not valid. You can get the correct sequence token in \n the expectedSequenceToken field in the InvalidSequenceTokenException\n message.

\n \n

\n PutLogEvents\n actions are now always accepted and never return\n InvalidSequenceTokenException regardless of receiving an invalid sequence token.

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#IsSampled": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudwatchlogs#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

You have reached the maximum number of resources that can be created.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomalies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of\n each anomaly object that is returned, see the example in this section.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "anomalies", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomaliesLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomaliesRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

Use this to optionally limit the results to only the anomalies found by a certain \n anomaly detector.

" + } + }, + "suppressionState": { + "target": "com.amazonaws.cloudwatchlogs#SuppressionState", + "traits": { + "smithy.api#documentation": "

You can specify this parameter if you want to the operation to return only anomalies that \n are currently either suppressed or unsuppressed.

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return. If you don't specify a value, the default maximum value of \n 50 items is used.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomaliesResponse": { + "type": "structure", + "members": { + "anomalies": { + "target": "com.amazonaws.cloudwatchlogs#Anomalies", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure contains information about one anomaly that a log\n anomaly detector has found.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the log anomaly detectors in the account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "anomalyDetectors", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsRequest": { + "type": "structure", + "members": { + "filterLogGroupArn": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArn", + "traits": { + "smithy.api#documentation": "

Use this to optionally filter the results to only include anomaly detectors that are associated with the \n specified log group.

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return. If you don't specify a value, the default maximum value of \n 50 items is used.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsResponse": { + "type": "structure", + "members": { + "anomalyDetectors": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectors", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure in the array contains information about one anomaly detector.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays the tags associated with a CloudWatch Logs resource. Currently, log groups \n and destinations support tagging.

" + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that you want to view tags for.

\n

The ARN format of a log group is \n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n

\n

The ARN format of a destination is \n arn:aws:logs:Region:account-id:destination:destination-name\n \n

\n

For more information about ARN format, see CloudWatch Logs \n resources and operations.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The list of tags associated with the requested resource.>

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroupRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API ListTagsForResource" }, - "com.amazonaws.cloudwatchlogs#PutRetentionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutRetentionPolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Sets the retention of the specified log group. With a retention policy, you can\n configure the number of days for which to retain log events in the specified log\n group.

\n \n

CloudWatch Logs doesn’t immediately delete log events when they reach their retention\n setting. It typically takes up to 72 hours after that before log events are deleted, but in\n rare situations might take longer.

\n

To illustrate, imagine that you change a log group to have a longer retention setting\n when it contains log events that are past the expiration date, but haven’t been deleted.\n Those log events will take up to 72 hours to be deleted after the new retention date is\n reached. To make sure that log data is deleted permanently, keep a log group at its lower\n retention setting until 72 hours after the previous retention period ends. Alternatively,\n wait to change the retention setting until you confirm that the earlier log events are\n deleted.

\n

When log events reach their retention setting they are marked for deletion. After\n they are marked for deletion, they do not add to your archival storage costs anymore, even if \n they are not actually deleted until later. These log events marked for deletion are also not \n included when you use an API to retrieve the storedBytes value to see how many bytes a log group is storing.

\n " - } + "smithy.api#documentation": "\n

The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use \n ListTagsForResource instead.

\n \n

Lists the tags for the specified log group.

" + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" }, - "com.amazonaws.cloudwatchlogs#PutRetentionPolicyRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "retentionInDays": { - "target": "com.amazonaws.cloudwatchlogs#Days", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsLogGroupResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The tags for the log group.

" + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" }, - "com.amazonaws.cloudwatchlogs#PutSubscriptionFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates a subscription filter and associates it with the specified log\n group. With subscription filters, you can subscribe to a real-time stream of log events\n ingested through PutLogEvents\n and have them delivered to a specific destination. When log events are sent to the receiving\n service, they are Base64 encoded and compressed with the GZIP format.

\n

The following destinations are supported for subscription filters:

\n
    \n
  • \n

    An Amazon Kinesis data stream belonging to the same account as the subscription\n filter, for same-account delivery.

    \n
    • \n
  • \n

    A logical destination created with PutDestination that belongs to a different account, for cross-account delivery.\n We currently support Kinesis Data Streams and Firehose as logical destinations.

    \n
    • \n
  • \n

    An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as\n the subscription filter, for same-account delivery.

    \n
    • \n
  • \n

    An Lambda function that belongs to the same account as the\n subscription filter, for same-account delivery.

    \n
    • \n
\n

Each log group can have up to two subscription filters associated with it. If you are\n updating an existing filter, you must specify the correct name in filterName.\n

\n

Using regular expressions to create subscription filters is supported. For these filters, \n there is a quotas of quota of two regular expression patterns within a single filter pattern. There\n is also a quota of five regular expression patterns per log group.\n For more information about using regular expressions in subscription filters, \n see \n Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.

\n

To perform a PutSubscriptionFilter operation for any destination except a Lambda function, \n you must also have the \n iam:PassRole permission.

" - } + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionLogEvent": { + "type": "structure", + "members": { + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream that ingested this log event.

" + } + }, + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The name or ARN of the log group that ingested this log event.

" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The log event message text.

" + } + }, + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp specifying when this log event was created.

" + } + }, + "ingestionTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp specifying when this log event was ingested into the log group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This object contains the information for one log event returned in a Live Tail stream.

" + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionMetadata": { + "type": "structure", + "members": { + "sampled": { + "target": "com.amazonaws.cloudwatchlogs#IsSampled", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If this is true, then more than 500 log events matched the request for this update, and the \n sessionResults includes a sample of 500 of those events.

\n

If this is false, then 500 or fewer log events matched the request for this update, so no sampling\n was necessary. In this case, the \n sessionResults array includes all log events that matched your request during this time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This object contains the metadata for one LiveTailSessionUpdate structure. It indicates whether\n that update includes only a sample of 500 log events out of a larger number of ingested log events, or if it contains\n all of the matching log events ingested during that second of time.

" + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionResults": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionLogEvent" + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionStart": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.cloudwatchlogs#RequestId", + "traits": { + "smithy.api#documentation": "

The unique ID generated by CloudWatch Logs to identify this Live Tail session request.

" + } + }, + "sessionId": { + "target": "com.amazonaws.cloudwatchlogs#SessionId", + "traits": { + "smithy.api#documentation": "

The unique ID generated by CloudWatch Logs to identify this Live Tail session.

" + } + }, + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

An array of the names and ARNs of the log groups included in this Live Tail session.

" + } + }, + "logStreamNames": { + "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", + "traits": { + "smithy.api#documentation": "

If your StartLiveTail operation request included a logStreamNames parameter that filtered the session\n to only include certain log streams, these streams are listed here.

" + } + }, + "logStreamNamePrefixes": { + "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", + "traits": { + "smithy.api#documentation": "

If your StartLiveTail operation request included a logStreamNamePrefixes parameter that filtered the session\n to only include log streams that have names that start with certain prefixes, these prefixes are listed here.

" + } + }, + "logEventFilterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

An optional pattern to filter the results to include only log events that match the pattern.\n For example, a filter pattern of error 404 displays only log events that include both error \n and 404.

\n

For more information about filter pattern syntax, see Filter and Pattern Syntax.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This object contains information about this Live Tail session, including the log groups included and the \n log stream filters, if any.

" + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionUpdate": { + "type": "structure", + "members": { + "sessionMetadata": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionMetadata", + "traits": { + "smithy.api#documentation": "

This object contains the session metadata for a Live Tail session.

" + } + }, + "sessionResults": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionResults", + "traits": { + "smithy.api#documentation": "

An array, where each member of the array includes the information for one log event in the Live Tail session.

\n

A sessionResults array can include as many as 500 log events. If the number of \n log events matching the request exceeds 500 per second, the\n log events are sampled down to 500 log events to be included in each sessionUpdate structure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This object contains the log events and metadata for a Live Tail session.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogEvent": { + "type": "structure", + "members": { + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time stamp of the log event.

" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The message content of the log event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure contains the information for one sample log event that is associated \n with an anomaly found by a log anomaly detector.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogEventIndex": { + "type": "integer" + }, + "com.amazonaws.cloudwatchlogs#LogGroup": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

" + } + }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the log group, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.

" + } + }, + "retentionInDays": { + "target": "com.amazonaws.cloudwatchlogs#Days" + }, + "metricFilterCount": { + "target": "com.amazonaws.cloudwatchlogs#FilterCount", + "traits": { + "smithy.api#documentation": "

The number of metric filters.

" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log group. This version of the ARN includes a trailing :* after the log group name.

\n

Use this version to refer to the ARN in IAM policies when specifying permissions for most API actions. The exception is when specifying permissions for TagResource, UntagResource, and \n ListTagsForResource. \n The permissions for those three actions require the ARN version that doesn't include a trailing :*.

" + } + }, + "storedBytes": { + "target": "com.amazonaws.cloudwatchlogs#StoredBytes", + "traits": { + "smithy.api#documentation": "

The number of bytes stored.

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key to use when\n encrypting log data.

" + } + }, + "dataProtectionStatus": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionStatus", + "traits": { + "smithy.api#documentation": "

Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see \n PutDataProtectionPolicy.

" + } + }, + "inheritedProperties": { + "target": "com.amazonaws.cloudwatchlogs#InheritedProperties", + "traits": { + "smithy.api#documentation": "

Displays all the properties that this log group has inherited from account-level \n settings.

" + } + }, + "logGroupClass": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", + "traits": { + "smithy.api#documentation": "

This specifies the log group class for this log group. There are two classes:

\n
    \n
  • \n

    The Standard log class supports all CloudWatch Logs features.

    \n
    • \n
  • \n

    The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.

    \n
    • \n
\n

For details about the features supported by each class, see \n Log classes\n

" + } + }, + "logGroupArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing :* after the log group name.

\n

Use this version to refer to the ARN in the following situations:

\n
    \n
  • \n

    In the logGroupIdentifier input field in many CloudWatch Logs APIs.

    \n
    • \n
  • \n

    In the resourceArn field in tagging APIs

    \n
    • \n
  • \n

    In IAM policies, when specifying permissions for TagResource, UntagResource, and \n ListTagsForResource.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a log group.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArn" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupClass": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "INFREQUENT_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFREQUENT_ACCESS" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#Field", + "traits": { + "smithy.api#documentation": "

The name of a log field.

" + } + }, + "percent": { + "target": "com.amazonaws.cloudwatchlogs#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of log events queried that contained the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The fields contained in log events found by a GetLogGroupFields operation,\n along with the percentage of queried log events in which each field appears.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupField" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupNamePattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupNames": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroup" + } + }, + "com.amazonaws.cloudwatchlogs#LogRecord": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#Field" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#Value" + } + }, + "com.amazonaws.cloudwatchlogs#LogRecordPointer": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#LogSamples": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogEvent" + } + }, + "com.amazonaws.cloudwatchlogs#LogStream": { + "type": "structure", + "members": { + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

" + } + }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the stream, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.

" + } + }, + "firstEventTimestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time of the first event, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.

" + } + }, + "lastEventTimestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time of the most recent log event in the log stream in CloudWatch Logs. This number\n is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The\n lastEventTime value updates on an eventual consistency basis. It typically\n updates in less than an hour from ingestion, but in rare situations might take\n longer.

" + } + }, + "lastIngestionTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The ingestion time, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC The lastIngestionTime value updates on an eventual consistency basis. It \n typically updates in less than an hour after ingestion, but in rare situations might take longer.

" + } + }, + "uploadSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken", + "traits": { + "smithy.api#documentation": "

The sequence token.

\n \n

The sequence token is now ignored in \n PutLogEvents\n actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. \n You don't need to obtain uploadSequenceToken to use a PutLogEvents action.

\n " + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log stream.

" + } + }, + "storedBytes": { + "target": "com.amazonaws.cloudwatchlogs#StoredBytes", + "traits": { + "smithy.api#deprecated": { + "message": "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." + }, + "smithy.api#documentation": "

The number of bytes stored.

\n

\n Important: As of June 17, 2019, this parameter is no\n longer supported for log streams, and is always reported as zero. This change applies only to\n log streams. The storedBytes parameter for log groups is not affected.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a log stream, which is a sequence of log events from \n a single emitter of logs.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogStreamName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[^:*]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogStreamSearchedCompletely": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#LogStreams": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogStream" + } + }, + "com.amazonaws.cloudwatchlogs#LogType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#Logs_20140328": { + "type": "service", + "version": "2014-03-28", + "operations": [ + { + "target": "com.amazonaws.cloudwatchlogs#AssociateKmsKey" }, - "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "

A name for the subscription filter. If you are updating an existing filter, you must\n specify the correct name in filterName. To find the name of the filter currently\n associated with a log group, use DescribeSubscriptionFilters.

", - "smithy.api#required": {} - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", - "traits": { - "smithy.api#documentation": "

A filter pattern for subscribing to a filtered stream of log events.

", - "smithy.api#required": {} - } - }, - "destinationArn": { - "target": "com.amazonaws.cloudwatchlogs#DestinationArn", - "traits": { - "smithy.api#documentation": "

The ARN of the destination to deliver matching log events to. Currently, the supported\n destinations are:

\n
    \n
  • \n

    An Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
  • \n

    A logical destination (specified using an ARN) belonging to a different account, \n for cross-account delivery.

    \n

    If you're setting up a cross-account subscription, the destination must have an IAM\n policy associated with it. The IAM policy must allow the sender to send logs to the\n destination. For more information, see PutDestinationPolicy.

    \n
    • \n
  • \n

    A Kinesis Data Firehose delivery stream belonging to the same account as the\n subscription filter, for same-account delivery.

    \n
    • \n
  • \n

    A Lambda function belonging to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.cloudwatchlogs#RoleArn", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log\n events to the destination stream. You don't need to provide the ARN when you are working with\n a logical destination for cross-account delivery.

" - } - }, - "distribution": { - "target": "com.amazonaws.cloudwatchlogs#Distribution", - "traits": { - "smithy.api#documentation": "

The method used to distribute log data to the destination. By default, log data is\n grouped by log stream, but the grouping can be set to random for a more even distribution.\n This property is only applicable when the destination is an Amazon Kinesis data stream.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.cloudwatchlogs#CancelExportTask" }, - "com.amazonaws.cloudwatchlogs#QueryCharOffset": { - "type": "integer" + { + "target": "com.amazonaws.cloudwatchlogs#CreateDelivery" }, - "com.amazonaws.cloudwatchlogs#QueryCompileError": { - "type": "structure", - "members": { - "location": { - "target": "com.amazonaws.cloudwatchlogs#QueryCompileErrorLocation", - "traits": { - "smithy.api#documentation": "

Reserved.

" - } - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message", - "traits": { - "smithy.api#documentation": "

Reserved.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Reserved.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#CreateExportTask" }, - "com.amazonaws.cloudwatchlogs#QueryCompileErrorLocation": { - "type": "structure", - "members": { - "startCharOffset": { - "target": "com.amazonaws.cloudwatchlogs#QueryCharOffset", - "traits": { - "smithy.api#documentation": "

Reserved.

" - } - }, - "endCharOffset": { - "target": "com.amazonaws.cloudwatchlogs#QueryCharOffset", - "traits": { - "smithy.api#documentation": "

Reserved.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Reserved.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetector" }, - "com.amazonaws.cloudwatchlogs#QueryDefinition": { - "type": "structure", - "members": { - "queryDefinitionId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "

The unique ID of the query definition.

" - } - }, - "name": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", - "traits": { - "smithy.api#documentation": "

The name of the query definition.

" - } - }, - "queryString": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", - "traits": { - "smithy.api#documentation": "

The query string to use for this definition.\n For more information, see CloudWatch Logs Insights Query Syntax.

" - } - }, - "lastModified": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the query definition was most recently modified.

" - } - }, - "logGroupNames": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", - "traits": { - "smithy.api#documentation": "

If this query definition contains a list of log groups that it is limited to, that list appears here.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This structure contains details about a saved CloudWatch Logs Insights query definition.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#CreateLogGroup" }, - "com.amazonaws.cloudwatchlogs#QueryDefinitionList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinition" - } + { + "target": "com.amazonaws.cloudwatchlogs#CreateLogStream" }, - "com.amazonaws.cloudwatchlogs#QueryDefinitionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy" }, - "com.amazonaws.cloudwatchlogs#QueryDefinitionString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicy" }, - "com.amazonaws.cloudwatchlogs#QueryId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDelivery" }, - "com.amazonaws.cloudwatchlogs#QueryInfo": { - "type": "structure", - "members": { - "queryId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "

The unique ID number of this query.

" - } - }, - "queryString": { - "target": "com.amazonaws.cloudwatchlogs#QueryString", - "traits": { - "smithy.api#documentation": "

The query string used in this query.

" - } - }, - "status": { - "target": "com.amazonaws.cloudwatchlogs#QueryStatus", - "traits": { - "smithy.api#documentation": "

The status of this query. Possible values are Cancelled,\n Complete, Failed, Running, Scheduled, and Unknown.

" - } - }, - "createTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that this query was created.

" - } - }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group scanned by this query.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestination" }, - "com.amazonaws.cloudwatchlogs#QueryInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#QueryInfo" - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicy" }, - "com.amazonaws.cloudwatchlogs#QueryListMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliverySource" }, - "com.amazonaws.cloudwatchlogs#QueryResults": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#ResultRows" - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDestination" }, - "com.amazonaws.cloudwatchlogs#QueryStatistics": { - "type": "structure", - "members": { - "recordsMatched": { - "target": "com.amazonaws.cloudwatchlogs#StatsValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of log events that matched the query string.

" - } - }, - "recordsScanned": { - "target": "com.amazonaws.cloudwatchlogs#StatsValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of log events scanned during the query.

" - } - }, - "bytesScanned": { - "target": "com.amazonaws.cloudwatchlogs#StatsValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of bytes in the log events scanned during the query.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the number of log events scanned by the query, the number of log events that matched the \n query criteria, and the total number of bytes in the log events that were scanned.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetector" }, - "com.amazonaws.cloudwatchlogs#QueryStatus": { - "type": "enum", - "members": { - "Scheduled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Scheduled" - } - }, - "Running": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Running" - } - }, - "Complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Complete" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Cancelled" - } - }, - "Timeout": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Timeout" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unknown" - } - } - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogGroup" }, - "com.amazonaws.cloudwatchlogs#QueryString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogStream" }, - "com.amazonaws.cloudwatchlogs#RecordField": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#FieldHeader", - "traits": { - "smithy.api#documentation": "

The name to use when specifying this record field in a \n CreateDelivery or \n UpdateDeliveryConfiguration operation.

" - } - }, - "mandatory": { - "target": "com.amazonaws.cloudwatchlogs#Boolean", - "traits": { - "smithy.api#documentation": "

If this is true, the record field must be present in the recordFields parameter provided to a \n CreateDelivery or \n UpdateDeliveryConfiguration operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a valid record field header and whether it is mandatory.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteMetricFilter" }, - "com.amazonaws.cloudwatchlogs#RecordFields": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#FieldHeader" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinition" }, - "com.amazonaws.cloudwatchlogs#RejectedEntityInfo": { - "type": "structure", - "members": { - "errorType": { - "target": "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType", - "traits": { - "smithy.api#documentation": "

Reserved for internal use.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Reserved for internal use.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteResourcePolicy" }, - "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo": { - "type": "structure", - "members": { - "tooNewLogEventStartIndex": { - "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", - "traits": { - "smithy.api#documentation": "

The index of the first log event that is too new. This field is inclusive.

" - } - }, - "tooOldLogEventEndIndex": { - "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", - "traits": { - "smithy.api#documentation": "

The index of the last log event that is too old. This field is exclusive.

" - } - }, - "expiredLogEventEndIndex": { - "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", - "traits": { - "smithy.api#documentation": "

The expired log events.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents the rejected events.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicy" }, - "com.amazonaws.cloudwatchlogs#RequestId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilter" }, - "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource already exists.

", - "smithy.api#error": "client" - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPolicies" }, - "com.amazonaws.cloudwatchlogs#ResourceArns": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#Arn" - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplates" }, - "com.amazonaws.cloudwatchlogs#ResourceIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[\\w+=/:,.@\\-\\*]*$" - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveries" }, - "com.amazonaws.cloudwatchlogs#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource does not exist.

", - "smithy.api#error": "client" - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinations" }, - "com.amazonaws.cloudwatchlogs#ResourcePolicies": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#ResourcePolicy" - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySources" }, - "com.amazonaws.cloudwatchlogs#ResourcePolicy": { - "type": "structure", - "members": { - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "

The name of the resource policy.

" - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", - "traits": { - "smithy.api#documentation": "

The details of the policy.

" - } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

Timestamp showing when this policy was last updated, expressed as the number of\n milliseconds after Jan 1, 1970 00:00:00 UTC.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A policy enabling one or more entities to put logs to a log group in this account.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDestinations" }, - "com.amazonaws.cloudwatchlogs#ResourceType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\w-_]*$" - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasks" }, - "com.amazonaws.cloudwatchlogs#ResourceTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#ResourceType" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroups" }, - "com.amazonaws.cloudwatchlogs#ResultField": { - "type": "structure", - "members": { - "field": { - "target": "com.amazonaws.cloudwatchlogs#Field", - "traits": { - "smithy.api#documentation": "

The log event field.

" - } - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#Value", - "traits": { - "smithy.api#documentation": "

The value of this field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.

\n

For more information about the fields that are \n generated by CloudWatch logs, see \n Supported Logs and Discovered Fields.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogStreams" }, - "com.amazonaws.cloudwatchlogs#ResultRows": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#ResultField" - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFilters" }, - "com.amazonaws.cloudwatchlogs#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueries" }, - "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration": { - "type": "structure", - "members": { - "suffixPath": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySuffixPath", - "traits": { - "smithy.api#documentation": "

This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables \n to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for \n more info on what values are supported in the suffix path for each log source.

" - } - }, - "enableHiveCompatiblePath": { - "target": "com.amazonaws.cloudwatchlogs#Boolean", - "traits": { - "smithy.api#documentation": "

This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitions" }, - "com.amazonaws.cloudwatchlogs#Scope": { - "type": "enum", - "members": { - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - } - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePolicies" }, - "com.amazonaws.cloudwatchlogs#SearchedLogStream": { - "type": "structure", - "members": { - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "

The name of the log stream.

" - } - }, - "searchedCompletely": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamSearchedCompletely", - "traits": { - "smithy.api#documentation": "

Indicates whether all the events in this log stream were searched.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents the search status of a log stream.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFilters" }, - "com.amazonaws.cloudwatchlogs#SearchedLogStreams": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#SearchedLogStream" - } + { + "target": "com.amazonaws.cloudwatchlogs#DisassociateKmsKey" }, - "com.amazonaws.cloudwatchlogs#SelectionCriteria": { - "type": "string" + { + "target": "com.amazonaws.cloudwatchlogs#FilterLogEvents" }, - "com.amazonaws.cloudwatchlogs#SequenceToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicy" }, - "com.amazonaws.cloudwatchlogs#Service": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\w_-]*$" - } + { + "target": "com.amazonaws.cloudwatchlogs#GetDelivery" }, - "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

This request exceeds a service quota.

", - "smithy.api#error": "client" - } + { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestination" }, - "com.amazonaws.cloudwatchlogs#ServiceUnavailableException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

The service cannot complete the request.

", - "smithy.api#error": "server" - } + { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicy" }, - "com.amazonaws.cloudwatchlogs#SessionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#GetDeliverySource" }, - "com.amazonaws.cloudwatchlogs#SessionStreamingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

his exception is returned if an unknown error occurs during a Live Tail session.

", - "smithy.api#error": "client" - } + { + "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector" }, - "com.amazonaws.cloudwatchlogs#SessionTimeoutException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

This exception is returned in a Live Tail stream when the Live Tail session times out. Live Tail sessions time\n out after three hours.

", - "smithy.api#error": "client" - } + { + "target": "com.amazonaws.cloudwatchlogs#GetLogEvents" }, - "com.amazonaws.cloudwatchlogs#StandardUnit": { - "type": "enum", - "members": { - "Seconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Seconds" - } - }, - "Microseconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Microseconds" - } - }, - "Milliseconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Milliseconds" - } - }, - "Bytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bytes" - } - }, - "Kilobytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobytes" - } - }, - "Megabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabytes" - } - }, - "Gigabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabytes" - } - }, - "Terabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabytes" - } - }, - "Bits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bits" - } - }, - "Kilobits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobits" - } - }, - "Megabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabits" - } - }, - "Gigabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabits" - } - }, - "Terabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabits" - } - }, - "Percent": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Percent" - } - }, - "Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Count" - } - }, - "BytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bytes/Second" - } - }, - "KilobytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobytes/Second" - } - }, - "MegabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabytes/Second" - } - }, - "GigabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabytes/Second" - } - }, - "TerabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabytes/Second" - } - }, - "BitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bits/Second" - } - }, - "KilobitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobits/Second" - } - }, - "MegabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabits/Second" - } - }, - "GigabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabits/Second" - } - }, - "TerabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabits/Second" - } - }, - "CountSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Count/Second" - } - }, - "None": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - } - } + { + "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFields" }, - "com.amazonaws.cloudwatchlogs#StartFromHead": { - "type": "boolean" + { + "target": "com.amazonaws.cloudwatchlogs#GetLogRecord" }, - "com.amazonaws.cloudwatchlogs#StartLiveTail": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTailRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTailResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of \n log events that have\n been recently ingested in the log groups. For more information, see \n Use Live Tail to view logs in near real time.\n

\n

The response to this operation is a response stream, over which \n the server sends live log events and the client receives them.

\n

The following objects are sent over the stream:

\n
    \n
  • \n

    A single LiveTailSessionStart \n object is sent at the start of the session.

    \n
    • \n
  • \n

    Every second, a LiveTailSessionUpdate\n object is sent. Each of these objects contains an array of the actual log events.

    \n

    If no new log events were ingested in the past second, the \n LiveTailSessionUpdate object will contain an empty array.

    \n

    The array of log events contained in a LiveTailSessionUpdate can include\n as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the\n log events are sampled down to 500 log events to be included in each LiveTailSessionUpdate object.

    \n

    If your client consumes the log events slower than the server produces them, CloudWatch Logs\n buffers up to 10 LiveTailSessionUpdate events or 5000 log events, after \n which it starts dropping the oldest events.

    \n
    • \n
  • \n

    A SessionStreamingException \n object is returned if an unknown error occurs on the server side.

    \n
    • \n
  • \n

    A SessionTimeoutException \n object is returned when the session times out, after it has been kept open for three hours.

    \n
    • \n
\n \n

You can end a session before it times out by closing the session stream or by closing the client that is receiving the \n stream. The session also ends if the established connection between the client and the server breaks.

\n \n

For examples of using an SDK to start a Live Tail session, see \n \n Start a Live Tail session using an Amazon Web Services SDK.

", - "smithy.api#endpoint": { - "hostPrefix": "streaming-" - } - } + { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResults" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListAnomalies" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListTagsForResource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroup" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestination" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicy" }, - "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#PutDeliverySource" }, - "com.amazonaws.cloudwatchlogs#StartLiveTailRequest": { - "type": "structure", - "members": { - "logGroupIdentifiers": { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers", - "traits": { - "smithy.api#documentation": "

An array where each item in the array is a log group to include in the Live Tail session.

\n

Specify each log group by its ARN.

\n

If you specify an ARN, the ARN can't end with an asterisk (*).

\n \n

You can include up to 10 log groups.

\n ", - "smithy.api#required": {} - } - }, - "logStreamNames": { - "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", - "traits": { - "smithy.api#documentation": "

If you specify this parameter, then only log events in the log streams that you specify here are \n included in the Live Tail session.

\n

If you specify this field, you can't also specify the logStreamNamePrefixes field.

\n \n

You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

\n " - } - }, - "logStreamNamePrefixes": { - "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", - "traits": { - "smithy.api#documentation": "

If you specify this parameter, then only log events in the log streams that have names that start with the \n prefixes that you specify here are \n included in the Live Tail session.

\n

If you specify this field, you can't also specify the logStreamNames field.

\n \n

You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

\n " - } - }, - "logEventFilterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", - "traits": { - "smithy.api#documentation": "

An optional pattern to use to filter the results to include only log events that match the pattern.\n For example, a filter pattern of error 404 causes only log events that include both error \n and 404 to be included in the Live Tail stream.

\n

Regular expression filter patterns are supported.

\n

For more information about filter pattern syntax, see Filter and Pattern Syntax.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.cloudwatchlogs#PutDestination" }, - "com.amazonaws.cloudwatchlogs#StartLiveTailResponse": { - "type": "structure", - "members": { - "responseStream": { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTailResponseStream", - "traits": { - "smithy.api#documentation": "

An object that includes the stream returned by your request. It can include both log events and exceptions.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationPolicy" }, - "com.amazonaws.cloudwatchlogs#StartLiveTailResponseStream": { - "type": "union", - "members": { - "sessionStart": { - "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionStart", - "traits": { - "smithy.api#documentation": "

This object contains information about this Live Tail session, including the log groups included and the \n log stream filters, if any.

" - } - }, - "sessionUpdate": { - "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionUpdate", - "traits": { - "smithy.api#documentation": "

This object contains the log events and session metadata.

" - } - }, - "SessionTimeoutException": { - "target": "com.amazonaws.cloudwatchlogs#SessionTimeoutException", - "traits": { - "smithy.api#documentation": "

This exception is returned in the stream when the Live Tail session times out. Live Tail sessions time\n out after three hours.

" - } - }, - "SessionStreamingException": { - "target": "com.amazonaws.cloudwatchlogs#SessionStreamingException", - "traits": { - "smithy.api#documentation": "

This exception is returned if an unknown error occurs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This object includes the stream returned by your \n StartLiveTail\n request.

", - "smithy.api#streaming": {} - } + { + "target": "com.amazonaws.cloudwatchlogs#PutLogEvents" }, - "com.amazonaws.cloudwatchlogs#StartQuery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#StartQueryRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#StartQueryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#MalformedQueryException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group\n and time range to query and the query string to use.

\n

For more information, see CloudWatch Logs Insights Query Syntax.

\n

After you run a query using StartQuery, the query results are stored by CloudWatch Logs. \n You can use GetQueryResults to retrieve\n the results of a query, using the queryId that StartQuery returns.\n

\n

If you have associated a KMS key with the query results in this account, \n then \n StartQuery uses that key to \n encrypt the results when it stores them. If no key is associated with query results, the query results are \n encrypted with the default CloudWatch Logs encryption method.

\n

Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the\n time range being searched or partition your query into a number of queries.

\n

If you are using CloudWatch cross-account observability, you can use this operation in a\n monitoring account to start a query in a linked source account. For more information, see\n CloudWatch\n cross-account observability. For a cross-account StartQuery operation,\n the query definition must be defined in the monitoring account.

\n

You can have up to 30 concurrent CloudWatch Logs insights queries, including queries\n that have been added to dashboards.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#PutMetricFilter" }, - "com.amazonaws.cloudwatchlogs#StartQueryRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The log group on which to perform the query.

\n \n

A StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers.

\n " - } - }, - "logGroupNames": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", - "traits": { - "smithy.api#documentation": "

The list of log groups to be queried. You can include up to 50 log groups.

\n \n

A StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers.

\n " - } - }, - "logGroupIdentifiers": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifiers", - "traits": { - "smithy.api#documentation": "

The list of log groups to query. You can include up to 50 log groups.

\n

You can specify them by the log group name or ARN. If a log group that you're querying is\n in a source account and you're using a monitoring account, you must specify the ARN of the log\n group here. The query definition must also be defined in the monitoring account.

\n

If you specify an ARN, the ARN can't end with an asterisk (*).

\n

A StartQuery operation must include exactly one of the following parameters:\n logGroupName, logGroupNames, or logGroupIdentifiers.

" - } - }, - "startTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The beginning of the time range to query. The range is inclusive, so the specified start\n time is included in the query. Specified as epoch time, the number of seconds since\n January 1, 1970, 00:00:00 UTC.

", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The end of the time range to query. The range is inclusive, so the specified end time is\n included in the query. Specified as epoch time, the number of seconds since January 1,\n 1970, 00:00:00 UTC.

", - "smithy.api#required": {} - } - }, - "queryString": { - "target": "com.amazonaws.cloudwatchlogs#QueryString", - "traits": { - "smithy.api#documentation": "

The query string to use.\n For more information, see CloudWatch Logs Insights Query Syntax.

", - "smithy.api#required": {} - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#EventsLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of log events to return in the query. If the query string uses the fields command,\n only the specified fields and their values are returned. The default is 1000.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinition" }, - "com.amazonaws.cloudwatchlogs#StartQueryResponse": { - "type": "structure", - "members": { - "queryId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "

The unique ID of the query.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicy" }, - "com.amazonaws.cloudwatchlogs#State": { - "type": "enum", - "members": { - "Active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "Suppressed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Suppressed" - } - }, - "Baseline": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Baseline" - } - } - } + { + "target": "com.amazonaws.cloudwatchlogs#PutRetentionPolicy" }, - "com.amazonaws.cloudwatchlogs#StatsValue": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } + { + "target": "com.amazonaws.cloudwatchlogs#PutSubscriptionFilter" }, - "com.amazonaws.cloudwatchlogs#StopQuery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#StopQueryRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#StopQueryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation\n returns an error indicating that the specified query is not running.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTail" }, - "com.amazonaws.cloudwatchlogs#StopQueryRequest": { - "type": "structure", - "members": { - "queryId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "

The ID number of the query to stop. To find this ID number, use\n DescribeQueries.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.cloudwatchlogs#StartQuery" }, - "com.amazonaws.cloudwatchlogs#StopQueryResponse": { - "type": "structure", - "members": { - "success": { - "target": "com.amazonaws.cloudwatchlogs#Success", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

This is true if the query was stopped by the StopQuery operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.cloudwatchlogs#StopQuery" }, - "com.amazonaws.cloudwatchlogs#StoredBytes": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } + { + "target": "com.amazonaws.cloudwatchlogs#TagLogGroup" }, - "com.amazonaws.cloudwatchlogs#SubscriptionFilter": { - "type": "structure", - "members": { - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the subscription filter.

" - } - }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

" - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern" - }, - "destinationArn": { - "target": "com.amazonaws.cloudwatchlogs#DestinationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

" - } - }, - "roleArn": { - "target": "com.amazonaws.cloudwatchlogs#RoleArn", - "traits": { - "smithy.api#documentation": "

" - } - }, - "distribution": { - "target": "com.amazonaws.cloudwatchlogs#Distribution" - }, - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the subscription filter, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a subscription filter.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#TagResource" }, - "com.amazonaws.cloudwatchlogs#SubscriptionFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#SubscriptionFilter" - } + { + "target": "com.amazonaws.cloudwatchlogs#TestMetricFilter" }, - "com.amazonaws.cloudwatchlogs#Success": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + { + "target": "com.amazonaws.cloudwatchlogs#UntagLogGroup" }, - "com.amazonaws.cloudwatchlogs#SuppressionPeriod": { - "type": "structure", - "members": { - "value": { - "target": "com.amazonaws.cloudwatchlogs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the number of seconds, minutes or hours to suppress this anomaly. There is no maximum.

" - } - }, - "suppressionUnit": { - "target": "com.amazonaws.cloudwatchlogs#SuppressionUnit", - "traits": { - "smithy.api#documentation": "

Specifies whether the value of value is in seconds, minutes, or hours.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

If you are suppressing an anomaly temporariliy, this structure defines how long the suppression period\n is to be.

" - } + { + "target": "com.amazonaws.cloudwatchlogs#UntagResource" }, - "com.amazonaws.cloudwatchlogs#SuppressionState": { - "type": "enum", - "members": { - "SUPPRESSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUPPRESSED" - } - }, - "UNSUPPRESSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNSUPPRESSED" + { + "target": "com.amazonaws.cloudwatchlogs#UpdateAnomaly" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfiguration" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetector" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "CloudWatch Logs", + "arnNamespace": "logs", + "cloudFormationName": "Logs", + "cloudTrailEventSource": "logs.amazonaws.com", + "docId": "logs-2014-03-28", + "endpointPrefix": "logs" + }, + "aws.auth#sigv4": { + "name": "logs" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from\n EC2 instances, CloudTrail, and other sources. You can then retrieve the associated\n log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use\n CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch\n Logs SDK.

\n

You can use CloudWatch Logs to:

\n
    \n
  • \n

    \n Monitor logs from EC2 instances in real time: You\n can use CloudWatch Logs to monitor applications and systems using log data. For example,\n CloudWatch Logs can track the number of errors that occur in your application logs. Then,\n it can send you a notification whenever the rate of errors exceeds a threshold that you\n specify. CloudWatch Logs uses your log data for monitoring so no code changes are\n required. For example, you can monitor application logs for specific literal terms (such\n as \"NullReferenceException\"). You can also count the number of occurrences of a literal\n term at a particular position in log data (such as \"404\" status codes in an Apache access\n log). When the term you are searching for is found, CloudWatch Logs reports the data to a\n CloudWatch metric that you specify.

    \n
    • \n
  • \n

    \n Monitor CloudTrail logged events: You can\n create alarms in CloudWatch and receive notifications of particular API activity as\n captured by CloudTrail. You can use the notification to perform troubleshooting.

    \n
    • \n
  • \n

    \n Archive log data: You can use CloudWatch Logs to\n store your log data in highly durable storage. You can change the log retention setting so\n that any log events earlier than this setting are automatically deleted. The CloudWatch\n Logs agent helps to quickly send both rotated and non-rotated log data off of a host and\n into the log service. You can then access the raw log data when you need it.

    \n
    • \n
", + "smithy.api#title": "Amazon CloudWatch Logs", + "smithy.api#xmlNamespace": { + "uri": "http://monitoring.amazonaws.com/doc/2014-03-28/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" } + ] } - } - }, - "com.amazonaws.cloudwatchlogs#SuppressionType": { - "type": "enum", - "members": { - "LIMITED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LIMITED" + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, - "INFINITE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFINITE" + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } - } - }, - "com.amazonaws.cloudwatchlogs#SuppressionUnit": { - "type": "enum", - "members": { - "SECONDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECONDS" + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" } - }, - "MINUTES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUTES" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" } - }, - "HOURS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOURS" + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://logs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + } + ], + "endpoint": { + "url": "https://logs.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "endpoint": { + "url": "https://logs.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://logs-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://logs.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://logs.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } + ], + "type": "tree" } - } - }, - "com.amazonaws.cloudwatchlogs#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$" - } - }, - "com.amazonaws.cloudwatchlogs#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#TagKey" + ], + "type": "tree" }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } + ] }, - "com.amazonaws.cloudwatchlogs#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#TagKey" + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#TagLogGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#TagLogGroupRequest" + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "output": { - "target": "smithy.api#Unit" + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API TagResource" - }, - "smithy.api#documentation": "\n

The TagLogGroup operation is on the path to deprecation. We recommend that you use \n TagResource instead.

\n \n

Adds or updates the specified tags for the specified log group.

\n

To list the tags for a log group, use ListTagsForResource.\n To remove tags, use UntagResource.

\n

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs\n in the Amazon CloudWatch Logs User Guide.

\n

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the aws:Resource/key-name\n or aws:TagKeys condition keys. \n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.

" - } - }, - "com.amazonaws.cloudwatchlogs#TagLogGroupRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

The key-value pairs to use for the tags.

", - "smithy.api#required": {} - } - } + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API model TagResourceRequest" - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#TagResourceRequest" + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "output": { - "target": "smithy.api#Unit" + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://logs.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#TooManyTagsException" - } - ], - "traits": { - "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. \n Currently, the only CloudWatch Logs resources that \n can be tagged are log groups and destinations.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

\n

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, \n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n the previous value for that tag.

\n

You can associate as many as 50 tags with a CloudWatch Logs resource.

" - } - }, - "com.amazonaws.cloudwatchlogs#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

The ARN of the resource that you're adding tags to.

\n

The ARN format of a log group is \n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n

\n

The ARN format of a destination is \n arn:aws:logs:Region:account-id:destination:destination-name\n \n

\n

For more information about ARN format, see CloudWatch Logs \n resources and operations.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "

The list of key-value pairs to associate with the resource.

", - "smithy.api#required": {} - } - } + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.cloudwatchlogs#Tags": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#TagKey" + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#TagValue" + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.cloudwatchlogs#TargetArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#TestEventMessages": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage" + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.cloudwatchlogs#TestMetricFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#TestMetricFilterRequest" + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://logs.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#TestMetricFilterResponse" + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Tests the filter pattern of a metric filter against a sample of log event messages. You\n can use this operation to validate the correctness of a metric filter pattern.

" - } - }, - "com.amazonaws.cloudwatchlogs#TestMetricFilterRequest": { - "type": "structure", - "members": { - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", - "traits": { - "smithy.api#required": {} - } - }, - "logEventMessages": { - "target": "com.amazonaws.cloudwatchlogs#TestEventMessages", - "traits": { - "smithy.api#documentation": "

The log event messages to test.

", - "smithy.api#required": {} - } - } + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#TestMetricFilterResponse": { - "type": "structure", - "members": { - "matches": { - "target": "com.amazonaws.cloudwatchlogs#MetricFilterMatches", - "traits": { - "smithy.api#documentation": "

The matched events.

" - } - } + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "

The request was throttled because of quota limits.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#Time": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#Timestamp": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.cloudwatchlogs#Token": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#TokenString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#TokenValue": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.cloudwatchlogs#TooManyTagsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - }, - "resourceName": { - "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource.

" - } - } + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "traits": { - "smithy.api#documentation": "

A resource can have no more than 50 tags.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudwatchlogs#Unmask": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.cloudwatchlogs#UnrecognizedClientException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://logs.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "traits": { - "smithy.api#documentation": "

The most likely cause is an Amazon Web Services access key ID or secret key that's not\n valid.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#UntagLogGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest" + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "output": { - "target": "smithy.api#Unit" + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API UntagResource" - }, - "smithy.api#documentation": "\n

The UntagLogGroup operation is on the path to deprecation. We recommend that you use \n UntagResource instead.

\n \n

Removes the specified tags from the specified log group.

\n

To list the tags for a log group, use ListTagsForResource.\n To add tags, use TagResource.

\n

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the aws:Resource/key-name\n or aws:TagKeys condition keys. \n

" - } - }, - "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys. The corresponding tags are removed from the log group.

", - "smithy.api#required": {} - } - } + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API model UntagResourceRequest" - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#UntagResourceRequest" + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "output": { - "target": "smithy.api#Unit" + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes one or more tags from the specified resource.

" - } - }, - "com.amazonaws.cloudwatchlogs#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource that you're removing tags from.

\n

The ARN format of a log group is \n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n

\n

The ARN format of a destination is \n arn:aws:logs:Region:account-id:destination:destination-name\n \n

\n

For more information about ARN format, see CloudWatch Logs \n resources and operations.

", - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.cloudwatchlogs#TagKeyList", - "traits": { - "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", - "smithy.api#required": {} - } - } + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#UpdateAnomaly": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#UpdateAnomalyRequest" + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "output": { - "target": "smithy.api#Unit" + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress \n an anomaly, CloudWatch Logs won’t report new occurrences of that anomaly and won't\n update that anomaly \n with new data. If you suppress a pattern, CloudWatch Logs won’t report any anomalies related to that pattern.

\n

You must specify either anomalyId or patternId, but you can't specify both parameters in the \n same operation.

\n

If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause\n CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to \n stop suppressing, and omit the suppressionType and suppressionPeriod parameters.

" - } - }, - "com.amazonaws.cloudwatchlogs#UpdateAnomalyRequest": { - "type": "structure", - "members": { - "anomalyId": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyId", - "traits": { - "smithy.api#documentation": "

If you are suppressing or unsuppressing an anomaly, specify its unique ID here. You can find anomaly IDs by\n using the ListAnomalies operation.

" - } - }, - "patternId": { - "target": "com.amazonaws.cloudwatchlogs#PatternId", - "traits": { - "smithy.api#documentation": "

If you are suppressing or unsuppressing an pattern, specify its unique ID here. You can find pattern IDs by\n using the ListAnomalies operation.

" - } - }, - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "

The ARN of the anomaly detector that this operation is to act on.

", - "smithy.api#required": {} - } - }, - "suppressionType": { - "target": "com.amazonaws.cloudwatchlogs#SuppressionType", - "traits": { - "smithy.api#documentation": "

Use this to specify whether the suppression to be temporary or infinite. If you specify LIMITED,\n you must also specify a suppressionPeriod. If you specify INFINITE,\n any value for suppressionPeriod is ignored.

" - } - }, - "suppressionPeriod": { - "target": "com.amazonaws.cloudwatchlogs#SuppressionPeriod", - "traits": { - "smithy.api#documentation": "

If you are temporarily suppressing an anomaly or pattern, use this structure to specify\n how long the suppression is to last.

" - } - } + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationRequest" + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationResponse" + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Use this operation to update the configuration of a delivery to change either the \n S3 path pattern or the format of the delivered logs. You can't use this operation to change the\n source or destination of the delivery.

" - } - }, - "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryId", - "traits": { - "smithy.api#documentation": "

The ID of the delivery to be updated by this request.

", - "smithy.api#required": {} - } - }, - "recordFields": { - "target": "com.amazonaws.cloudwatchlogs#RecordFields", - "traits": { - "smithy.api#documentation": "

The list of record fields to be delivered to the destination, in order. \n If the delivery’s log source has mandatory fields, they must be included in this list.

" - } - }, - "fieldDelimiter": { - "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", - "traits": { - "smithy.api#documentation": "

The field delimiter to use between record fields when the final output format of a delivery\n is in Plain, W3C, or Raw format.

" - } - }, - "s3DeliveryConfiguration": { - "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", - "traits": { - "smithy.api#documentation": "

This structure contains parameters that are valid only when the delivery’s delivery destination is an S3 bucket.

" - } - } + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.cloudwatchlogs#MalformedQueryException": { + "type": "structure", + "members": { + "queryCompileError": { + "target": "com.amazonaws.cloudwatchlogs#QueryCompileError" + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The query string is not valid. Details about this error are displayed in a \n QueryCompileError object. For more information, see \n QueryCompileError.

\n

For more information about valid query syntax, see\n CloudWatch Logs Insights Query Syntax.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#Message": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#MetricFilter": { + "type": "structure", + "members": { + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the metric filter.

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "metricTransformations": { + "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", + "traits": { + "smithy.api#documentation": "

The metric transformations.

" + } + }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the metric filter, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metric filters express how CloudWatch Logs would extract metric observations \n from ingested log events and transform them into metric data in a CloudWatch metric.

" + } + }, + "com.amazonaws.cloudwatchlogs#MetricFilterMatchRecord": { + "type": "structure", + "members": { + "eventNumber": { + "target": "com.amazonaws.cloudwatchlogs#EventNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The event number.

" + } + }, + "eventMessage": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The raw event data.

" + } + }, + "extractedValues": { + "target": "com.amazonaws.cloudwatchlogs#ExtractedValues", + "traits": { + "smithy.api#documentation": "

The values extracted from the event data by the filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a matched event.

" + } + }, + "com.amazonaws.cloudwatchlogs#MetricFilterMatches": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#MetricFilterMatchRecord" + } + }, + "com.amazonaws.cloudwatchlogs#MetricFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#MetricFilter" + } + }, + "com.amazonaws.cloudwatchlogs#MetricName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch metric to which the monitored log information should be\n published. For example, you might publish to a metric named ErrorCount.

", + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[^:*$]*$" + } + }, + "com.amazonaws.cloudwatchlogs#MetricNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[^:*$]*$" + } + }, + "com.amazonaws.cloudwatchlogs#MetricTransformation": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.cloudwatchlogs#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch metric.

", + "smithy.api#required": {} + } + }, + "metricNamespace": { + "target": "com.amazonaws.cloudwatchlogs#MetricNamespace", + "traits": { + "smithy.api#documentation": "

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics\n that are similar. For more information, see Namespaces.

", + "smithy.api#required": {} + } + }, + "metricValue": { + "target": "com.amazonaws.cloudwatchlogs#MetricValue", + "traits": { + "smithy.api#documentation": "

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

", + "smithy.api#required": {} + } + }, + "defaultValue": { + "target": "com.amazonaws.cloudwatchlogs#DefaultValue", + "traits": { + "smithy.api#documentation": "

(Optional) The value to emit when a filter pattern does not match a log event. \n This value can be null.

" + } + }, + "dimensions": { + "target": "com.amazonaws.cloudwatchlogs#Dimensions", + "traits": { + "smithy.api#documentation": "

The fields to use as dimensions for the metric. One metric filter can include\n as many as three dimensions.

\n \n

Metrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n IPAddress or requestID as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n

\n

CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your\n specified dimensions within a certain amount of time. This helps to prevent accidental high\n charges.

\n

You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n

\n " + } + }, + "unit": { + "target": "com.amazonaws.cloudwatchlogs#StandardUnit", + "traits": { + "smithy.api#documentation": "

The unit to assign to the metric. If you omit this, the unit is set as None.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates how to transform ingested log events to metric data in a CloudWatch\n metric.

" + } + }, + "com.amazonaws.cloudwatchlogs#MetricTransformations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#MetricTransformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#MetricValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The value to publish to the CloudWatch metric. For example, if you're counting the\n occurrences of a term like Error, the value is 1 for each\n occurrence. If you're counting the bytes transferred, the value is the value in the log\n event.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. The token expires after 24 hours.

", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#OperationAbortedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

Multiple concurrent requests to update the same resource were in conflict.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#OrderBy": { + "type": "enum", + "members": { + "LogStreamName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LogStreamName" + } + }, + "LastEventTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastEventTime" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#OutputFormat": { + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "json" + } + }, + "PLAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "plain" + } + }, + "W3C": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "w3c" + } + }, + "RAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "raw" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "parquet" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#OutputFormats": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#OutputFormat" + } + }, + "com.amazonaws.cloudwatchlogs#OutputLogEvent": { + "type": "structure", + "members": { + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the event occurred, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.

" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The data contained in the log event.

" + } + }, + "ingestionTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the event was ingested, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a log event.

" + } + }, + "com.amazonaws.cloudwatchlogs#OutputLogEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#OutputLogEvent" + } + }, + "com.amazonaws.cloudwatchlogs#PatternId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 32 + } + } + }, + "com.amazonaws.cloudwatchlogs#PatternRegex": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#PatternString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#PatternToken": { + "type": "structure", + "members": { + "dynamicTokenPosition": { + "target": "com.amazonaws.cloudwatchlogs#DynamicTokenPosition", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For a dynamic token, this indicates where in the pattern that this token appears, related\n to other dynamic tokens. The dynamic token that appears first has a value of 1, the \n one that appears second is 2, and so on.

" + } + }, + "isDynamic": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether this is a dynamic token.

" + } + }, + "tokenString": { + "target": "com.amazonaws.cloudwatchlogs#TokenString", + "traits": { + "smithy.api#documentation": "

The string represented by this token. If this is a dynamic token, the\n value will be <*>\n

" + } + }, + "enumerations": { + "target": "com.amazonaws.cloudwatchlogs#Enumerations", + "traits": { + "smithy.api#documentation": "

Contains the values found for a dynamic token, and the number of times each value was found.

" + } + }, + "inferredTokenName": { + "target": "com.amazonaws.cloudwatchlogs#InferredTokenName", + "traits": { + "smithy.api#documentation": "

A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of \n the inferredTokenName gives you a clearer idea of the content of this token. The number part of \n the inferredTokenName shows where in the pattern this token appears, compared to other dynamic tokens.\n CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.

\n

For example, an inferred token name of IPAddress-3 means that the token represents an IP address, and this \n token is the third dynamic token in the pattern.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about one pattern token related to \n an anomaly.

\n

For more information about patterns and tokens, see CreateLogAnomalyDetector.\n

" + } + }, + "com.amazonaws.cloudwatchlogs#PatternTokens": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#PatternToken" + } + }, + "com.amazonaws.cloudwatchlogs#Percentage": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#Policy": { + "type": "structure", + "members": { + "deliveryDestinationPolicy": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy", + "traits": { + "smithy.api#documentation": "

The contents of the delivery destination policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about one delivery destination policy.

" + } + }, + "com.amazonaws.cloudwatchlogs#PolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5120 + } + } + }, + "com.amazonaws.cloudwatchlogs#PolicyName": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#PolicyType": { + "type": "enum", + "members": { + "DATA_PROTECTION_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_PROTECTION_POLICY" + } + }, + "SUBSCRIPTION_FILTER_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBSCRIPTION_FILTER_POLICY" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#Priority": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#PutAccountPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an account-level data protection policy or subscription filter policy that applies to all log groups \n or a subset of log groups in the account.

\n

\n Data protection policy\n

\n

A data protection policy can help safeguard sensitive \n data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only\n one account-level data protection policy.

\n \n

Sensitive data is detected and masked when it is ingested into a log group. When you set a \n data protection policy, log events ingested into the log groups before that time are not masked.

\n \n

If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups\n and all log groups that are created later in this account. The account-level policy is applied to existing log groups\n with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.

\n

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.\n A user who has the logs:Unmask permission can use a \n GetLogEvents or \n FilterLogEvents\n operation with the unmask parameter set to true to view the unmasked \n log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs\n console by running a CloudWatch Logs Insights query with the unmask query command.

\n

For more information, including a list of types of data that can be audited and masked, see\n Protect sensitive log data with masking.

\n

To use the PutAccountPolicy operation for a data protection policy, you must be signed on with \n the logs:PutDataProtectionPolicy\n and logs:PutAccountPolicy permissions.

\n

The PutAccountPolicy operation applies to all log groups in the account. You can use \n PutDataProtectionPolicy\n to create a data protection policy that applies to just one log group. \n If a log group has its own data protection policy and \n the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.

\n

\n Subscription filter policy\n

\n

A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services.\n Account-level subscription filter policies apply to both existing log groups and log groups that are created later in \n this account. Supported destinations are Kinesis Data Streams, Firehose, and \n Lambda. When log events are sent to the receiving service, they are Base64 encoded and \n compressed with the GZIP format.

\n

The following destinations are supported for subscription filters:

\n
    \n
  • \n

    An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.

    \n
    • \n
  • \n

    An Firehose data stream in the same account as the subscription policy, for same-account delivery.

    \n
    • \n
  • \n

    A Lambda function in the same account as the subscription policy, for same-account delivery.

    \n
    • \n
  • \n

    A logical destination in a different account created with PutDestination, for cross-account\n delivery. Kinesis Data Streams and Firehose are supported as logical destinations.

    \n
    • \n
\n

Each account can have one account-level subscription filter policy per Region. \n If you are updating an existing filter, you must specify the correct name in PolicyName.\n To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda \n function, you must also have the iam:PassRole permission.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

A name for the policy. This must be unique within the account.

", + "smithy.api#required": {} + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", + "traits": { + "smithy.api#documentation": "

Specify the policy, in JSON.

\n

\n Data protection policy\n

\n

A data protection policy must include two JSON blocks:

\n
    \n
  • \n

    The first block must include both a DataIdentifer array and an \n Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that\n you want to mask. For more information about the available options, see \n Types of data that you can mask.

    \n

    The Operation property with an Audit action is required to find the \n sensitive data terms. This Audit action must contain a FindingsDestination\n object. You can optionally use that FindingsDestination object to list one or more \n destinations to send audit findings to. If you specify destinations such as log groups, \n Firehose streams, and S3 buckets, they must already exist.

    \n
    • \n
  • \n

    The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.

    \n

    The Operation property with the Deidentify action is what actually masks the \n data, and it must \n contain the \n \"MaskConfig\": {} object. The \n \"MaskConfig\": {} object must be empty.

    \n
    • \n
\n

For an example data protection policy, see the Examples section on this page.

\n \n

The contents of the two DataIdentifer arrays must match exactly.

\n \n

In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is different than the \n operation's policyName parameter, and is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.

\n

The JSON specified in policyDocument can be up to 30,720 characters long.

\n

\n Subscription filter policy\n

\n

A subscription filter policy can include the following attributes in a JSON block:

\n
    \n
  • \n

    \n DestinationArn The ARN of the destination\n to deliver log events to. Supported destinations are:

    \n
      \n
    • \n

      An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.

      \n
      • \n
    • \n

      An Firehose data stream in the same account as the subscription policy, for same-account delivery.

      \n
      • \n
    • \n

      A Lambda function in the same account as the subscription policy, for same-account delivery.

      \n
      • \n
    • \n

      A logical destination in a different account created with PutDestination, for cross-account\n delivery. Kinesis Data Streams and Firehose are supported as logical destinations.

      \n
      • \n
    \n
    • \n
  • \n

    \n RoleArn The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log\n events to the destination stream. You don't need to provide the ARN when you are working with\n a logical destination for cross-account delivery.

    \n
    • \n
  • \n

    \n FilterPattern A filter pattern for subscribing to a \n filtered stream of log events.

    \n
    • \n
  • \n

    \n Distribution The method used to distribute log data to the destination. \n By default, log data is\n grouped by log stream, but the grouping can be set to Random for a more even distribution.\n This property is only applicable when the destination is an Kinesis Data Streams data stream.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "

The type of policy that you're creating or updating.

", + "smithy.api#required": {} + } + }, + "scope": { + "target": "com.amazonaws.cloudwatchlogs#Scope", + "traits": { + "smithy.api#documentation": "

Currently the only valid value for this parameter is ALL, which specifies that the data \n protection policy applies to all log groups in the account. If you omit this parameter, the default\n of ALL is used.

" + } + }, + "selectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#SelectionCriteria", + "traits": { + "smithy.api#documentation": "

Use this parameter to apply the subscription filter policy to a subset of log groups in the account.\n Currently, the only supported filter is LogGroupName NOT IN []. The selectionCriteria\n string can be up to 25KB in length. The length is determined by using its UTF-8 bytes.

\n

Using the selectionCriteria parameter is useful to help prevent infinite loops. \n For more information, see Log recursion prevention.

\n

Specifing selectionCriteria is valid only when you specify SUBSCRIPTION_FILTER_POLICY\n for policyType.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutAccountPolicyResponse": { + "type": "structure", + "members": { + "accountPolicy": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicy", + "traits": { + "smithy.api#documentation": "

The account policy that you created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive \n data that's ingested by the log group by auditing and masking the sensitive log data.

\n \n

Sensitive data is detected and masked when it is ingested into the log group. When you set a \n data protection policy, log events ingested into the log group before that time are not masked.

\n \n

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.\n A user who has the logs:Unmask permission can use a \n GetLogEvents or \n FilterLogEvents\n operation with the unmask parameter set to true to view the unmasked \n log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs\n console by running a CloudWatch Logs Insights query with the unmask query command.

\n

For more information, including a list of types of data that can be audited and masked, see\n Protect sensitive log data with masking.

\n

The PutDataProtectionPolicy operation applies to only the specified log group. You can also use \n PutAccountPolicy\n to create an account-level data protection policy that applies to all log groups in the account, \n including both existing log groups and log groups that are created level. If a log group has its own data protection policy and \n the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

Specify either the log group name or log group ARN.

", + "smithy.api#required": {} + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", + "traits": { + "smithy.api#documentation": "

Specify the data protection policy, in JSON.

\n

This policy must include two JSON blocks:

\n
    \n
  • \n

    The first block must include both a DataIdentifer array and an \n Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that\n you want to mask. For more information about the available options, see \n Types of data that you can mask.

    \n

    The Operation property with an Audit action is required to find the \n sensitive data terms. This Audit action must contain a FindingsDestination\n object. You can optionally use that FindingsDestination object to list one or more \n destinations to send audit findings to. If you specify destinations such as log groups, \n Firehose streams, and S3 buckets, they must already exist.

    \n
    • \n
  • \n

    The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.

    \n

    The Operation property with the Deidentify action is what actually masks the \n data, and it must \n contain the \n \"MaskConfig\": {} object. The \n \"MaskConfig\": {} object must be empty.

    \n
    • \n
\n

For an example data protection policy, see the Examples section on this page.

\n \n

The contents of the two DataIdentifer arrays must match exactly.

\n \n

In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.

\n

The JSON specified in policyDocument can be up to 30,720 characters.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyResponse": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The log group name or ARN that you specified in your request.

" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", + "traits": { + "smithy.api#documentation": "

The data protection policy used for this log group.

" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that this policy was most recently updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an \n Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and\n Firehose are supported as logs delivery destinations.

\n

To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:

\n
    \n
  • \n

    Create a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.

    \n
    • \n
  • \n

    Use PutDeliveryDestination to create a delivery destination, which is a logical object that represents the actual\n delivery destination.

    \n
    • \n
  • \n

    If you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n

    \n
    • \n
  • \n

    Use CreateDelivery to create a delivery by pairing exactly \n one delivery source and one delivery destination. For more \n information, see CreateDelivery.\n

    \n
    • \n
\n

You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.

\n

Only some Amazon Web Services services support being configured as a delivery source. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n

\n

If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten\n with the new parameter values that you specify.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver \n logs cross-account to a specified destination in this account. To configure the delivery of logs from an \n Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:

\n
    \n
  • \n

    Create a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.

    \n
    • \n
  • \n

    Create a delivery destination, which is a logical object that represents the actual\n delivery destination. For more \n information, see PutDeliveryDestination.

    \n
    • \n
  • \n

    Use this operation in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n

    \n
    • \n
  • \n

    Create a delivery by pairing exactly one delivery source and one delivery destination.\n For more information, see CreateDelivery.

    \n
    • \n
\n

Only some Amazon Web Services services support being configured as a delivery source. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n

\n

The contents of the policy must include two statements. One statement enables general logs delivery, and the other\n allows delivery to the chosen destination. See the examples for the needed policies.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyRequest": { + "type": "structure", + "members": { + "deliveryDestinationName": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the delivery destination to assign this policy to.

", + "smithy.api#required": {} + } + }, + "deliveryDestinationPolicy": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy", + "traits": { + "smithy.api#documentation": "

The contents of the policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyResponse": { + "type": "structure", + "members": { + "policy": { + "target": "com.amazonaws.cloudwatchlogs#Policy", + "traits": { + "smithy.api#documentation": "

The contents of the policy that you just created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

A name for this delivery destination. This name must be unique for all delivery destinations in your account.

", + "smithy.api#required": {} + } + }, + "outputFormat": { + "target": "com.amazonaws.cloudwatchlogs#OutputFormat", + "traits": { + "smithy.api#documentation": "

The format for the logs that this delivery destination will receive.

" + } + }, + "deliveryDestinationConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

An optional list of key-value pairs to associate with the resource.

\n

For more information about tagging, see \n Tagging Amazon Web Services resources\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationResponse": { + "type": "structure", + "members": { + "deliveryDestination": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination", + "traits": { + "smithy.api#documentation": "

A structure containing information about the delivery destination that you just created or updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliverySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliverySourceRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliverySourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an\n logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.

\n

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:

\n
    \n
  • \n

    Use PutDeliverySource to create a delivery source, which is a logical object that represents the resource that is actually\n sending the logs.

    \n
    • \n
  • \n

    Use PutDeliveryDestination to create a delivery destination, which is a logical object that represents the actual\n delivery destination. For more \n information, see PutDeliveryDestination.

    \n
    • \n
  • \n

    If you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n

    \n
    • \n
  • \n

    Use CreateDelivery to create a delivery by pairing exactly \n one delivery source and one delivery destination. For more \n information, see CreateDelivery.\n

    \n
    • \n
\n

You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.

\n

Only some Amazon Web Services services support being configured as a delivery source. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n

\n

If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten\n with the new parameter values that you specify.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliverySourceRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

A name for this delivery source. This name must be unique for all delivery sources in your account.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the Amazon Web Services resource that is generating and sending logs. \n For example, arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234\n

", + "smithy.api#required": {} + } + }, + "logType": { + "target": "com.amazonaws.cloudwatchlogs#LogType", + "traits": { + "smithy.api#documentation": "

Defines the type of log that the source is sending.

\n
    \n
  • \n

    For Amazon Bedrock, the valid value is \n APPLICATION_LOGS.

    \n
    • \n
  • \n

    For Amazon CodeWhisperer, the valid value is \n EVENT_LOGS.

    \n
    • \n
  • \n

    For IAM Identity Center, the valid value is \n ERROR_LOGS.

    \n
    • \n
  • \n

    For Amazon WorkMail, the valid values are \n ACCESS_CONTROL_LOGS, AUTHENTICATION_LOGS, WORKMAIL_AVAILABILITY_PROVIDER_LOGS, and WORKMAIL_MAILBOX_ACCESS_LOGS.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

An optional list of key-value pairs to associate with the resource.

\n

For more information about tagging, see \n Tagging Amazon Web Services resources\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliverySourceResponse": { + "type": "structure", + "members": { + "deliverySource": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySource", + "traits": { + "smithy.api#documentation": "

A structure containing information about the delivery source that was just created or updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

\n

A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With\n a destination, you can subscribe to a real-time stream of log events for a different account,\n ingested using PutLogEvents.

\n

Through an access policy, a destination controls what is written to it.\n By default, PutDestination does not set any access policy with the destination,\n which means a cross-account user cannot call PutSubscriptionFilter against\n this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

\n

To perform a PutDestination operation, you must also have the \n iam:PassRole permission.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDestinationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates an access policy associated with an existing\n destination. An access policy is an IAM policy document that is used\n to authorize claims to register a subscription filter against a given destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest": { + "type": "structure", + "members": { + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "

A name for an existing destination.

", + "smithy.api#required": {} + } + }, + "accessPolicy": { + "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", + "traits": { + "smithy.api#documentation": "

An IAM policy document that authorizes cross-account users to deliver their log events\n to the associated destination. This can be up to 5120 bytes.

", + "smithy.api#required": {} + } + }, + "forceUpdate": { + "target": "com.amazonaws.cloudwatchlogs#ForceUpdate", + "traits": { + "smithy.api#documentation": "

Specify true if you are updating an existing destination policy to grant permission to\n an organization ID instead of granting permission to individual Amazon Web Services accounts. Before\n you update a destination policy this way, you must first update the subscription\n filters in the accounts that send logs to this destination. If you do not, the subscription\n filters might stop working. By specifying true\n for forceUpdate, you are affirming that you have already updated the subscription \n filters.\n For more information, see \n Updating an existing cross-account subscription\n

\n

If you omit this parameter, the default of false is used.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDestinationRequest": { + "type": "structure", + "members": { + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "

A name for the destination.

", + "smithy.api#required": {} + } + }, + "targetArn": { + "target": "com.amazonaws.cloudwatchlogs#TargetArn", + "traits": { + "smithy.api#documentation": "

The ARN of an Amazon Kinesis stream to which to deliver matching log events.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon\n Kinesis PutRecord operation on the destination stream.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

An optional list of key-value pairs to associate with the resource.

\n

For more information about tagging, see \n Tagging Amazon Web Services resources\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDestinationResponse": { + "type": "structure", + "members": { + "destination": { + "target": "com.amazonaws.cloudwatchlogs#Destination", + "traits": { + "smithy.api#documentation": "

The destination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutLogEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutLogEventsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutLogEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#DataAlreadyAcceptedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidSequenceTokenException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UnrecognizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Uploads a batch of log events to the specified log stream.

\n \n

The sequence token is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are always accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid. You can use\n parallel PutLogEvents actions on the same log stream.

\n \n

The batch of events must satisfy the following constraints:

\n
    \n
  • \n

    The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of\n all event messages in UTF-8, plus 26 bytes for each log event.

    \n
    • \n
  • \n

    None of the log events in the batch can be more than 2 hours in the future.

    \n
    • \n
  • \n

    None of the log events in the batch can be more than 14 days in the past. Also,\n none of the log events can be from earlier than the retention period of the log\n group.

    \n
    • \n
  • \n

    The log events in the batch must be in chronological order by their timestamp. The\n timestamp is the time that the event occurred, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell\n and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:\n yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

    \n
    • \n
  • \n

    A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

    \n
    • \n
  • \n

    Each log event can be no larger than 256 KB.

    \n
    • \n
  • \n

    The maximum number of log events in a batch is 10,000.

    \n
    • \n
  • \n \n

    The quota of five requests per second per log stream\n has been removed. Instead, PutLogEvents actions are throttled based on a \n per-second per-account quota. You can request an increase to the per-second throttling\n quota by using the Service Quotas service.

    \n     \n
    • \n
\n

If a call to PutLogEvents returns \"UnrecognizedClientException\" the most\n likely cause is a non-valid Amazon Web Services access key ID or secret key.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutLogEventsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

", + "smithy.api#required": {} + } + }, + "logEvents": { + "target": "com.amazonaws.cloudwatchlogs#InputLogEvents", + "traits": { + "smithy.api#documentation": "

The log events.

", + "smithy.api#required": {} + } + }, + "sequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken", + "traits": { + "smithy.api#documentation": "

The sequence token obtained from the response of the previous PutLogEvents\n call.

\n \n

The sequenceToken parameter is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are now accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid.

\n " + } + }, + "entity": { + "target": "com.amazonaws.cloudwatchlogs#Entity", + "traits": { + "smithy.api#documentation": "

Reserved for internal use.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutLogEventsResponse": { + "type": "structure", + "members": { + "nextSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken", + "traits": { + "smithy.api#documentation": "

The next sequence token.

\n \n

This field has been deprecated.

\n

The sequence token is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are always accepted even if the sequence token is not valid. You can use\n parallel PutLogEvents actions on the same log stream and you do not need\n to wait for the response of a previous PutLogEvents action to obtain \n the nextSequenceToken value.

\n " + } + }, + "rejectedLogEventsInfo": { + "target": "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo", + "traits": { + "smithy.api#documentation": "

The rejected events.

" + } + }, + "rejectedEntityInfo": { + "target": "com.amazonaws.cloudwatchlogs#RejectedEntityInfo", + "traits": { + "smithy.api#documentation": "

Reserved for internal use.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutMetricFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a metric filter and associates it with the specified log group. With\n metric filters, you can configure rules to extract metric data from log events ingested\n through PutLogEvents.

\n

The maximum number of metric filters that can be associated with a log group is\n 100.

\n

Using regular expressions to create metric filters is supported. For these filters, \n there is a quotas of quota of two regular expression patterns within a single filter pattern. There\n is also a quota of five regular expression patterns per log group.\n For more information about using regular expressions in metric filters, \n see \n Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.

\n

When you create a metric filter, you can also optionally assign a unit and dimensions\n to the metric that is created.

\n \n

Metrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n IPAddress or requestID as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n

\n

CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for\n your specified dimensions within one hour.

\n

You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n

\n " + } + }, + "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

A name for the metric filter.

", + "smithy.api#required": {} + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

A filter pattern for extracting metric data out of ingested log events.

", + "smithy.api#required": {} + } + }, + "metricTransformations": { + "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", + "traits": { + "smithy.api#documentation": "

A collection of information that defines how metric data gets emitted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutQueryDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a query definition for CloudWatch Logs Insights. For \n more information, see Analyzing Log Data with CloudWatch Logs Insights.

\n

To update a query definition, specify its queryDefinitionId in your request.\n The values of name, queryString, and logGroupNames are\n changed to the values that you specify in your update operation. No current values are\n retained from the current query definition. For example, imagine updating a current query\n definition that includes log groups. If you don't specify the logGroupNames\n parameter in your update operation, the query definition changes to contain no log\n groups.

\n

You must have the logs:PutQueryDefinition permission to be able to perform\n this operation.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutQueryDefinitionRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", + "traits": { + "smithy.api#documentation": "

A name for the query definition. If you are saving numerous query definitions, we\n recommend that you name them. This way, you can find the ones you want by using the first part\n of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

", + "smithy.api#required": {} + } + }, + "queryDefinitionId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

If you are updating a query definition, use this parameter to specify the ID of the query\n definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query\n definitions.

\n

If you are creating a query definition, do not specify this parameter. CloudWatch\n generates a unique ID for the new query definition and include it in the response to this\n operation.

" + } + }, + "logGroupNames": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", + "traits": { + "smithy.api#documentation": "

Use this parameter to include specific log groups as part of your query definition.

\n

If you are updating a query definition and you omit this parameter, then the updated\n definition will contain no log groups.

" + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", + "traits": { + "smithy.api#documentation": "

The query string to use for this definition. \n For more information, see CloudWatch Logs Insights Query Syntax.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.cloudwatchlogs#ClientToken", + "traits": { + "smithy.api#documentation": "

Used as an idempotency token, to avoid returning an exception if the service receives the same \n request twice because of a network\n\n error.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutQueryDefinitionResponse": { + "type": "structure", + "members": { + "queryDefinitionId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The ID of the query definition.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a resource policy allowing other Amazon Web Services services to put log events to\n this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services\n Region.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

Name of the new policy. This parameter is required.

" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", + "traits": { + "smithy.api#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.\n This parameter is required.

\n

The following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of \n your CloudWatch Logs resource, such as a log group or log stream.

\n

CloudWatch Logs also supports aws:SourceArn\n and aws:SourceAccount\ncondition context keys.

\n

In the example resource policy, you would replace the value of SourceArn with\n the resource making the call from Route 53 to CloudWatch Logs. You would also\n replace the value of SourceAccount with the Amazon Web Services account ID making\n that call.

\n

\n

\n {\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n },\n \"Action\": \"logs:PutLogEvents\",\n \"Resource\": \"logArn\",\n \"Condition\": {\n \"ArnLike\": {\n \"aws:SourceArn\": \"myRoute53ResourceArn\"\n },\n \"StringEquals\": {\n \"aws:SourceAccount\": \"myAwsAccountId\"\n }\n }\n }\n ]\n}\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "resourcePolicy": { + "target": "com.amazonaws.cloudwatchlogs#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The new policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutRetentionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutRetentionPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the retention of the specified log group. With a retention policy, you can\n configure the number of days for which to retain log events in the specified log\n group.

\n \n

CloudWatch Logs doesn't immediately delete log events when they reach their retention\n setting. It typically takes up to 72 hours after that before log events are deleted, but in\n rare situations might take longer.

\n

To illustrate, imagine that you change a log group to have a longer retention setting\n when it contains log events that are past the expiration date, but haven't been deleted.\n Those log events will take up to 72 hours to be deleted after the new retention date is\n reached. To make sure that log data is deleted permanently, keep a log group at its lower\n retention setting until 72 hours after the previous retention period ends. Alternatively,\n wait to change the retention setting until you confirm that the earlier log events are\n deleted.

\n

When log events reach their retention setting they are marked for deletion. After\n they are marked for deletion, they do not add to your archival storage costs anymore, even if \n they are not actually deleted until later. These log events marked for deletion are also not \n included when you use an API to retrieve the storedBytes value to see how many bytes a log group is storing.

\n " + } + }, + "com.amazonaws.cloudwatchlogs#PutRetentionPolicyRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "retentionInDays": { + "target": "com.amazonaws.cloudwatchlogs#Days", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutSubscriptionFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a subscription filter and associates it with the specified log\n group. With subscription filters, you can subscribe to a real-time stream of log events\n ingested through PutLogEvents\n and have them delivered to a specific destination. When log events are sent to the receiving\n service, they are Base64 encoded and compressed with the GZIP format.

\n

The following destinations are supported for subscription filters:

\n
    \n
  • \n

    An Amazon Kinesis data stream belonging to the same account as the subscription\n filter, for same-account delivery.

    \n
    • \n
  • \n

    A logical destination created with PutDestination that belongs to a different account, for cross-account delivery.\n We currently support Kinesis Data Streams and Firehose as logical destinations.

    \n
    • \n
  • \n

    An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as\n the subscription filter, for same-account delivery.

    \n
    • \n
  • \n

    An Lambda function that belongs to the same account as the\n subscription filter, for same-account delivery.

    \n
    • \n
\n

Each log group can have up to two subscription filters associated with it. If you are\n updating an existing filter, you must specify the correct name in filterName.\n

\n

Using regular expressions to create subscription filters is supported. For these filters, \n there is a quotas of quota of two regular expression patterns within a single filter pattern. There\n is also a quota of five regular expression patterns per log group.\n For more information about using regular expressions in subscription filters, \n see \n Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.

\n

To perform a PutSubscriptionFilter operation for any destination except a Lambda function, \n you must also have the \n iam:PassRole permission.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

A name for the subscription filter. If you are updating an existing filter, you must\n specify the correct name in filterName. To find the name of the filter currently\n associated with a log group, use DescribeSubscriptionFilters.

", + "smithy.api#required": {} + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

A filter pattern for subscribing to a filtered stream of log events.

", + "smithy.api#required": {} + } + }, + "destinationArn": { + "target": "com.amazonaws.cloudwatchlogs#DestinationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the destination to deliver matching log events to. Currently, the supported\n destinations are:

\n
    \n
  • \n

    An Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
  • \n

    A logical destination (specified using an ARN) belonging to a different account, \n for cross-account delivery.

    \n

    If you're setting up a cross-account subscription, the destination must have an IAM\n policy associated with it. The IAM policy must allow the sender to send logs to the\n destination. For more information, see PutDestinationPolicy.

    \n
    • \n
  • \n

    A Kinesis Data Firehose delivery stream belonging to the same account as the\n subscription filter, for same-account delivery.

    \n
    • \n
  • \n

    A Lambda function belonging to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log\n events to the destination stream. You don't need to provide the ARN when you are working with\n a logical destination for cross-account delivery.

" + } + }, + "distribution": { + "target": "com.amazonaws.cloudwatchlogs#Distribution", + "traits": { + "smithy.api#documentation": "

The method used to distribute log data to the destination. By default, log data is\n grouped by log stream, but the grouping can be set to random for a more even distribution.\n This property is only applicable when the destination is an Amazon Kinesis data stream.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#QueryCharOffset": { + "type": "integer" + }, + "com.amazonaws.cloudwatchlogs#QueryCompileError": { + "type": "structure", + "members": { + "location": { + "target": "com.amazonaws.cloudwatchlogs#QueryCompileErrorLocation", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + }, + "com.amazonaws.cloudwatchlogs#QueryCompileErrorLocation": { + "type": "structure", + "members": { + "startCharOffset": { + "target": "com.amazonaws.cloudwatchlogs#QueryCharOffset", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + }, + "endCharOffset": { + "target": "com.amazonaws.cloudwatchlogs#QueryCharOffset", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + }, + "com.amazonaws.cloudwatchlogs#QueryDefinition": { + "type": "structure", + "members": { + "queryDefinitionId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The unique ID of the query definition.

" + } + }, + "name": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", + "traits": { + "smithy.api#documentation": "

The name of the query definition.

" + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", + "traits": { + "smithy.api#documentation": "

The query string to use for this definition.\n For more information, see CloudWatch Logs Insights Query Syntax.

" + } + }, + "lastModified": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the query definition was most recently modified.

" + } + }, + "logGroupNames": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", + "traits": { + "smithy.api#documentation": "

If this query definition contains a list of log groups that it is limited to, that list appears here.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure contains details about a saved CloudWatch Logs Insights query definition.

" + } + }, + "com.amazonaws.cloudwatchlogs#QueryDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinition" + } + }, + "com.amazonaws.cloudwatchlogs#QueryDefinitionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryDefinitionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryInfo": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The unique ID number of this query.

" + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryString", + "traits": { + "smithy.api#documentation": "

The query string used in this query.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of this query. Possible values are Cancelled,\n Complete, Failed, Running, Scheduled, and Unknown.

" + } + }, + "createTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that this query was created.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group scanned by this query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.

" + } + }, + "com.amazonaws.cloudwatchlogs#QueryInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#QueryInfo" + } + }, + "com.amazonaws.cloudwatchlogs#QueryListMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryResults": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ResultRows" + } + }, + "com.amazonaws.cloudwatchlogs#QueryStatistics": { + "type": "structure", + "members": { + "recordsMatched": { + "target": "com.amazonaws.cloudwatchlogs#StatsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of log events that matched the query string.

" + } + }, + "recordsScanned": { + "target": "com.amazonaws.cloudwatchlogs#StatsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of log events scanned during the query.

" + } + }, + "bytesScanned": { + "target": "com.amazonaws.cloudwatchlogs#StatsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of bytes in the log events scanned during the query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the number of log events scanned by the query, the number of log events that matched the \n query criteria, and the total number of bytes in the log events that were scanned.

" + } + }, + "com.amazonaws.cloudwatchlogs#QueryStatus": { + "type": "enum", + "members": { + "Scheduled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } + }, + "Running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Running" + } + }, + "Complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Complete" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "Timeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Timeout" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + } + } + }, + "com.amazonaws.cloudwatchlogs#RecordField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#FieldHeader", + "traits": { + "smithy.api#documentation": "

The name to use when specifying this record field in a \n CreateDelivery or \n UpdateDeliveryConfiguration operation.

" + } + }, + "mandatory": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

If this is true, the record field must be present in the recordFields parameter provided to a \n CreateDelivery or \n UpdateDeliveryConfiguration operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a valid record field header and whether it is mandatory.

" + } + }, + "com.amazonaws.cloudwatchlogs#RecordFields": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#FieldHeader" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#RejectedEntityInfo": { + "type": "structure", + "members": { + "errorType": { + "target": "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType", + "traits": { + "smithy.api#documentation": "

Reserved for internal use.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Reserved for internal use.

" + } + }, + "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo": { + "type": "structure", + "members": { + "tooNewLogEventStartIndex": { + "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", + "traits": { + "smithy.api#documentation": "

The index of the first log event that is too new. This field is inclusive.

" + } + }, + "tooOldLogEventEndIndex": { + "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", + "traits": { + "smithy.api#documentation": "

The index of the last log event that is too old. This field is exclusive.

" + } + }, + "expiredLogEventEndIndex": { + "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", + "traits": { + "smithy.api#documentation": "

The expired log events.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the rejected events.

" + } + }, + "com.amazonaws.cloudwatchlogs#RequestId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#ResourceArns": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Arn" + } + }, + "com.amazonaws.cloudwatchlogs#ResourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w+=/:,.@\\-\\*]*$" + } + }, + "com.amazonaws.cloudwatchlogs#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#ResourcePolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ResourcePolicy" + } + }, + "com.amazonaws.cloudwatchlogs#ResourcePolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of the resource policy.

" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", + "traits": { + "smithy.api#documentation": "

The details of the policy.

" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp showing when this policy was last updated, expressed as the number of\n milliseconds after Jan 1, 1970 00:00:00 UTC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A policy enabling one or more entities to put logs to a log group in this account.

" + } + }, + "com.amazonaws.cloudwatchlogs#ResourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w-_]*$" + } + }, + "com.amazonaws.cloudwatchlogs#ResourceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ResourceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#ResultField": { + "type": "structure", + "members": { + "field": { + "target": "com.amazonaws.cloudwatchlogs#Field", + "traits": { + "smithy.api#documentation": "

The log event field.

" + } + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#Value", + "traits": { + "smithy.api#documentation": "

The value of this field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.

\n

For more information about the fields that are \n generated by CloudWatch logs, see \n Supported Logs and Discovered Fields.

" + } + }, + "com.amazonaws.cloudwatchlogs#ResultRows": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ResultField" + } + }, + "com.amazonaws.cloudwatchlogs#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration": { + "type": "structure", + "members": { + "suffixPath": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySuffixPath", + "traits": { + "smithy.api#documentation": "

This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables \n to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for \n more info on what values are supported in the suffix path for each log source.

" + } + }, + "enableHiveCompatiblePath": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

" + } + }, + "com.amazonaws.cloudwatchlogs#Scope": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#SearchedLogStream": { + "type": "structure", + "members": { + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

" + } + }, + "searchedCompletely": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamSearchedCompletely", + "traits": { + "smithy.api#documentation": "

Indicates whether all the events in this log stream were searched.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the search status of a log stream.

" + } + }, + "com.amazonaws.cloudwatchlogs#SearchedLogStreams": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#SearchedLogStream" + } + }, + "com.amazonaws.cloudwatchlogs#SelectionCriteria": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#SequenceToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Service": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w_-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

This request exceeds a service quota.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The service cannot complete the request.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.cloudwatchlogs#SessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#SessionStreamingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

his exception is returned if an unknown error occurs during a Live Tail session.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#SessionTimeoutException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is returned in a Live Tail stream when the Live Tail session times out. Live Tail sessions time\n out after three hours.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#StandardUnit": { + "type": "enum", + "members": { + "Seconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seconds" + } + }, + "Microseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Microseconds" + } + }, + "Milliseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Milliseconds" + } + }, + "Bytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes" + } + }, + "Kilobytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes" + } + }, + "Megabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes" + } + }, + "Gigabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes" + } + }, + "Terabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes" + } + }, + "Bits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits" + } + }, + "Kilobits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits" + } + }, + "Megabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits" + } + }, + "Gigabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits" + } + }, + "Terabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits" + } + }, + "Percent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Percent" + } + }, + "Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count" + } + }, + "BytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes/Second" + } + }, + "KilobytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes/Second" + } + }, + "MegabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes/Second" + } + }, + "GigabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes/Second" + } + }, + "TerabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes/Second" + } + }, + "BitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits/Second" + } + }, + "KilobitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits/Second" + } + }, + "MegabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits/Second" + } + }, + "GigabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits/Second" + } + }, + "TerabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits/Second" + } + }, + "CountSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count/Second" + } + }, + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#StartFromHead": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#StartLiveTail": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of \n log events that have\n been recently ingested in the log groups. For more information, see \n Use Live Tail to view logs in near real time.\n

\n

The response to this operation is a response stream, over which \n the server sends live log events and the client receives them.

\n

The following objects are sent over the stream:

\n
    \n
  • \n

    A single LiveTailSessionStart \n object is sent at the start of the session.

    \n
    • \n
  • \n

    Every second, a LiveTailSessionUpdate\n object is sent. Each of these objects contains an array of the actual log events.

    \n

    If no new log events were ingested in the past second, the \n LiveTailSessionUpdate object will contain an empty array.

    \n

    The array of log events contained in a LiveTailSessionUpdate can include\n as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the\n log events are sampled down to 500 log events to be included in each LiveTailSessionUpdate object.

    \n

    If your client consumes the log events slower than the server produces them, CloudWatch Logs\n buffers up to 10 LiveTailSessionUpdate events or 5000 log events, after \n which it starts dropping the oldest events.

    \n
    • \n
  • \n

    A SessionStreamingException \n object is returned if an unknown error occurs on the server side.

    \n
    • \n
  • \n

    A SessionTimeoutException \n object is returned when the session times out, after it has been kept open for three hours.

    \n
    • \n
\n \n

You can end a session before it times out by closing the session stream or by closing the client that is receiving the \n stream. The session also ends if the established connection between the client and the server breaks.

\n \n

For examples of using an SDK to start a Live Tail session, see \n \n Start a Live Tail session using an Amazon Web Services SDK.

", + "smithy.api#endpoint": { + "hostPrefix": "streaming-" + } + } + }, + "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#StartLiveTailRequest": { + "type": "structure", + "members": { + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

An array where each item in the array is a log group to include in the Live Tail session.

\n

Specify each log group by its ARN.

\n

If you specify an ARN, the ARN can't end with an asterisk (*).

\n \n

You can include up to 10 log groups.

\n ", + "smithy.api#required": {} + } + }, + "logStreamNames": { + "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", + "traits": { + "smithy.api#documentation": "

If you specify this parameter, then only log events in the log streams that you specify here are \n included in the Live Tail session.

\n

If you specify this field, you can't also specify the logStreamNamePrefixes field.

\n \n

You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

\n " + } + }, + "logStreamNamePrefixes": { + "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", + "traits": { + "smithy.api#documentation": "

If you specify this parameter, then only log events in the log streams that have names that start with the \n prefixes that you specify here are \n included in the Live Tail session.

\n

If you specify this field, you can't also specify the logStreamNames field.

\n \n

You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

\n " + } + }, + "logEventFilterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

An optional pattern to use to filter the results to include only log events that match the pattern.\n For example, a filter pattern of error 404 causes only log events that include both error \n and 404 to be included in the Live Tail stream.

\n

Regular expression filter patterns are supported.

\n

For more information about filter pattern syntax, see Filter and Pattern Syntax.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#StartLiveTailResponse": { + "type": "structure", + "members": { + "responseStream": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailResponseStream", + "traits": { + "smithy.api#documentation": "

An object that includes the stream returned by your request. It can include both log events and exceptions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#StartLiveTailResponseStream": { + "type": "union", + "members": { + "sessionStart": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionStart", + "traits": { + "smithy.api#documentation": "

This object contains information about this Live Tail session, including the log groups included and the \n log stream filters, if any.

" + } + }, + "sessionUpdate": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionUpdate", + "traits": { + "smithy.api#documentation": "

This object contains the log events and session metadata.

" + } + }, + "SessionTimeoutException": { + "target": "com.amazonaws.cloudwatchlogs#SessionTimeoutException", + "traits": { + "smithy.api#documentation": "

This exception is returned in the stream when the Live Tail session times out. Live Tail sessions time\n out after three hours.

" + } + }, + "SessionStreamingException": { + "target": "com.amazonaws.cloudwatchlogs#SessionStreamingException", + "traits": { + "smithy.api#documentation": "

This exception is returned if an unknown error occurs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This object includes the stream returned by your \n StartLiveTail\n request.

", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.cloudwatchlogs#StartQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#StartQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#StartQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#MalformedQueryException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group\n and time range to query and the query string to use.

\n

For more information, see CloudWatch Logs Insights Query Syntax.

\n

After you run a query using StartQuery, the query results are stored by CloudWatch Logs. \n You can use GetQueryResults to retrieve\n the results of a query, using the queryId that StartQuery returns.\n

\n

If you have associated a KMS key with the query results in this account, \n then \n StartQuery uses that key to \n encrypt the results when it stores them. If no key is associated with query results, the query results are \n encrypted with the default CloudWatch Logs encryption method.

\n

Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the\n time range being searched or partition your query into a number of queries.

\n

If you are using CloudWatch cross-account observability, you can use this operation in a\n monitoring account to start a query in a linked source account. For more information, see\n CloudWatch\n cross-account observability. For a cross-account StartQuery operation,\n the query definition must be defined in the monitoring account.

\n

You can have up to 30 concurrent CloudWatch Logs insights queries, including queries\n that have been added to dashboards.

" + } + }, + "com.amazonaws.cloudwatchlogs#StartQueryRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The log group on which to perform the query.

\n \n

A StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers.

\n " + } + }, + "logGroupNames": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", + "traits": { + "smithy.api#documentation": "

The list of log groups to be queried. You can include up to 50 log groups.

\n \n

A StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers.

\n " + } + }, + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

The list of log groups to query. You can include up to 50 log groups.

\n

You can specify them by the log group name or ARN. If a log group that you're querying is\n in a source account and you're using a monitoring account, you must specify the ARN of the log\n group here. The query definition must also be defined in the monitoring account.

\n

If you specify an ARN, the ARN can't end with an asterisk (*).

\n

A StartQuery operation must include exactly one of the following parameters:\n logGroupName, logGroupNames, or logGroupIdentifiers.

" + } + }, + "startTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The beginning of the time range to query. The range is inclusive, so the specified start\n time is included in the query. Specified as epoch time, the number of seconds since\n January 1, 1970, 00:00:00 UTC.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time range to query. The range is inclusive, so the specified end time is\n included in the query. Specified as epoch time, the number of seconds since January 1,\n 1970, 00:00:00 UTC.

", + "smithy.api#required": {} + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryString", + "traits": { + "smithy.api#documentation": "

The query string to use.\n For more information, see CloudWatch Logs Insights Query Syntax.

", + "smithy.api#required": {} + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of log events to return in the query. If the query string uses the fields command,\n only the specified fields and their values are returned. The default is 10,000.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#StartQueryResponse": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The unique ID of the query.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#State": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Suppressed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Suppressed" + } + }, + "Baseline": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Baseline" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#StatsValue": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#StopQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#StopQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#StopQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation\n returns an error indicating that the specified query is not running.

" + } + }, + "com.amazonaws.cloudwatchlogs#StopQueryRequest": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The ID number of the query to stop. To find this ID number, use\n DescribeQueries.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#StopQueryResponse": { + "type": "structure", + "members": { + "success": { + "target": "com.amazonaws.cloudwatchlogs#Success", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This is true if the query was stopped by the StopQuery operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#StoredBytes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudwatchlogs#SubscriptionFilter": { + "type": "structure", + "members": { + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the subscription filter.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "destinationArn": { + "target": "com.amazonaws.cloudwatchlogs#DestinationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

" + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

" + } + }, + "distribution": { + "target": "com.amazonaws.cloudwatchlogs#Distribution" + }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the subscription filter, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a subscription filter.

" + } + }, + "com.amazonaws.cloudwatchlogs#SubscriptionFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#SubscriptionFilter" + } + }, + "com.amazonaws.cloudwatchlogs#Success": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudwatchlogs#SuppressionPeriod": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.cloudwatchlogs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the number of seconds, minutes or hours to suppress this anomaly. There is no maximum.

" + } + }, + "suppressionUnit": { + "target": "com.amazonaws.cloudwatchlogs#SuppressionUnit", + "traits": { + "smithy.api#documentation": "

Specifies whether the value of value is in seconds, minutes, or hours.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

If you are suppressing an anomaly temporariliy, this structure defines how long the suppression period\n is to be.

" + } + }, + "com.amazonaws.cloudwatchlogs#SuppressionState": { + "type": "enum", + "members": { + "SUPPRESSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPPRESSED" + } + }, + "UNSUPPRESSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPRESSED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#SuppressionType": { + "type": "enum", + "members": { + "LIMITED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIMITED" + } + }, + "INFINITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFINITE" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#SuppressionUnit": { + "type": "enum", + "members": { + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECONDS" + } + }, + "MINUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTES" + } + }, + "HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURS" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$" + } + }, + "com.amazonaws.cloudwatchlogs#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#TagLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#TagLogGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API TagResource" }, - "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetectorRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing log anomaly detector.

" - } + "smithy.api#documentation": "\n

The TagLogGroup operation is on the path to deprecation. We recommend that you use \n TagResource instead.

\n \n

Adds or updates the specified tags for the specified log group.

\n

To list the tags for a log group, use ListTagsForResource.\n To remove tags, use UntagResource.

\n

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs\n in the Amazon CloudWatch Logs User Guide.

\n

CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to \n log groups using the aws:Resource/key-name\n or aws:TagKeys condition keys. \n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.

" + } + }, + "com.amazonaws.cloudwatchlogs#TagLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The key-value pairs to use for the tags.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model TagResourceRequest" }, - "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetectorRequest": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "

The ARN of the anomaly detector that you want to update.

", - "smithy.api#required": {} - } - }, - "evaluationFrequency": { - "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", - "traits": { - "smithy.api#documentation": "

Specifies how often the anomaly detector runs and look for anomalies. Set this value\n according to the frequency that the log group receives new logs. For example, if the log group\n receives new log events every 10 minutes, then setting evaluationFrequency to\n FIFTEEN_MIN might be appropriate.

" - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern" - }, - "anomalyVisibilityTime": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", - "traits": { - "smithy.api#documentation": "

The number of days to use as the life cycle of anomalies. After this time, anomalies are automatically baselined \n and the anomaly detector model will treat new occurrences of similar event as normal. Therefore, if you do not correct the cause of an \n anomaly during this time, it will be considered normal going forward and will not be detected.

" - } - }, - "enabled": { - "target": "com.amazonaws.cloudwatchlogs#Boolean", - "traits": { - "smithy.api#documentation": "

Use this parameter to pause or restart the anomaly detector.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. \n Currently, the only CloudWatch Logs resources that \n can be tagged are log groups and destinations.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

\n

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, \n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n the previous value for that tag.

\n

You can associate as many as 50 tags with a CloudWatch Logs resource.

" + } + }, + "com.amazonaws.cloudwatchlogs#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that you're adding tags to.

\n

The ARN format of a log group is \n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n

\n

The ARN format of a destination is \n arn:aws:logs:Region:account-id:destination:destination-name\n \n

\n

For more information about ARN format, see CloudWatch Logs \n resources and operations.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The list of key-value pairs to associate with the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.cloudwatchlogs#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#TagKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#TargetArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#TestEventMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#TestMetricFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#TestMetricFilterRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#TestMetricFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Tests the filter pattern of a metric filter against a sample of log event messages. You\n can use this operation to validate the correctness of a metric filter pattern.

" + } + }, + "com.amazonaws.cloudwatchlogs#TestMetricFilterRequest": { + "type": "structure", + "members": { + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#required": {} + } + }, + "logEventMessages": { + "target": "com.amazonaws.cloudwatchlogs#TestEventMessages", + "traits": { + "smithy.api#documentation": "

The log event messages to test.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#TestMetricFilterResponse": { + "type": "structure", + "members": { + "matches": { + "target": "com.amazonaws.cloudwatchlogs#MetricFilterMatches", + "traits": { + "smithy.api#documentation": "

The matched events.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The request was throttled because of quota limits.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#Time": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Timestamp": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudwatchlogs#Token": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#TokenString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#TokenValue": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + }, + "resourceName": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource can have no more than 50 tags.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudwatchlogs#Unmask": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudwatchlogs#UnrecognizedClientException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The most likely cause is an Amazon Web Services access key ID or secret key that's not\n valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#UntagLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API UntagResource" }, - "com.amazonaws.cloudwatchlogs#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "

One of the parameters for the request is not valid.

", - "smithy.api#error": "client" - } + "smithy.api#documentation": "\n

The UntagLogGroup operation is on the path to deprecation. We recommend that you use \n UntagResource instead.

\n \n

Removes the specified tags from the specified log group.

\n

To list the tags for a log group, use ListTagsForResource.\n To add tags, use TagResource.

\n

CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to \n log groups using the aws:Resource/key-name\n or aws:TagKeys condition keys. \n

" + } + }, + "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys. The corresponding tags are removed from the log group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model UntagResourceRequest" }, - "com.amazonaws.cloudwatchlogs#Value": { - "type": "string" + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes one or more tags from the specified resource.

" + } + }, + "com.amazonaws.cloudwatchlogs#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource that you're removing tags from.

\n

The ARN format of a log group is \n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n

\n

The ARN format of a destination is \n arn:aws:logs:Region:account-id:destination:destination-name\n \n

\n

For more information about ARN format, see CloudWatch Logs \n resources and operations.

", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.cloudwatchlogs#TagKeyList", + "traits": { + "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", + "smithy.api#required": {} + } } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateAnomaly": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UpdateAnomalyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress \n an anomaly, CloudWatch Logs won't report new occurrences of that anomaly and won't\n update that anomaly \n with new data. If you suppress a pattern, CloudWatch Logs won't report any anomalies related to that pattern.

\n

You must specify either anomalyId or patternId, but you can't specify both parameters in the \n same operation.

\n

If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause\n CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to \n stop suppressing, and omit the suppressionType and suppressionPeriod parameters.

" + } + }, + "com.amazonaws.cloudwatchlogs#UpdateAnomalyRequest": { + "type": "structure", + "members": { + "anomalyId": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyId", + "traits": { + "smithy.api#documentation": "

If you are suppressing or unsuppressing an anomaly, specify its unique ID here. You can find anomaly IDs by\n using the ListAnomalies operation.

" + } + }, + "patternId": { + "target": "com.amazonaws.cloudwatchlogs#PatternId", + "traits": { + "smithy.api#documentation": "

If you are suppressing or unsuppressing an pattern, specify its unique ID here. You can find pattern IDs by\n using the ListAnomalies operation.

" + } + }, + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN of the anomaly detector that this operation is to act on.

", + "smithy.api#required": {} + } + }, + "suppressionType": { + "target": "com.amazonaws.cloudwatchlogs#SuppressionType", + "traits": { + "smithy.api#documentation": "

Use this to specify whether the suppression to be temporary or infinite. If you specify LIMITED,\n you must also specify a suppressionPeriod. If you specify INFINITE,\n any value for suppressionPeriod is ignored.

" + } + }, + "suppressionPeriod": { + "target": "com.amazonaws.cloudwatchlogs#SuppressionPeriod", + "traits": { + "smithy.api#documentation": "

If you are temporarily suppressing an anomaly or pattern, use this structure to specify\n how long the suppression is to last.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to update the configuration of a delivery to change either the \n S3 path pattern or the format of the delivered logs. You can't use this operation to change the\n source or destination of the delivery.

" + } + }, + "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "

The ID of the delivery to be updated by this request.

", + "smithy.api#required": {} + } + }, + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "

The list of record fields to be delivered to the destination, in order. \n If the delivery's log source has mandatory fields, they must be included in this list.

" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

The field delimiter to use between record fields when the final output format of a delivery\n is in Plain, W3C, or Raw format.

" + } + }, + "s3DeliveryConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetectorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing log anomaly detector.

" + } + }, + "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetectorRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN of the anomaly detector that you want to update.

", + "smithy.api#required": {} + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "

Specifies how often the anomaly detector runs and look for anomalies. Set this value\n according to the frequency that the log group receives new logs. For example, if the log group\n receives new log events every 10 minutes, then setting evaluationFrequency to\n FIFTEEN_MIN might be appropriate.

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "anomalyVisibilityTime": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", + "traits": { + "smithy.api#documentation": "

The number of days to use as the life cycle of anomalies. After this time, anomalies are automatically baselined \n and the anomaly detector model will treat new occurrences of similar event as normal. Therefore, if you do not correct the cause of an \n anomaly during this time, it will be considered normal going forward and will not be detected.

" + } + }, + "enabled": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

Use this parameter to pause or restart the anomaly detector.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

One of the parameters for the request is not valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#Value": { + "type": "string" } + } }