|
29 | 29 | ] |
30 | 30 | }, |
31 | 31 | "shapes": { |
| 32 | + "com.amazonaws.athena#AclConfiguration": { |
| 33 | + "type": "structure", |
| 34 | + "members": { |
| 35 | + "S3AclOption": { |
| 36 | + "target": "com.amazonaws.athena#S3AclOption", |
| 37 | + "traits": { |
| 38 | + "smithy.api#documentation": "<p>The Amazon S3 canned ACL that Athena should specify when storing\n query results. Currently the only supported canned ACL is\n <code>BUCKET_OWNER_FULL_CONTROL</code>. If a query runs in a workgroup and the\n workgroup overrides client-side settings, then the Amazon S3 canned ACL\n specified in the workgroup's settings is used for all queries that run in the workgroup.\n For more information about Amazon S3 canned ACLs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl\">Canned ACL</a> in the <i>Amazon S3 User\n Guide</i>.</p>", |
| 39 | + "smithy.api#required": {} |
| 40 | + } |
| 41 | + } |
| 42 | + }, |
| 43 | + "traits": { |
| 44 | + "smithy.api#documentation": "<p>Indicates that an Amazon S3 canned ACL should be set to control ownership of\n stored query results. When Athena stores query results in Amazon S3,\n the canned ACL is set with the <code>x-amz-acl</code> request header. For more\n information about S3 Object Ownership, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview\">Object Ownership settings</a> in the <i>Amazon S3 User\n Guide</i>.</p>" |
| 45 | + } |
| 46 | + }, |
32 | 47 | "com.amazonaws.athena#AmazonAthena": { |
33 | 48 | "type": "service", |
34 | 49 | "traits": { |
|
144 | 159 | { |
145 | 160 | "target": "com.amazonaws.athena#UpdateDataCatalog" |
146 | 161 | }, |
| 162 | + { |
| 163 | + "target": "com.amazonaws.athena#UpdateNamedQuery" |
| 164 | + }, |
147 | 165 | { |
148 | 166 | "target": "com.amazonaws.athena#UpdatePreparedStatement" |
149 | 167 | }, |
|
167 | 185 | "ErrorCategory": { |
168 | 186 | "target": "com.amazonaws.athena#ErrorCategory", |
169 | 187 | "traits": { |
170 | | - "smithy.api#documentation": "<p>An integer value that specifies the category of a query failure error. The following\n list shows the category for each integer value.</p>\n <p>\n <b>1</b> - System</p>\n <p>\n <b>2</b> - User</p>\n <p>\n <b>3</b> - Unknown</p>" |
| 188 | + "smithy.api#documentation": "<p>An integer value that specifies the category of a query failure error. The following\n list shows the category for each integer value.</p>\n <p>\n <b>1</b> - System</p>\n <p>\n <b>2</b> - User</p>\n <p>\n <b>3</b> - Other</p>" |
171 | 189 | } |
172 | 190 | }, |
173 | 191 | "ErrorType": { |
|
178 | 196 | } |
179 | 197 | }, |
180 | 198 | "traits": { |
181 | | - "smithy.api#documentation": "<p>Provides information about an Athena query error. The\n <code>AthenaError</code> feature provides standardized error information to help you\n understand failed queries and take steps after a query failure occurs.\n <code>AthenaError</code> includes an <code>ErrorCategory</code> field that specifies\n whether the cause of the failed query is due to system error, user error, or unknown\n error.</p>" |
| 199 | + "smithy.api#documentation": "<p>Provides information about an Athena query error. The\n <code>AthenaError</code> feature provides standardized error information to help you\n understand failed queries and take steps after a query failure occurs.\n <code>AthenaError</code> includes an <code>ErrorCategory</code> field that specifies\n whether the cause of the failed query is due to system error, user error, or other\n error.</p>" |
182 | 200 | } |
183 | 201 | }, |
184 | 202 | "com.amazonaws.athena#BatchGetNamedQuery": { |
|
2320 | 2338 | "QueryString": { |
2321 | 2339 | "target": "com.amazonaws.athena#QueryString", |
2322 | 2340 | "traits": { |
2323 | | - "smithy.api#documentation": "<p>The SQL query statements that comprise the query.</p>", |
| 2341 | + "smithy.api#documentation": "<p>The SQL statements that make up the query.</p>", |
2324 | 2342 | "smithy.api#required": {} |
2325 | 2343 | } |
2326 | 2344 | }, |
|
2338 | 2356 | } |
2339 | 2357 | }, |
2340 | 2358 | "traits": { |
2341 | | - "smithy.api#documentation": "<p>A query, where <code>QueryString</code> is the list of SQL query statements that\n comprise the query.</p>" |
| 2359 | + "smithy.api#documentation": "<p>A query, where <code>QueryString</code> contains the SQL statements that\n make up the query.</p>" |
| 2360 | + } |
| 2361 | + }, |
| 2362 | + "com.amazonaws.athena#NamedQueryDescriptionString": { |
| 2363 | + "type": "string", |
| 2364 | + "traits": { |
| 2365 | + "smithy.api#length": { |
| 2366 | + "min": 0, |
| 2367 | + "max": 1024 |
| 2368 | + } |
2342 | 2369 | } |
2343 | 2370 | }, |
2344 | 2371 | "com.amazonaws.athena#NamedQueryId": { |
|
2712 | 2739 | "traits": { |
2713 | 2740 | "smithy.api#documentation": "<p>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>.\n If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it\n makes Amazon S3 calls to your specified output location. If the\n <code>ExpectedBucketOwner</code>\n Amazon Web Services account ID does not match the actual owner of the Amazon S3\n bucket, the call fails with a permissions error.</p>\n <p>This is a client-side setting. If workgroup settings override client-side settings,\n then the query uses the <code>ExpectedBucketOwner</code> setting that is specified for\n the workgroup, and also uses the location for storing query results specified in the\n workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>\n and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>" |
2714 | 2741 | } |
| 2742 | + }, |
| 2743 | + "AclConfiguration": { |
| 2744 | + "target": "com.amazonaws.athena#AclConfiguration", |
| 2745 | + "traits": { |
| 2746 | + "smithy.api#documentation": "<p>Indicates that an Amazon S3 canned ACL should be set to control ownership of\n stored query results. Currently the only supported canned ACL is\n <code>BUCKET_OWNER_FULL_CONTROL</code>. This is a client-side setting. If workgroup\n settings override client-side settings, then the query uses the ACL configuration that\n is specified for the workgroup, and also uses the location for storing query results\n specified in the workgroup. For more information, see <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>" |
| 2747 | + } |
2715 | 2748 | } |
2716 | 2749 | }, |
2717 | 2750 | "traits": { |
|
2756 | 2789 | "traits": { |
2757 | 2790 | "smithy.api#documentation": "<p>If set to \"true\", removes the Amazon Web Services account ID previously specified for\n <a>ResultConfiguration$ExpectedBucketOwner</a>. If set to \"false\" or not\n set, and a value is present in the <code>ExpectedBucketOwner</code> in\n <code>ResultConfigurationUpdates</code> (the client-side setting), the\n <code>ExpectedBucketOwner</code> in the workgroup's <code>ResultConfiguration</code>\n is updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override\n Client-Side Settings</a>.</p>" |
2758 | 2791 | } |
| 2792 | + }, |
| 2793 | + "AclConfiguration": { |
| 2794 | + "target": "com.amazonaws.athena#AclConfiguration", |
| 2795 | + "traits": { |
| 2796 | + "smithy.api#documentation": "<p>The ACL configuration for the query results.</p>" |
| 2797 | + } |
| 2798 | + }, |
| 2799 | + "RemoveAclConfiguration": { |
| 2800 | + "target": "com.amazonaws.athena#BoxedBoolean", |
| 2801 | + "traits": { |
| 2802 | + "smithy.api#documentation": "<p>If set to <code>true</code>, indicates that the previously-specified ACL configuration\n for queries in this workgroup should be ignored and set to null. If set to\n <code>false</code> or not set, and a value is present in the\n <code>AclConfiguration</code> of <code>ResultConfigurationUpdates</code>, the\n <code>AclConfiguration</code> in the workgroup's <code>ResultConfiguration</code> is\n updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override\n Client-Side Settings</a>.</p>" |
| 2803 | + } |
2759 | 2804 | } |
2760 | 2805 | }, |
2761 | 2806 | "traits": { |
|
2779 | 2824 | } |
2780 | 2825 | }, |
2781 | 2826 | "traits": { |
2782 | | - "smithy.api#documentation": "<p>The metadata and rows that comprise a query result set. The metadata describes the\n column structure and data types. To return a <code>ResultSet</code> object, use <a>GetQueryResults</a>.</p>" |
| 2827 | + "smithy.api#documentation": "<p>The metadata and rows that make up a query result set. The metadata describes the\n column structure and data types. To return a <code>ResultSet</code> object, use <a>GetQueryResults</a>.</p>" |
2783 | 2828 | } |
2784 | 2829 | }, |
2785 | 2830 | "com.amazonaws.athena#ResultSetMetadata": { |
|
2807 | 2852 | } |
2808 | 2853 | }, |
2809 | 2854 | "traits": { |
2810 | | - "smithy.api#documentation": "<p>The rows that comprise a query result table.</p>" |
| 2855 | + "smithy.api#documentation": "<p>The rows that make up a query result table.</p>" |
2811 | 2856 | } |
2812 | 2857 | }, |
2813 | 2858 | "com.amazonaws.athena#RowList": { |
|
2816 | 2861 | "target": "com.amazonaws.athena#Row" |
2817 | 2862 | } |
2818 | 2863 | }, |
| 2864 | + "com.amazonaws.athena#S3AclOption": { |
| 2865 | + "type": "string", |
| 2866 | + "traits": { |
| 2867 | + "smithy.api#enum": [ |
| 2868 | + { |
| 2869 | + "value": "BUCKET_OWNER_FULL_CONTROL", |
| 2870 | + "name": "BUCKET_OWNER_FULL_CONTROL" |
| 2871 | + } |
| 2872 | + ] |
| 2873 | + } |
| 2874 | + }, |
2819 | 2875 | "com.amazonaws.athena#StartQueryExecution": { |
2820 | 2876 | "type": "operation", |
2821 | 2877 | "input": { |
|
3334 | 3390 | "type": "structure", |
3335 | 3391 | "members": {} |
3336 | 3392 | }, |
| 3393 | + "com.amazonaws.athena#UpdateNamedQuery": { |
| 3394 | + "type": "operation", |
| 3395 | + "input": { |
| 3396 | + "target": "com.amazonaws.athena#UpdateNamedQueryInput" |
| 3397 | + }, |
| 3398 | + "output": { |
| 3399 | + "target": "com.amazonaws.athena#UpdateNamedQueryOutput" |
| 3400 | + }, |
| 3401 | + "errors": [ |
| 3402 | + { |
| 3403 | + "target": "com.amazonaws.athena#InternalServerException" |
| 3404 | + }, |
| 3405 | + { |
| 3406 | + "target": "com.amazonaws.athena#InvalidRequestException" |
| 3407 | + } |
| 3408 | + ], |
| 3409 | + "traits": { |
| 3410 | + "smithy.api#documentation": "<p>Updates a <a>NamedQuery</a> object. The database or workgroup cannot be updated.</p>", |
| 3411 | + "smithy.api#idempotent": {} |
| 3412 | + } |
| 3413 | + }, |
| 3414 | + "com.amazonaws.athena#UpdateNamedQueryInput": { |
| 3415 | + "type": "structure", |
| 3416 | + "members": { |
| 3417 | + "NamedQueryId": { |
| 3418 | + "target": "com.amazonaws.athena#NamedQueryId", |
| 3419 | + "traits": { |
| 3420 | + "smithy.api#documentation": "<p>The unique identifier (UUID) of the query.</p>", |
| 3421 | + "smithy.api#required": {} |
| 3422 | + } |
| 3423 | + }, |
| 3424 | + "Name": { |
| 3425 | + "target": "com.amazonaws.athena#NameString", |
| 3426 | + "traits": { |
| 3427 | + "smithy.api#documentation": "<p>The name of the query.</p>", |
| 3428 | + "smithy.api#required": {} |
| 3429 | + } |
| 3430 | + }, |
| 3431 | + "Description": { |
| 3432 | + "target": "com.amazonaws.athena#NamedQueryDescriptionString", |
| 3433 | + "traits": { |
| 3434 | + "smithy.api#documentation": "<p>The query description.</p>" |
| 3435 | + } |
| 3436 | + }, |
| 3437 | + "QueryString": { |
| 3438 | + "target": "com.amazonaws.athena#QueryString", |
| 3439 | + "traits": { |
| 3440 | + "smithy.api#documentation": "<p>The contents of the query with all query statements.</p>", |
| 3441 | + "smithy.api#required": {} |
| 3442 | + } |
| 3443 | + } |
| 3444 | + } |
| 3445 | + }, |
| 3446 | + "com.amazonaws.athena#UpdateNamedQueryOutput": { |
| 3447 | + "type": "structure", |
| 3448 | + "members": {} |
| 3449 | + }, |
3337 | 3450 | "com.amazonaws.athena#UpdatePreparedStatement": { |
3338 | 3451 | "type": "operation", |
3339 | 3452 | "input": { |
|
0 commit comments