From ca03f0c2cdca4a62332cb0099e7c7c422aafb301 Mon Sep 17 00:00:00 2001
From: awstools 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 The Amazon S3 canned ACL that Athena should specify when storing
- * query results. Currently the only supported canned ACL is
+ * 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
* The type of data catalog to create: x-amz-acl
request header. For more
- * information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User
+ * 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 x-amz-acl
request
+ * header. For more information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User
* Guide.BUCKET_OWNER_FULL_CONTROL
. 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.
@@ -966,7 +968,6 @@ export interface CreateCapacityReservationOutput {}
* @enum
*/
export const DataCatalogType = {
- FEDERATED: "FEDERATED",
GLUE: "GLUE",
HIVE: "HIVE",
LAMBDA: "LAMBDA",
@@ -992,10 +993,8 @@ export interface CreateDataCatalogInput {
/**
* LAMBDA
for a federated catalog,
- * GLUE
for an Glue Data Catalog, and HIVE
for an
- * external Apache Hive metastore. FEDERATED
is a federated catalog for which
- * Athena creates the connection and the Lambda function for
- * you based on the parameters that you pass.HIVE
for an external hive metastore, or GLUE
for an
+ * Glue Data Catalog.
The FEDERATED
data catalog type uses one of the following
- * parameters, but not both. Use connection-arn
for an existing
- * Glue connection. Use connection-type
and
- * connection-properties
to specify the configuration setting for
- * a new connection.
- * connection-arn:
- *
- * lambda-role-arn
(optional): The execution role to use for the
- * Lambda function. If not provided, one is created.
- * connection-type:MYSQL|REDSHIFT|....,
- * connection-properties:"
- *
For
- *
- * , use escaped
- * JSON text, as in the following example.
- * "\{\"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\"\}"
- *
Contains information about a data catalog in an Amazon Web Services account.
- *In the Athena console, data catalogs are listed as "data sources" on - * the Data sources page under the Data source name column.
- *The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, - * or hyphen characters. The remainder of the length constraint of 256 is reserved for use - * by Athena.
- * @public - */ - Name: string | undefined; - - /** - *An optional description of the data catalog.
- * @public - */ - Description?: string; - - /** - *The type of data catalog to create: LAMBDA
for a federated catalog,
- * GLUE
for an Glue Data Catalog, and HIVE
for an
- * external Apache Hive metastore. FEDERATED
is a federated catalog for which
- * Athena creates the connection and the Lambda function for
- * you based on the parameters that you pass.
Specifies the Lambda function or functions to use for the data catalog. - * This is a mapping whose values depend on the catalog type.
- *For the HIVE
data catalog type, use the following syntax. The
- * metadata-function
parameter is required. The
- * sdk-version
parameter is optional and defaults to the currently
- * supported version.
- * metadata-function=lambda_arn,
- * sdk-version=version_number
- *
- *
For the LAMBDA
data catalog type, use one of the following sets
- * of required parameters, but not both.
If you have one Lambda function that processes metadata - * and another for reading the actual data, use the following syntax. Both - * parameters are required.
- *
- * metadata-function=lambda_arn,
- * record-function=lambda_arn
- *
- *
If you have a composite Lambda function that processes - * both metadata and data, use the following syntax to specify your Lambda function.
- *
- * function=lambda_arn
- *
- *
The GLUE
type takes a catalog ID parameter and is required. The
- *
- * catalog_id
- *
is the account ID of the
- * Amazon Web Services account to which the Glue catalog
- * belongs.
- * catalog-id=catalog_id
- *
- *
The GLUE
data catalog type also applies to the default
- * AwsDataCatalog
that already exists in your account, of
- * which you can have only one and cannot modify.
The FEDERATED
data catalog type uses one of the following
- * parameters, but not both. Use connection-arn
for an existing
- * Glue connection. Use connection-type
and
- * connection-properties
to specify the configuration setting for
- * a new connection.
- * connection-arn:
- *
- * connection-type:MYSQL|REDSHIFT|....,
- * connection-properties:"
- *
For
- *
- * , use escaped
- * JSON text, as in the following example.
- * "\{\"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\"\}"
- *
The status of the creation or deletion of the data catalog.
- *The LAMBDA
, GLUE
, and HIVE
data catalog
- * types are created synchronously. Their status is either
- * CREATE_COMPLETE
or CREATE_FAILED
.
The FEDERATED
data catalog type is created asynchronously.
Data catalog creation status:
- *
- * CREATE_IN_PROGRESS
: Federated data catalog creation in
- * progress.
- * CREATE_COMPLETE
: Data catalog creation complete.
- * CREATE_FAILED
: Data catalog could not be created.
- * CREATE_FAILED_CLEANUP_IN_PROGRESS
: Federated data catalog
- * creation failed and is being removed.
- * CREATE_FAILED_CLEANUP_COMPLETE
: Federated data catalog creation
- * failed and was removed.
- * CREATE_FAILED_CLEANUP_FAILED
: Federated data catalog creation
- * failed but could not be removed.
Data catalog deletion status:
- *
- * DELETE_IN_PROGRESS
: Federated data catalog deletion in
- * progress.
- * DELETE_COMPLETE
: Federated data catalog deleted.
- * DELETE_FAILED
: Federated data catalog could not be
- * deleted.
The type of connection for a FEDERATED
data catalog (for example,
- * REDSHIFT
, MYSQL
, or SQLSERVER
). For
- * information about individual connectors, see Available data source
- * connectors.
Text of the error that occurred during data catalog creation or deletion.
- * @public - */ - Error?: string; -} - -/** - * @public - */ -export interface CreateDataCatalogOutput { - /** - *Contains information about a data catalog in an Amazon Web Services account.
- *In the Athena console, data catalogs are listed as "data sources" on - * the Data sources page under the Data source name column.
- *Contains information about a data catalog in an Amazon Web Services account.
- *In the Athena console, data catalogs are listed as "data sources" on - * the Data sources page under the Data source name column.
- *Contains information about a data catalog in an Amazon Web Services account.
+ *In the Athena console, data catalogs are listed as "data sources" on + * the Data sources page under the Data source name column.
+ *The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, + * or hyphen characters. The remainder of the length constraint of 256 is reserved for use + * by Athena.
+ * @public + */ + Name: string | undefined; + + /** + *An optional description of the data catalog.
+ * @public + */ + Description?: string; + + /** + *The type of data catalog to create: LAMBDA
for a federated catalog,
+ * HIVE
for an external hive metastore, or GLUE
for an
+ * Glue Data Catalog.
Specifies the Lambda function or functions to use for the data catalog. + * This is a mapping whose values depend on the catalog type.
+ *For the HIVE
data catalog type, use the following syntax. The
+ * metadata-function
parameter is required. The
+ * sdk-version
parameter is optional and defaults to the currently
+ * supported version.
+ * metadata-function=lambda_arn,
+ * sdk-version=version_number
+ *
+ *
For the LAMBDA
data catalog type, use one of the following sets
+ * of required parameters, but not both.
If you have one Lambda function that processes metadata + * and another for reading the actual data, use the following syntax. Both + * parameters are required.
+ *
+ * metadata-function=lambda_arn,
+ * record-function=lambda_arn
+ *
+ *
If you have a composite Lambda function that processes + * both metadata and data, use the following syntax to specify your Lambda function.
+ *
+ * function=lambda_arn
+ *
+ *
The GLUE
type takes a catalog ID parameter and is required. The
+ *
+ * catalog_id
+ *
is the account ID of the
+ * Amazon Web Services account to which the Glue catalog
+ * belongs.
+ * catalog-id=catalog_id
+ *
+ *
The GLUE
data catalog type also applies to the default
+ * AwsDataCatalog
that already exists in your account, of
+ * which you can have only one and cannot modify.
The number of rows inserted with a CREATE TABLE AS SELECT
statement.
- *
The number of rows inserted with a CREATE TABLE AS SELECT
, INSERT
+ * INTO
, or UPDATE
statement.
The status of the creation or deletion of the data catalog.
- *The LAMBDA
, GLUE
, and HIVE
data catalog
- * types are created synchronously. Their status is either
- * CREATE_COMPLETE
or CREATE_FAILED
.
The FEDERATED
data catalog type is created asynchronously.
Data catalog creation status:
- *
- * CREATE_IN_PROGRESS
: Federated data catalog creation in
- * progress.
- * CREATE_COMPLETE
: Data catalog creation complete.
- * CREATE_FAILED
: Data catalog could not be created.
- * CREATE_FAILED_CLEANUP_IN_PROGRESS
: Federated data catalog
- * creation failed and is being removed.
- * CREATE_FAILED_CLEANUP_COMPLETE
: Federated data catalog creation
- * failed and was removed.
- * CREATE_FAILED_CLEANUP_FAILED
: Federated data catalog creation
- * failed but could not be removed.
Data catalog deletion status:
- *
- * DELETE_IN_PROGRESS
: Federated data catalog deletion in
- * progress.
- * DELETE_COMPLETE
: Federated data catalog deleted.
- * DELETE_FAILED
: Federated data catalog could not be
- * deleted.
The type of connection for a FEDERATED
data catalog (for example,
- * REDSHIFT
, MYSQL
, or SQLSERVER
). For
- * information about individual connectors, see Available data source
- * connectors.
Text of the error that occurred during data catalog creation or deletion.
- * @public - */ - Error?: string; } /** diff --git a/codegen/sdk-codegen/aws-models/athena.json b/codegen/sdk-codegen/aws-models/athena.json index dc44431e37d3..e6fef7b284fe 100644 --- a/codegen/sdk-codegen/aws-models/athena.json +++ b/codegen/sdk-codegen/aws-models/athena.json @@ -35,13 +35,13 @@ "S3AclOption": { "target": "com.amazonaws.athena#S3AclOption", "traits": { - "smithy.api#documentation": "The Amazon S3 canned ACL that Athena should specify when storing\n query results. Currently the only supported canned ACL is\n BUCKET_OWNER_FULL_CONTROL
. 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 Canned ACL in the Amazon S3 User Guide.
The Amazon S3 canned ACL that Athena should specify when storing\n query results, including data files inserted by Athena as the result\n of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is\n BUCKET_OWNER_FULL_CONTROL
. 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 Canned ACL in the Amazon S3 User Guide.
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 x-amz-acl
request header. For more\n information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User\n Guide.
Indicates that an Amazon S3 canned ACL should be set to control ownership of\n stored query results, including data files inserted by Athena as the result\n of statements like CTAS or INSERT INTO. When Athena stores query results in\n Amazon S3, the canned ACL is set with the x-amz-acl
request\n header. For more information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User\n Guide.
The type of data catalog to create: LAMBDA
for a federated catalog,\n GLUE
for an Glue Data Catalog, and HIVE
for an\n external Apache Hive metastore. FEDERATED
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.
The type of data catalog to create: LAMBDA
for a federated catalog,\n HIVE
for an external hive metastore, or GLUE
for an\n Glue Data Catalog.
Specifies the Lambda function or functions to use for creating the data\n catalog. This is a mapping whose values depend on the catalog type.
\nFor the HIVE
data catalog type, use the following syntax. The\n metadata-function
parameter is required. The\n sdk-version
parameter is optional and defaults to the currently\n supported version.
\n metadata-function=lambda_arn,\n sdk-version=version_number\n
\n
For the LAMBDA
data catalog type, use one of the following sets\n of required parameters, but not both.
If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.
\n\n metadata-function=lambda_arn,\n record-function=lambda_arn\n
\n
If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.
\n\n function=lambda_arn\n
\n
The GLUE
type takes a catalog ID parameter and is required. The\n \n catalog_id\n
is the account ID of the\n Amazon Web Services account to which the Glue Data Catalog\n belongs.
\n catalog-id=catalog_id\n
\n
The GLUE
data catalog type also applies to the default\n AwsDataCatalog
that already exists in your account, of\n which you can have only one and cannot modify.
The FEDERATED
data catalog type uses one of the following\n parameters, but not both. Use connection-arn
for an existing\n Glue connection. Use connection-type
and\n connection-properties
to specify the configuration setting for\n a new connection.
\n connection-arn:
\n
\n lambda-role-arn
(optional): The execution role to use for the\n Lambda function. If not provided, one is created.
\n connection-type:MYSQL|REDSHIFT|....,\n connection-properties:\"
\n
For \n
\n , use escaped\n JSON text, as in the following example.
\n \"{\\\"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\\\"}\"
\n
Specifies the Lambda function or functions to use for creating the data\n catalog. This is a mapping whose values depend on the catalog type.
\nFor the HIVE
data catalog type, use the following syntax. The\n metadata-function
parameter is required. The\n sdk-version
parameter is optional and defaults to the currently\n supported version.
\n metadata-function=lambda_arn,\n sdk-version=version_number\n
\n
For the LAMBDA
data catalog type, use one of the following sets\n of required parameters, but not both.
If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.
\n\n metadata-function=lambda_arn,\n record-function=lambda_arn\n
\n
If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.
\n\n function=lambda_arn\n
\n
The GLUE
type takes a catalog ID parameter and is required. The\n \n catalog_id\n
is the account ID of the\n Amazon Web Services account to which the Glue Data Catalog\n belongs.
\n catalog-id=catalog_id\n
\n
The GLUE
data catalog type also applies to the default\n AwsDataCatalog
that already exists in your account, of\n which you can have only one and cannot modify.
The type of data catalog to create: LAMBDA
for a federated catalog,\n GLUE
for an Glue Data Catalog, and HIVE
for an\n external Apache Hive metastore. FEDERATED
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.
The type of data catalog to create: LAMBDA
for a federated catalog,\n HIVE
for an external hive metastore, or GLUE
for an\n Glue Data Catalog.
Specifies the Lambda function or functions to use for the data catalog.\n This is a mapping whose values depend on the catalog type.
\nFor the HIVE
data catalog type, use the following syntax. The\n metadata-function
parameter is required. The\n sdk-version
parameter is optional and defaults to the currently\n supported version.
\n metadata-function=lambda_arn,\n sdk-version=version_number\n
\n
For the LAMBDA
data catalog type, use one of the following sets\n of required parameters, but not both.
If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.
\n\n metadata-function=lambda_arn,\n record-function=lambda_arn\n
\n
If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.
\n\n function=lambda_arn\n
\n
The GLUE
type takes a catalog ID parameter and is required. The\n \n catalog_id\n
is the account ID of the\n Amazon Web Services account to which the Glue catalog\n belongs.
\n catalog-id=catalog_id\n
\n
The GLUE
data catalog type also applies to the default\n AwsDataCatalog
that already exists in your account, of\n which you can have only one and cannot modify.
The FEDERATED
data catalog type uses one of the following\n parameters, but not both. Use connection-arn
for an existing\n Glue connection. Use connection-type
and\n connection-properties
to specify the configuration setting for\n a new connection.
\n connection-arn:
\n
\n connection-type:MYSQL|REDSHIFT|....,\n connection-properties:\"
\n
For \n
\n , use escaped\n JSON text, as in the following example.
\n \"{\\\"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\\\"}\"
\n
The status of the creation or deletion of the data catalog.
\nThe LAMBDA
, GLUE
, and HIVE
data catalog\n types are created synchronously. Their status is either\n CREATE_COMPLETE
or CREATE_FAILED
.
The FEDERATED
data catalog type is created asynchronously.
Data catalog creation status:
\n\n CREATE_IN_PROGRESS
: Federated data catalog creation in\n progress.
\n CREATE_COMPLETE
: Data catalog creation complete.
\n CREATE_FAILED
: Data catalog could not be created.
\n CREATE_FAILED_CLEANUP_IN_PROGRESS
: Federated data catalog\n creation failed and is being removed.
\n CREATE_FAILED_CLEANUP_COMPLETE
: Federated data catalog creation\n failed and was removed.
\n CREATE_FAILED_CLEANUP_FAILED
: Federated data catalog creation\n failed but could not be removed.
Data catalog deletion status:
\n\n DELETE_IN_PROGRESS
: Federated data catalog deletion in\n progress.
\n DELETE_COMPLETE
: Federated data catalog deleted.
\n DELETE_FAILED
: Federated data catalog could not be\n deleted.
The type of connection for a FEDERATED
data catalog (for example,\n REDSHIFT
, MYSQL
, or SQLSERVER
). For\n information about individual connectors, see Available data source\n connectors.
Text of the error that occurred during data catalog creation or deletion.
" + "smithy.api#documentation": "Specifies the Lambda function or functions to use for the data catalog.\n This is a mapping whose values depend on the catalog type.
\nFor the HIVE
data catalog type, use the following syntax. The\n metadata-function
parameter is required. The\n sdk-version
parameter is optional and defaults to the currently\n supported version.
\n metadata-function=lambda_arn,\n sdk-version=version_number\n
\n
For the LAMBDA
data catalog type, use one of the following sets\n of required parameters, but not both.
If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.
\n\n metadata-function=lambda_arn,\n record-function=lambda_arn\n
\n
If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.
\n\n function=lambda_arn\n
\n
The GLUE
type takes a catalog ID parameter and is required. The\n \n catalog_id\n
is the account ID of the\n Amazon Web Services account to which the Glue catalog\n belongs.
\n catalog-id=catalog_id\n
\n
The GLUE
data catalog type also applies to the default\n AwsDataCatalog
that already exists in your account, of\n which you can have only one and cannot modify.
Contains information about a data catalog in an Amazon Web Services account.
\nIn the Athena console, data catalogs are listed as \"data sources\" on\n the Data sources page under the Data source name column.
\nThe data catalog type.
" } - }, - "Status": { - "target": "com.amazonaws.athena#DataCatalogStatus", - "traits": { - "smithy.api#documentation": "The status of the creation or deletion of the data catalog.
\nThe LAMBDA
, GLUE
, and HIVE
data catalog\n types are created synchronously. Their status is either\n CREATE_COMPLETE
or CREATE_FAILED
.
The FEDERATED
data catalog type is created asynchronously.
Data catalog creation status:
\n\n CREATE_IN_PROGRESS
: Federated data catalog creation in\n progress.
\n CREATE_COMPLETE
: Data catalog creation complete.
\n CREATE_FAILED
: Data catalog could not be created.
\n CREATE_FAILED_CLEANUP_IN_PROGRESS
: Federated data catalog\n creation failed and is being removed.
\n CREATE_FAILED_CLEANUP_COMPLETE
: Federated data catalog creation\n failed and was removed.
\n CREATE_FAILED_CLEANUP_FAILED
: Federated data catalog creation\n failed but could not be removed.
Data catalog deletion status:
\n\n DELETE_IN_PROGRESS
: Federated data catalog deletion in\n progress.
\n DELETE_COMPLETE
: Federated data catalog deleted.
\n DELETE_FAILED
: Federated data catalog could not be\n deleted.
The type of connection for a FEDERATED
data catalog (for example,\n REDSHIFT
, MYSQL
, or SQLSERVER
). For\n information about individual connectors, see Available data source\n connectors.
Text of the error that occurred during data catalog creation or deletion.
" - } } }, "traits": { @@ -3020,12 +2736,6 @@ "traits": { "smithy.api#enumValue": "HIVE" } - }, - "FEDERATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FEDERATED" - } } } }, @@ -3177,11 +2887,7 @@ }, "com.amazonaws.athena#DeleteDataCatalogOutput": { "type": "structure", - "members": { - "DataCatalog": { - "target": "com.amazonaws.athena#DataCatalog" - } - }, + "members": {}, "traits": { "smithy.api#output": {} } @@ -4445,7 +4151,7 @@ "UpdateCount": { "target": "com.amazonaws.athena#Long", "traits": { - "smithy.api#documentation": "The number of rows inserted with a CREATE TABLE AS SELECT
statement.\n
The number of rows inserted with a CREATE TABLE AS SELECT
, INSERT\n INTO
, or UPDATE
statement.