Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Athena.UpdateDataCatalog

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the data catalog that has the specified name.

Creating a Request

data UpdateDataCatalog Source #

See: newUpdateDataCatalog smart constructor.

Constructors

UpdateDataCatalog'

Fields

parameters :: Maybe (HashMap Text Text)
Specifies the Lambda function or functions to use for updating 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
```
description :: Maybe Text
New or modified text that describes the data catalog.
name :: Text
The name of the data catalog to update. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
type' :: DataCatalogType
Specifies the type of data catalog to update. Specify LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

Instances

Instances details

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

newUpdateDataCatalog Source #

Arguments

:: Text	`$sel:name:UpdateDataCatalog'`
-> DataCatalogType	`$sel:type':UpdateDataCatalog'`
-> UpdateDataCatalog

Create a value of UpdateDataCatalog 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:parameters:UpdateDataCatalog', updateDataCatalog_parameters - Specifies the Lambda function or functions to use for updating 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
```

$sel:description:UpdateDataCatalog', updateDataCatalog_description - New or modified text that describes the data catalog.

$sel:name:UpdateDataCatalog', updateDataCatalog_name - The name of the data catalog to update. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

$sel:type':UpdateDataCatalog', updateDataCatalog_type - Specifies the type of data catalog to update. Specify LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

Request Lenses

updateDataCatalog_parameters :: Lens' UpdateDataCatalog (Maybe (HashMap Text Text)) Source #

Specifies the Lambda function or functions to use for updating 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
```

updateDataCatalog_description :: Lens' UpdateDataCatalog (Maybe Text) Source #

New or modified text that describes the data catalog.

updateDataCatalog_name :: Lens' UpdateDataCatalog Text Source #

The name of the data catalog to update. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

updateDataCatalog_type :: Lens' UpdateDataCatalog DataCatalogType Source #

Specifies the type of data catalog to update. Specify LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

Destructuring the Response

data UpdateDataCatalogResponse Source #

See: newUpdateDataCatalogResponse smart constructor.

Constructors

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

Instances

Instances details

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

newUpdateDataCatalogResponse Source #

Arguments

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

Create a value of UpdateDataCatalogResponse 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:UpdateDataCatalogResponse', updateDataCatalogResponse_httpStatus - The response's http status code.

Response Lenses

updateDataCatalogResponse_httpStatus :: Lens' UpdateDataCatalogResponse Int Source #

The response's http status code.