Skip to content

Commit

Permalink
Update API model
Browse files Browse the repository at this point in the history
  • Loading branch information
AWS SDK for Go v2 automation user committed Nov 4, 2022
1 parent fb07380 commit 0f7f62a
Show file tree
Hide file tree
Showing 3 changed files with 2,355 additions and 296 deletions.
14 changes: 7 additions & 7 deletions codegen/sdk-codegen/aws-models/cloudwatch-logs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Creates an export task, which allows you to efficiently export data from a\n log group to an Amazon S3 bucket. When you perform a <code>CreateExportTask</code>\n operation, you must use credentials that have permission to write to the S3 bucket \n that you specify as the destination.</p>\n <p>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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html\">DescribeExportTasks</a> to get the status of the export task. Each account can\n only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time.\n To cancel an export task, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html\">CancelExportTask</a>.</p>\n <p>You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate out log data for each export task, you can specify a prefix to be used as\n the Amazon S3 key prefix for all exported objects.</p>\n <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets \n encrypted with SSE-KMS is not supported. </p>"
"smithy.api#documentation": "<p>Creates an export task, which allows you to efficiently export data from a\n log group to an Amazon S3 bucket. When you perform a <code>CreateExportTask</code>\n operation, you must use credentials that have permission to write to the S3 bucket \n that you specify as the destination.</p>\n <p>Exporting log data to Amazon S3 buckets that are encrypted by KMS is \n supported. Exporting\n log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.</p>\n <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. </p>\n <p>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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html\">DescribeExportTasks</a> to get the status of the export task. Each account can\n only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time.\n To cancel an export task, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html\">CancelExportTask</a>.</p>\n <p>You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate out log data for each export task, you can specify a prefix to be used as\n the Amazon S3 key prefix for all exported objects.</p>\n \n <note>\n <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the \n exported log fild data by using Linux utilities.</p>\n </note>"
}
},
"com.amazonaws.cloudwatchlogs#CreateExportTaskRequest": {
Expand Down Expand Up @@ -197,7 +197,7 @@
"to": {
"target": "com.amazonaws.cloudwatchlogs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>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 not\n exported.</p>",
"smithy.api#documentation": "<p>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 not\n exported.</p>\n <p>You must specify a time that is not earlier than when this log group was created.</p>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -343,7 +343,7 @@
"com.amazonaws.cloudwatchlogs#Days": {
"type": "integer",
"traits": {
"smithy.api#documentation": "<p>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, 1827, and 3653.</p>\n <p>To set a log group to never have log events expire, use\n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html\">DeleteRetentionPolicy</a>.\n </p>"
"smithy.api#documentation": "<p>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, 1827, 2192, 2557, 2922, 3288, and 3653.</p>\n <p>To set a log group to never have log events expire, use\n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html\">DeleteRetentionPolicy</a>.\n </p>"
}
},
"com.amazonaws.cloudwatchlogs#DefaultValue": {
Expand Down Expand Up @@ -726,7 +726,7 @@
"limit": {
"target": "com.amazonaws.cloudwatchlogs#DescribeLimit",
"traits": {
"smithy.api#documentation": "<p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>"
"smithy.api#documentation": "<p>The maximum number of items returned. If you don't specify a value, the default maximum value of \n 50 items is used.</p>"
}
}
}
Expand Down Expand Up @@ -1692,7 +1692,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>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.</p>\n <p>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 time range that you specify. If the results\n include a token, then there are more log events available, and you can get additional results\n by specifying the token in a subsequent call. This operation can return empty results\n while there are more log events available through the token.</p>\n <p>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 <code>PutLogEvents</code> request.</p>",
"smithy.api#documentation": "<p>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.</p>\n <p>You must have the <code>logs;FilterLogEvents</code> permission to perform this operation.</p>\n <p>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 time range that you specify. If the results\n include a token, then there are more log events available, and you can get additional results\n by specifying the token in a subsequent call. This operation can return empty results\n while there are more log events available through the token.</p>\n <p>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 <code>PutLogEvents</code> request.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
Expand Down Expand Up @@ -5500,7 +5500,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Sets the retention of the specified log group. A retention policy allows you to\n configure the number of days for which to retain log events in the specified log\n group.</p>"
"smithy.api#documentation": "<p>Sets the retention of the specified log group. A retention policy allows you to\n configure the number of days for which to retain log events in the specified log\n group.</p>\n <note>\n <p>CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. \n It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.</p>\n <p>This means that if you change a log group to have a longer retention setting when it contains log events \n that are past the expiration date, but haven’t been actually deleted, those log events will take \n up to 72 hours to be deleted after the new retention date is reached. To make sure \n that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours has passed\n after the end of the previous\n retention period, or you have confirmed that the older log events are deleted.\n </p>\n </note>"
}
},
"com.amazonaws.cloudwatchlogs#PutRetentionPolicyRequest": {
Expand Down Expand Up @@ -6212,7 +6212,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>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.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html\">CloudWatch Logs Insights Query Syntax</a>.</p>\n \n <p>Queries time out after 15 minutes of execution. If your queries are timing out, reduce the\n time range being searched or partition your query into a number of queries.</p>"
"smithy.api#documentation": "<p>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.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html\">CloudWatch Logs Insights Query Syntax</a>.</p>\n \n <p>Queries time out after 15 minutes of execution. If your queries are timing out, reduce the\n time range being searched or partition your query into a number of queries.</p>\n \n <p>\n You are limited to 20 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards. \n </p>"
}
},
"com.amazonaws.cloudwatchlogs#StartQueryRequest": {
Expand Down
Loading

0 comments on commit 0f7f62a

Please sign in to comment.