amazonka-athena-2.0: gen/Amazonka/Athena/CreateDataCatalog.hs
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Amazonka.Athena.CreateDataCatalog
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- 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.
module Amazonka.Athena.CreateDataCatalog
( -- * Creating a Request
CreateDataCatalog (..),
newCreateDataCatalog,
-- * Request Lenses
createDataCatalog_description,
createDataCatalog_parameters,
createDataCatalog_tags,
createDataCatalog_name,
createDataCatalog_type,
-- * Destructuring the Response
CreateDataCatalogResponse (..),
newCreateDataCatalogResponse,
-- * Response Lenses
createDataCatalogResponse_httpStatus,
)
where
import Amazonka.Athena.Types
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
-- | /See:/ 'newCreateDataCatalog' smart constructor.
data CreateDataCatalog = CreateDataCatalog'
{ -- | A description of the data catalog to be created.
description :: Prelude.Maybe Prelude.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.
parameters :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
-- | A list of comma separated tags to add to the data catalog that is
-- created.
tags :: Prelude.Maybe [Tag],
-- | 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.
name :: Prelude.Text,
-- | 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.
type' :: DataCatalogType
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'CreateDataCatalog' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'description', 'createDataCatalog_description' - A description of the data catalog to be created.
--
-- 'parameters', '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.
--
-- 'tags', 'createDataCatalog_tags' - A list of comma separated tags to add to the data catalog that is
-- created.
--
-- 'name', '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.
--
-- 'type'', '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.
newCreateDataCatalog ::
-- | 'name'
Prelude.Text ->
-- | 'type''
DataCatalogType ->
CreateDataCatalog
newCreateDataCatalog pName_ pType_ =
CreateDataCatalog'
{ description = Prelude.Nothing,
parameters = Prelude.Nothing,
tags = Prelude.Nothing,
name = pName_,
type' = pType_
}
-- | A description of the data catalog to be created.
createDataCatalog_description :: Lens.Lens' CreateDataCatalog (Prelude.Maybe Prelude.Text)
createDataCatalog_description = Lens.lens (\CreateDataCatalog' {description} -> description) (\s@CreateDataCatalog' {} a -> s {description = a} :: CreateDataCatalog)
-- | 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_parameters :: Lens.Lens' CreateDataCatalog (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
createDataCatalog_parameters = Lens.lens (\CreateDataCatalog' {parameters} -> parameters) (\s@CreateDataCatalog' {} a -> s {parameters = a} :: CreateDataCatalog) Prelude.. Lens.mapping Lens.coerced
-- | A list of comma separated tags to add to the data catalog that is
-- created.
createDataCatalog_tags :: Lens.Lens' CreateDataCatalog (Prelude.Maybe [Tag])
createDataCatalog_tags = Lens.lens (\CreateDataCatalog' {tags} -> tags) (\s@CreateDataCatalog' {} a -> s {tags = a} :: CreateDataCatalog) Prelude.. Lens.mapping Lens.coerced
-- | 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_name :: Lens.Lens' CreateDataCatalog Prelude.Text
createDataCatalog_name = Lens.lens (\CreateDataCatalog' {name} -> name) (\s@CreateDataCatalog' {} a -> s {name = a} :: CreateDataCatalog)
-- | 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.
createDataCatalog_type :: Lens.Lens' CreateDataCatalog DataCatalogType
createDataCatalog_type = Lens.lens (\CreateDataCatalog' {type'} -> type') (\s@CreateDataCatalog' {} a -> s {type' = a} :: CreateDataCatalog)
instance Core.AWSRequest CreateDataCatalog where
type
AWSResponse CreateDataCatalog =
CreateDataCatalogResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveEmpty
( \s h x ->
CreateDataCatalogResponse'
Prelude.<$> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable CreateDataCatalog where
hashWithSalt _salt CreateDataCatalog' {..} =
_salt
`Prelude.hashWithSalt` description
`Prelude.hashWithSalt` parameters
`Prelude.hashWithSalt` tags
`Prelude.hashWithSalt` name
`Prelude.hashWithSalt` type'
instance Prelude.NFData CreateDataCatalog where
rnf CreateDataCatalog' {..} =
Prelude.rnf description
`Prelude.seq` Prelude.rnf parameters
`Prelude.seq` Prelude.rnf tags
`Prelude.seq` Prelude.rnf name
`Prelude.seq` Prelude.rnf type'
instance Data.ToHeaders CreateDataCatalog where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "X-Amz-Target"
Data.=# ( "AmazonAthena.CreateDataCatalog" ::
Prelude.ByteString
),
"Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON CreateDataCatalog where
toJSON CreateDataCatalog' {..} =
Data.object
( Prelude.catMaybes
[ ("Description" Data..=) Prelude.<$> description,
("Parameters" Data..=) Prelude.<$> parameters,
("Tags" Data..=) Prelude.<$> tags,
Prelude.Just ("Name" Data..= name),
Prelude.Just ("Type" Data..= type')
]
)
instance Data.ToPath CreateDataCatalog where
toPath = Prelude.const "/"
instance Data.ToQuery CreateDataCatalog where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newCreateDataCatalogResponse' smart constructor.
data CreateDataCatalogResponse = CreateDataCatalogResponse'
{ -- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'CreateDataCatalogResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'httpStatus', 'createDataCatalogResponse_httpStatus' - The response's http status code.
newCreateDataCatalogResponse ::
-- | 'httpStatus'
Prelude.Int ->
CreateDataCatalogResponse
newCreateDataCatalogResponse pHttpStatus_ =
CreateDataCatalogResponse'
{ httpStatus =
pHttpStatus_
}
-- | The response's http status code.
createDataCatalogResponse_httpStatus :: Lens.Lens' CreateDataCatalogResponse Prelude.Int
createDataCatalogResponse_httpStatus = Lens.lens (\CreateDataCatalogResponse' {httpStatus} -> httpStatus) (\s@CreateDataCatalogResponse' {} a -> s {httpStatus = a} :: CreateDataCatalogResponse)
instance Prelude.NFData CreateDataCatalogResponse where
rnf CreateDataCatalogResponse' {..} =
Prelude.rnf httpStatus