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

Amazonka.Athena.CreateDataCatalog

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Creating a Request

data CreateDataCatalog Source #

See: newCreateDataCatalog smart constructor.

Constructors

CreateDataCatalog'

Fields

description :: Maybe Text
A description of the data catalog to be created.
parameters :: Maybe (HashMap Text Text)
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. 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 Data 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.
  - 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.
tags :: Maybe [Tag]
A list of comma separated tags to add to the data catalog that is created.
name :: Text
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.
type' :: DataCatalogType
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.

Instances

Instances details

ToJSON CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods toJSON :: CreateDataCatalog -> Value # toEncoding :: CreateDataCatalog -> Encoding # toJSONList :: [CreateDataCatalog] -> Value # toEncodingList :: [CreateDataCatalog] -> Encoding #
ToHeaders CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods toHeaders :: CreateDataCatalog -> [Header] #
ToPath CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods toPath :: CreateDataCatalog -> ByteString #
ToQuery CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods toQuery :: CreateDataCatalog -> QueryString #
AWSRequest CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Associated Types type AWSResponse CreateDataCatalog # Methods request :: (Service -> Service) -> CreateDataCatalog -> Request CreateDataCatalog # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDataCatalog -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDataCatalog))) #
Generic CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Associated Types type Rep CreateDataCatalog :: Type -> Type # Methods from :: CreateDataCatalog -> Rep CreateDataCatalog x # to :: Rep CreateDataCatalog x -> CreateDataCatalog #
Read CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods readsPrec :: Int -> ReadS CreateDataCatalog # readList :: ReadS [CreateDataCatalog] # readPrec :: ReadPrec CreateDataCatalog # readListPrec :: ReadPrec [CreateDataCatalog] #
Show CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods showsPrec :: Int -> CreateDataCatalog -> ShowS # show :: CreateDataCatalog -> String # showList :: [CreateDataCatalog] -> ShowS #
NFData CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods rnf :: CreateDataCatalog -> () #
Eq CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods (==) :: CreateDataCatalog -> CreateDataCatalog -> Bool # (/=) :: CreateDataCatalog -> CreateDataCatalog -> Bool #
Hashable CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods hashWithSalt :: Int -> CreateDataCatalog -> Int # hash :: CreateDataCatalog -> Int #
type AWSResponse CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog type AWSResponse CreateDataCatalog = CreateDataCatalogResponse
type Rep CreateDataCatalog Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog type Rep CreateDataCatalog = D1 ('MetaData "CreateDataCatalog" "Amazonka.Athena.CreateDataCatalog" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "CreateDataCatalog'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataCatalogType)))))

newCreateDataCatalog Source #

Arguments

:: Text	`CreateDataCatalog`
-> DataCatalogType	`CreateDataCatalog`
-> CreateDataCatalog

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. 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 Data 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.
- 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.

$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. 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 Data 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.
- 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.

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.

Constructors

CreateDataCatalogResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDataCatalogResponse Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Associated Types type Rep CreateDataCatalogResponse :: Type -> Type # Methods from :: CreateDataCatalogResponse -> Rep CreateDataCatalogResponse x # to :: Rep CreateDataCatalogResponse x -> CreateDataCatalogResponse #
Read CreateDataCatalogResponse Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods readsPrec :: Int -> ReadS CreateDataCatalogResponse # readList :: ReadS [CreateDataCatalogResponse] # readPrec :: ReadPrec CreateDataCatalogResponse # readListPrec :: ReadPrec [CreateDataCatalogResponse] #
Show CreateDataCatalogResponse Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods showsPrec :: Int -> CreateDataCatalogResponse -> ShowS # show :: CreateDataCatalogResponse -> String # showList :: [CreateDataCatalogResponse] -> ShowS #
NFData CreateDataCatalogResponse Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods rnf :: CreateDataCatalogResponse -> () #
Eq CreateDataCatalogResponse Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog Methods (==) :: CreateDataCatalogResponse -> CreateDataCatalogResponse -> Bool # (/=) :: CreateDataCatalogResponse -> CreateDataCatalogResponse -> Bool #
type Rep CreateDataCatalogResponse Source #
Instance details Defined in Amazonka.Athena.CreateDataCatalog type Rep CreateDataCatalogResponse = D1 ('MetaData "CreateDataCatalogResponse" "Amazonka.Athena.CreateDataCatalog" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "CreateDataCatalogResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDataCatalogResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDataCatalogResponse'`
-> CreateDataCatalogResponse

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.