Skip to content

Commit 4dd7961

Browse files
author
awstools
committed
docs(client-athena): Minor API documentation updates
1 parent 4017e73 commit 4dd7961

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

clients/client-athena/src/commands/CreateDataCatalogCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ export interface CreateDataCatalogCommandOutput extends CreateDataCatalogOutput,
3030
/**
3131
* <p>Creates (registers) a data catalog with the specified name and properties. Catalogs
3232
* created are visible to all users of the same Amazon Web Services account.</p>
33-
* <p>This API operation creates the following resources.</p>
33+
* <p>For a <code>FEDERATED</code> catalog, this API operation creates the following
34+
* resources.</p>
3435
* <ul>
3536
* <li>
3637
* <p>CFN Stack Name with a maximum length of 128 characters and prefix

clients/client-athena/src/models/models_0.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -768,8 +768,8 @@ export interface QueryExecution {
768768
* <p>The type of query statement that was run. <code>DDL</code> indicates DDL query
769769
* statements. <code>DML</code> indicates DML (Data Manipulation Language) query
770770
* statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates
771-
* query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>, or
772-
* <code>DESCRIBE TABLE</code>.</p>
771+
* query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>,
772+
* <code>EXPLAIN</code>, <code>DESCRIBE</code>, or <code>SHOW TABLES</code>.</p>
773773
* @public
774774
*/
775775
StatementType?: StatementType | undefined;
@@ -1014,6 +1014,7 @@ export interface CreateDataCatalogInput {
10141014
* external Apache Hive metastore. <code>FEDERATED</code> is a federated catalog for which
10151015
* Athena creates the connection and the Lambda function for
10161016
* you based on the parameters that you pass.</p>
1017+
* <p>For <code>FEDERATED</code> type, we do not support IAM identity center.</p>
10171018
* @public
10181019
*/
10191020
Type: DataCatalogType | undefined;

codegen/sdk-codegen/aws-models/athena.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2379,7 +2379,7 @@
23792379
}
23802380
],
23812381
"traits": {
2382-
"smithy.api#documentation": "<p>Creates (registers) a data catalog with the specified name and properties. Catalogs\n created are visible to all users of the same Amazon Web Services account.</p>\n <p>This API operation creates the following resources.</p>\n <ul>\n <li>\n <p>CFN Stack Name with a maximum length of 128 characters and prefix\n <code>athenafederatedcatalog-CATALOG_NAME_SANITIZED</code> with length 23\n characters.</p>\n </li>\n <li>\n <p>Lambda Function Name with a maximum length of 64 characters and prefix\n <code>athenafederatedcatalog_CATALOG_NAME_SANITIZED</code> with length 23\n characters.</p>\n </li>\n <li>\n <p>Glue Connection Name with a maximum length of 255 characters and a prefix\n <code>athenafederatedcatalog_CATALOG_NAME_SANITIZED</code> with length 23\n characters. </p>\n </li>\n </ul>"
2382+
"smithy.api#documentation": "<p>Creates (registers) a data catalog with the specified name and properties. Catalogs\n created are visible to all users of the same Amazon Web Services account.</p>\n <p>For a <code>FEDERATED</code> catalog, this API operation creates the following\n resources.</p>\n <ul>\n <li>\n <p>CFN Stack Name with a maximum length of 128 characters and prefix\n <code>athenafederatedcatalog-CATALOG_NAME_SANITIZED</code> with length 23\n characters.</p>\n </li>\n <li>\n <p>Lambda Function Name with a maximum length of 64 characters and prefix\n <code>athenafederatedcatalog_CATALOG_NAME_SANITIZED</code> with length 23\n characters.</p>\n </li>\n <li>\n <p>Glue Connection Name with a maximum length of 255 characters and a prefix\n <code>athenafederatedcatalog_CATALOG_NAME_SANITIZED</code> with length 23\n characters. </p>\n </li>\n </ul>"
23832383
}
23842384
},
23852385
"com.amazonaws.athena#CreateDataCatalogInput": {
@@ -2395,7 +2395,7 @@
23952395
"Type": {
23962396
"target": "com.amazonaws.athena#DataCatalogType",
23972397
"traits": {
2398-
"smithy.api#documentation": "<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,\n <code>GLUE</code> for an Glue Data Catalog, and <code>HIVE</code> for an\n external Apache Hive metastore. <code>FEDERATED</code> is a federated catalog for which\n Athena creates the connection and the Lambda function for\n you based on the parameters that you pass.</p>",
2398+
"smithy.api#documentation": "<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,\n <code>GLUE</code> for an Glue Data Catalog, and <code>HIVE</code> for an\n external Apache Hive metastore. <code>FEDERATED</code> is a federated catalog for which\n Athena creates the connection and the Lambda function for\n you based on the parameters that you pass.</p>\n <p>For <code>FEDERATED</code> type, we do not support IAM identity center.</p>",
23992399
"smithy.api#required": {}
24002400
}
24012401
},
@@ -6690,7 +6690,7 @@
66906690
"StatementType": {
66916691
"target": "com.amazonaws.athena#StatementType",
66926692
"traits": {
6693-
"smithy.api#documentation": "<p>The type of query statement that was run. <code>DDL</code> indicates DDL query\n statements. <code>DML</code> indicates DML (Data Manipulation Language) query\n statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates\n query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>, or\n <code>DESCRIBE TABLE</code>.</p>"
6693+
"smithy.api#documentation": "<p>The type of query statement that was run. <code>DDL</code> indicates DDL query\n statements. <code>DML</code> indicates DML (Data Manipulation Language) query\n statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates\n query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>,\n <code>EXPLAIN</code>, <code>DESCRIBE</code>, or <code>SHOW TABLES</code>.</p>"
66946694
}
66956695
},
66966696
"ResultConfiguration": {
@@ -7698,7 +7698,7 @@
76987698
"target": "com.amazonaws.athena#CalculationConfiguration",
76997699
"traits": {
77007700
"smithy.api#deprecated": {
7701-
"message": "Kepler Post GA Tasks : https://sim.amazon.com/issues/ATHENA-39828"
7701+
"message": "Structure is deprecated."
77027702
},
77037703
"smithy.api#documentation": "<p>Contains configuration information for the calculation.</p>"
77047704
}

0 commit comments

Comments
 (0)