Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.
Synopsis
- data CreateDataCatalog = CreateDataCatalog' {
- description :: Maybe Text
- parameters :: Maybe (HashMap Text Text)
- tags :: Maybe [Tag]
- name :: Text
- type' :: DataCatalogType
- newCreateDataCatalog :: Text -> DataCatalogType -> CreateDataCatalog
- createDataCatalog_description :: Lens' CreateDataCatalog (Maybe Text)
- createDataCatalog_parameters :: Lens' CreateDataCatalog (Maybe (HashMap Text Text))
- createDataCatalog_tags :: Lens' CreateDataCatalog (Maybe [Tag])
- createDataCatalog_name :: Lens' CreateDataCatalog Text
- createDataCatalog_type :: Lens' CreateDataCatalog DataCatalogType
- data CreateDataCatalogResponse = CreateDataCatalogResponse' {
- httpStatus :: Int
- newCreateDataCatalogResponse :: Int -> CreateDataCatalogResponse
- createDataCatalogResponse_httpStatus :: Lens' CreateDataCatalogResponse Int
Creating a Request
data CreateDataCatalog Source #
See: newCreateDataCatalog
smart constructor.
CreateDataCatalog' | |
|
Instances
Create a value of CreateDataCatalog
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDataCatalog
, createDataCatalog_description
- A description of the data catalog to be created.
CreateDataCatalog
, createDataCatalog_parameters
- Specifies the Lambda function or functions to use for creating the data
catalog. This is a mapping whose values depend on the catalog type.
For the
HIVE
data catalog type, use the following syntax. Themetadata-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. Thecatalog_id
catalog-id=
catalog_id
- The
GLUE
data catalog type also applies to the defaultAwsDataCatalog
that already exists in your account, of which you can have only one and cannot modify. - Queries that specify a Glue Data Catalog other than the default
AwsDataCatalog
must be run on Athena engine version 2. - In Regions where Athena engine version 2 is not available,
creating new Glue data catalogs results in an
INVALID_INPUT
error.
- The
$sel:tags:CreateDataCatalog'
, createDataCatalog_tags
- A list of comma separated tags to add to the data catalog that is
created.
CreateDataCatalog
, createDataCatalog_name
- The name of the data catalog to create. 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.
CreateDataCatalog
, createDataCatalog_type
- 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.
Request Lenses
createDataCatalog_description :: Lens' CreateDataCatalog (Maybe Text) Source #
A description of the data catalog to be created.
createDataCatalog_parameters :: Lens' CreateDataCatalog (Maybe (HashMap Text Text)) Source #
Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
For the
HIVE
data catalog type, use the following syntax. Themetadata-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. Thecatalog_id
catalog-id=
catalog_id
- The
GLUE
data catalog type also applies to the defaultAwsDataCatalog
that already exists in your account, of which you can have only one and cannot modify. - Queries that specify a Glue Data Catalog other than the default
AwsDataCatalog
must be run on Athena engine version 2. - In Regions where Athena engine version 2 is not available,
creating new Glue data catalogs results in an
INVALID_INPUT
error.
- The
createDataCatalog_tags :: Lens' CreateDataCatalog (Maybe [Tag]) Source #
A list of comma separated tags to add to the data catalog that is created.
createDataCatalog_name :: Lens' CreateDataCatalog Text Source #
The name of the data catalog to create. 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.
createDataCatalog_type :: Lens' CreateDataCatalog DataCatalogType Source #
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.
Destructuring the Response
data CreateDataCatalogResponse Source #
See: newCreateDataCatalogResponse
smart constructor.
CreateDataCatalogResponse' | |
|
Instances
newCreateDataCatalogResponse Source #
Create a value of CreateDataCatalogResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateDataCatalogResponse'
, createDataCatalogResponse_httpStatus
- The response's http status code.
Response Lenses
createDataCatalogResponse_httpStatus :: Lens' CreateDataCatalogResponse Int Source #
The response's http status code.