|
1021 | 1021 | "members":{
|
1022 | 1022 | "S3AclOption":{
|
1023 | 1023 | "shape":"S3AclOption",
|
1024 |
| - "documentation":"<p>The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is <code>BUCKET_OWNER_FULL_CONTROL</code>. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. 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 Guide</i>.</p>" |
| 1024 | + "documentation":"<p>The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is <code>BUCKET_OWNER_FULL_CONTROL</code>. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. 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 Guide</i>.</p>" |
1025 | 1025 | }
|
1026 | 1026 | },
|
1027 |
| - "documentation":"<p>Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. When Athena stores query results in Amazon S3, the canned ACL is set with the <code>x-amz-acl</code> request header. For more 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 Guide</i>.</p>" |
| 1027 | + "documentation":"<p>Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. When Athena stores query results in Amazon S3, the canned ACL is set with the <code>x-amz-acl</code> request header. For more 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 Guide</i>.</p>" |
1028 | 1028 | },
|
1029 | 1029 | "Age":{
|
1030 | 1030 | "type":"integer",
|
|
1538 | 1538 | "min":0,
|
1539 | 1539 | "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
1540 | 1540 | },
|
1541 |
| - "ConnectionType":{ |
1542 |
| - "type":"string", |
1543 |
| - "enum":[ |
1544 |
| - "DYNAMODB", |
1545 |
| - "MYSQL", |
1546 |
| - "POSTGRESQL", |
1547 |
| - "REDSHIFT", |
1548 |
| - "ORACLE", |
1549 |
| - "SYNAPSE", |
1550 |
| - "SQLSERVER", |
1551 |
| - "DB2", |
1552 |
| - "OPENSEARCH", |
1553 |
| - "BIGQUERY", |
1554 |
| - "GOOGLECLOUDSTORAGE", |
1555 |
| - "HBASE", |
1556 |
| - "DOCUMENTDB", |
1557 |
| - "MSK", |
1558 |
| - "NEPTUNE", |
1559 |
| - "CMDB", |
1560 |
| - "TPCDS", |
1561 |
| - "REDIS", |
1562 |
| - "CLOUDWATCH", |
1563 |
| - "TIMESTREAM", |
1564 |
| - "SAPHANA", |
1565 |
| - "SNOWFLAKE", |
1566 |
| - "TERADATA", |
1567 |
| - "VERTICA", |
1568 |
| - "CLOUDERAIMPALA", |
1569 |
| - "CLOUDERAHIVE", |
1570 |
| - "HORTONWORKSHIVE", |
1571 |
| - "DATALAKEGEN2", |
1572 |
| - "DB2AS400", |
1573 |
| - "CLOUDWATCHMETRICS" |
1574 |
| - ] |
1575 |
| - }, |
1576 | 1541 | "CoordinatorDpuSize":{
|
1577 | 1542 | "type":"integer",
|
1578 | 1543 | "box":true,
|
|
1618 | 1583 | },
|
1619 | 1584 | "Type":{
|
1620 | 1585 | "shape":"DataCatalogType",
|
1621 |
| - "documentation":"<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog, <code>GLUE</code> for an Glue Data Catalog, and <code>HIVE</code> for an external Apache Hive metastore. <code>FEDERATED</code> is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.</p>" |
| 1586 | + "documentation":"<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog, <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an Glue Data Catalog.</p>" |
1622 | 1587 | },
|
1623 | 1588 | "Description":{
|
1624 | 1589 | "shape":"DescriptionString",
|
1625 | 1590 | "documentation":"<p>A description of the data catalog to be created.</p>"
|
1626 | 1591 | },
|
1627 | 1592 | "Parameters":{
|
1628 | 1593 | "shape":"ParametersMap",
|
1629 |
| - "documentation":"<p>Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> <li> <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The <code> <i>catalog_id</i> </code> is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.</p> <p> <code>catalog-id=<i>catalog_id</i> </code> </p> <ul> <li> <p>The <code>GLUE</code> data catalog type also applies to the default <code>AwsDataCatalog</code> that already exists in your account, of which you can have only one and cannot modify.</p> </li> </ul> </li> <li> <p>The <code>FEDERATED</code> data catalog type uses one of the following parameters, but not both. Use <code>connection-arn</code> for an existing Glue connection. Use <code>connection-type</code> and <code>connection-properties</code> to specify the configuration setting for a new connection.</p> <ul> <li> <p> <code>connection-arn:<i><glue_connection_arn_to_reuse></i> </code> </p> </li> <li> <p> <code>lambda-role-arn</code> (optional): The execution role to use for the Lambda function. If not provided, one is created.</p> </li> <li> <p> <code>connection-type:MYSQL|REDSHIFT|...., connection-properties:\"<i><json_string></i>\"</code> </p> <p>For <i> <code><json_string></code> </i>, use escaped JSON text, as in the following example.</p> <p> <code>\"{\\\"spill_bucket\\\":\\\"my_spill\\\",\\\"spill_prefix\\\":\\\"athena-spill\\\",\\\"host\\\":\\\"abc12345.snowflakecomputing.com\\\",\\\"port\\\":\\\"1234\\\",\\\"warehouse\\\":\\\"DEV_WH\\\",\\\"database\\\":\\\"TEST\\\",\\\"schema\\\":\\\"PUBLIC\\\",\\\"SecretArn\\\":\\\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\\\"}\"</code> </p> </li> </ul> </li> </ul>" |
| 1594 | + "documentation":"<p>Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> <li> <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The <code> <i>catalog_id</i> </code> is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.</p> <p> <code>catalog-id=<i>catalog_id</i> </code> </p> <ul> <li> <p>The <code>GLUE</code> data catalog type also applies to the default <code>AwsDataCatalog</code> that already exists in your account, of which you can have only one and cannot modify.</p> </li> </ul> </li> </ul>" |
1630 | 1595 | },
|
1631 | 1596 | "Tags":{
|
1632 | 1597 | "shape":"TagList",
|
|
1637 | 1602 | "CreateDataCatalogOutput":{
|
1638 | 1603 | "type":"structure",
|
1639 | 1604 | "members":{
|
1640 |
| - "DataCatalog":{"shape":"DataCatalog"} |
1641 | 1605 | }
|
1642 | 1606 | },
|
1643 | 1607 | "CreateNamedQueryInput":{
|
|
1832 | 1796 | },
|
1833 | 1797 | "Type":{
|
1834 | 1798 | "shape":"DataCatalogType",
|
1835 |
| - "documentation":"<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog, <code>GLUE</code> for an Glue Data Catalog, and <code>HIVE</code> for an external Apache Hive metastore. <code>FEDERATED</code> is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.</p>" |
| 1799 | + "documentation":"<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog, <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an Glue Data Catalog.</p>" |
1836 | 1800 | },
|
1837 | 1801 | "Parameters":{
|
1838 | 1802 | "shape":"ParametersMap",
|
1839 |
| - "documentation":"<p>Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> <li> <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The <code> <i>catalog_id</i> </code> is the account ID of the Amazon Web Services account to which the Glue catalog belongs.</p> <p> <code>catalog-id=<i>catalog_id</i> </code> </p> <ul> <li> <p>The <code>GLUE</code> data catalog type also applies to the default <code>AwsDataCatalog</code> that already exists in your account, of which you can have only one and cannot modify.</p> </li> </ul> </li> <li> <p>The <code>FEDERATED</code> data catalog type uses one of the following parameters, but not both. Use <code>connection-arn</code> for an existing Glue connection. Use <code>connection-type</code> and <code>connection-properties</code> to specify the configuration setting for a new connection.</p> <ul> <li> <p> <code>connection-arn:<i><glue_connection_arn_to_reuse></i> </code> </p> </li> <li> <p> <code>connection-type:MYSQL|REDSHIFT|...., connection-properties:\"<i><json_string></i>\"</code> </p> <p>For <i> <code><json_string></code> </i>, use escaped JSON text, as in the following example.</p> <p> <code>\"{\\\"spill_bucket\\\":\\\"my_spill\\\",\\\"spill_prefix\\\":\\\"athena-spill\\\",\\\"host\\\":\\\"abc12345.snowflakecomputing.com\\\",\\\"port\\\":\\\"1234\\\",\\\"warehouse\\\":\\\"DEV_WH\\\",\\\"database\\\":\\\"TEST\\\",\\\"schema\\\":\\\"PUBLIC\\\",\\\"SecretArn\\\":\\\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\\\"}\"</code> </p> </li> </ul> </li> </ul>" |
1840 |
| - }, |
1841 |
| - "Status":{ |
1842 |
| - "shape":"DataCatalogStatus", |
1843 |
| - "documentation":"<p>The status of the creation or deletion of the data catalog.</p> <ul> <li> <p>The <code>LAMBDA</code>, <code>GLUE</code>, and <code>HIVE</code> data catalog types are created synchronously. Their status is either <code>CREATE_COMPLETE</code> or <code>CREATE_FAILED</code>.</p> </li> <li> <p>The <code>FEDERATED</code> data catalog type is created asynchronously.</p> </li> </ul> <p>Data catalog creation status:</p> <ul> <li> <p> <code>CREATE_IN_PROGRESS</code>: Federated data catalog creation in progress.</p> </li> <li> <p> <code>CREATE_COMPLETE</code>: Data catalog creation complete.</p> </li> <li> <p> <code>CREATE_FAILED</code>: Data catalog could not be created.</p> </li> <li> <p> <code>CREATE_FAILED_CLEANUP_IN_PROGRESS</code>: Federated data catalog creation failed and is being removed.</p> </li> <li> <p> <code>CREATE_FAILED_CLEANUP_COMPLETE</code>: Federated data catalog creation failed and was removed.</p> </li> <li> <p> <code>CREATE_FAILED_CLEANUP_FAILED</code>: Federated data catalog creation failed but could not be removed.</p> </li> </ul> <p>Data catalog deletion status:</p> <ul> <li> <p> <code>DELETE_IN_PROGRESS</code>: Federated data catalog deletion in progress.</p> </li> <li> <p> <code>DELETE_COMPLETE</code>: Federated data catalog deleted.</p> </li> <li> <p> <code>DELETE_FAILED</code>: Federated data catalog could not be deleted.</p> </li> </ul>" |
1844 |
| - }, |
1845 |
| - "ConnectionType":{ |
1846 |
| - "shape":"ConnectionType", |
1847 |
| - "documentation":"<p>The type of connection for a <code>FEDERATED</code> data catalog (for example, <code>REDSHIFT</code>, <code>MYSQL</code>, or <code>SQLSERVER</code>). For information about individual connectors, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/connectors-available.html\">Available data source connectors</a>.</p>" |
1848 |
| - }, |
1849 |
| - "Error":{ |
1850 |
| - "shape":"ErrorMessage", |
1851 |
| - "documentation":"<p>Text of the error that occurred during data catalog creation or deletion.</p>" |
| 1803 | + "documentation":"<p>Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> <li> <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The <code> <i>catalog_id</i> </code> is the account ID of the Amazon Web Services account to which the Glue catalog belongs.</p> <p> <code>catalog-id=<i>catalog_id</i> </code> </p> <ul> <li> <p>The <code>GLUE</code> data catalog type also applies to the default <code>AwsDataCatalog</code> that already exists in your account, of which you can have only one and cannot modify.</p> </li> </ul> </li> </ul>" |
1852 | 1804 | }
|
1853 | 1805 | },
|
1854 | 1806 | "documentation":"<p>Contains information about a data catalog in an Amazon Web Services account.</p> <note> <p>In the Athena console, data catalogs are listed as \"data sources\" on the <b>Data sources</b> page under the <b>Data source name</b> column.</p> </note>"
|
1855 | 1807 | },
|
1856 |
| - "DataCatalogStatus":{ |
1857 |
| - "type":"string", |
1858 |
| - "enum":[ |
1859 |
| - "CREATE_IN_PROGRESS", |
1860 |
| - "CREATE_COMPLETE", |
1861 |
| - "CREATE_FAILED", |
1862 |
| - "CREATE_FAILED_CLEANUP_IN_PROGRESS", |
1863 |
| - "CREATE_FAILED_CLEANUP_COMPLETE", |
1864 |
| - "CREATE_FAILED_CLEANUP_FAILED", |
1865 |
| - "DELETE_IN_PROGRESS", |
1866 |
| - "DELETE_COMPLETE", |
1867 |
| - "DELETE_FAILED" |
1868 |
| - ] |
1869 |
| - }, |
1870 | 1808 | "DataCatalogSummary":{
|
1871 | 1809 | "type":"structure",
|
1872 | 1810 | "members":{
|
|
1877 | 1815 | "Type":{
|
1878 | 1816 | "shape":"DataCatalogType",
|
1879 | 1817 | "documentation":"<p>The data catalog type.</p>"
|
1880 |
| - }, |
1881 |
| - "Status":{ |
1882 |
| - "shape":"DataCatalogStatus", |
1883 |
| - "documentation":"<p>The status of the creation or deletion of the data catalog.</p> <ul> <li> <p>The <code>LAMBDA</code>, <code>GLUE</code>, and <code>HIVE</code> data catalog types are created synchronously. Their status is either <code>CREATE_COMPLETE</code> or <code>CREATE_FAILED</code>.</p> </li> <li> <p>The <code>FEDERATED</code> data catalog type is created asynchronously.</p> </li> </ul> <p>Data catalog creation status:</p> <ul> <li> <p> <code>CREATE_IN_PROGRESS</code>: Federated data catalog creation in progress.</p> </li> <li> <p> <code>CREATE_COMPLETE</code>: Data catalog creation complete.</p> </li> <li> <p> <code>CREATE_FAILED</code>: Data catalog could not be created.</p> </li> <li> <p> <code>CREATE_FAILED_CLEANUP_IN_PROGRESS</code>: Federated data catalog creation failed and is being removed.</p> </li> <li> <p> <code>CREATE_FAILED_CLEANUP_COMPLETE</code>: Federated data catalog creation failed and was removed.</p> </li> <li> <p> <code>CREATE_FAILED_CLEANUP_FAILED</code>: Federated data catalog creation failed but could not be removed.</p> </li> </ul> <p>Data catalog deletion status:</p> <ul> <li> <p> <code>DELETE_IN_PROGRESS</code>: Federated data catalog deletion in progress.</p> </li> <li> <p> <code>DELETE_COMPLETE</code>: Federated data catalog deleted.</p> </li> <li> <p> <code>DELETE_FAILED</code>: Federated data catalog could not be deleted.</p> </li> </ul>" |
1884 |
| - }, |
1885 |
| - "ConnectionType":{ |
1886 |
| - "shape":"ConnectionType", |
1887 |
| - "documentation":"<p>The type of connection for a <code>FEDERATED</code> data catalog (for example, <code>REDSHIFT</code>, <code>MYSQL</code>, or <code>SQLSERVER</code>). For information about individual connectors, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/connectors-available.html\">Available data source connectors</a>.</p>" |
1888 |
| - }, |
1889 |
| - "Error":{ |
1890 |
| - "shape":"ErrorMessage", |
1891 |
| - "documentation":"<p>Text of the error that occurred during data catalog creation or deletion.</p>" |
1892 | 1818 | }
|
1893 | 1819 | },
|
1894 | 1820 | "documentation":"<p>The summary information for the data catalog, which includes its name and type.</p>"
|
|
1902 | 1828 | "enum":[
|
1903 | 1829 | "LAMBDA",
|
1904 | 1830 | "GLUE",
|
1905 |
| - "HIVE", |
1906 |
| - "FEDERATED" |
| 1831 | + "HIVE" |
1907 | 1832 | ]
|
1908 | 1833 | },
|
1909 | 1834 | "Database":{
|
|
1979 | 1904 | "DeleteDataCatalogOutput":{
|
1980 | 1905 | "type":"structure",
|
1981 | 1906 | "members":{
|
1982 |
| - "DataCatalog":{"shape":"DataCatalog"} |
1983 | 1907 | }
|
1984 | 1908 | },
|
1985 | 1909 | "DeleteNamedQueryInput":{
|
|
2539 | 2463 | "members":{
|
2540 | 2464 | "UpdateCount":{
|
2541 | 2465 | "shape":"Long",
|
2542 |
| - "documentation":"<p>The number of rows inserted with a <code>CREATE TABLE AS SELECT</code> statement. </p>" |
| 2466 | + "documentation":"<p>The number of rows inserted with a <code>CREATE TABLE AS SELECT</code>, <code>INSERT INTO</code>, or <code>UPDATE</code> statement. </p>" |
2543 | 2467 | },
|
2544 | 2468 | "ResultSet":{
|
2545 | 2469 | "shape":"ResultSet",
|
|
0 commit comments