amazonka-lakeformation-2.0: Amazon Lake Formation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LakeFormation.UpdateLFTag

Description

Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.

Synopsis

Creating a Request

data UpdateLFTag Source #

See: newUpdateLFTag smart constructor.

Constructors

UpdateLFTag' 

Fields

  • catalogId :: Maybe Text

    The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

  • tagValuesToAdd :: Maybe (NonEmpty Text)

    A list of LF-tag values to add from the LF-tag.

  • tagValuesToDelete :: Maybe (NonEmpty Text)

    A list of LF-tag values to delete from the LF-tag.

  • tagKey :: Text

    The key-name for the LF-tag for which to add or delete values.

Instances

Instances details
ToJSON UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

ToHeaders UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

Methods

toHeaders :: UpdateLFTag -> [Header] #

ToPath UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

ToQuery UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

AWSRequest UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

Associated Types

type AWSResponse UpdateLFTag #

Generic UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

Associated Types

type Rep UpdateLFTag :: Type -> Type #

Read UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

Show UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

NFData UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

Methods

rnf :: UpdateLFTag -> () #

Eq UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

Hashable UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

type AWSResponse UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

type Rep UpdateLFTag Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

type Rep UpdateLFTag = D1 ('MetaData "UpdateLFTag" "Amazonka.LakeFormation.UpdateLFTag" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "UpdateLFTag'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tagValuesToAdd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :*: (S1 ('MetaSel ('Just "tagValuesToDelete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "tagKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateLFTag Source #

Create a value of UpdateLFTag 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:

UpdateLFTag, updateLFTag_catalogId - The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

$sel:tagValuesToAdd:UpdateLFTag', updateLFTag_tagValuesToAdd - A list of LF-tag values to add from the LF-tag.

$sel:tagValuesToDelete:UpdateLFTag', updateLFTag_tagValuesToDelete - A list of LF-tag values to delete from the LF-tag.

UpdateLFTag, updateLFTag_tagKey - The key-name for the LF-tag for which to add or delete values.

Request Lenses

updateLFTag_catalogId :: Lens' UpdateLFTag (Maybe Text) Source #

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

updateLFTag_tagValuesToAdd :: Lens' UpdateLFTag (Maybe (NonEmpty Text)) Source #

A list of LF-tag values to add from the LF-tag.

updateLFTag_tagValuesToDelete :: Lens' UpdateLFTag (Maybe (NonEmpty Text)) Source #

A list of LF-tag values to delete from the LF-tag.

updateLFTag_tagKey :: Lens' UpdateLFTag Text Source #

The key-name for the LF-tag for which to add or delete values.

Destructuring the Response

data UpdateLFTagResponse Source #

See: newUpdateLFTagResponse smart constructor.

Constructors

UpdateLFTagResponse' 

Fields

Instances

Instances details
Generic UpdateLFTagResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

Associated Types

type Rep UpdateLFTagResponse :: Type -> Type #

Read UpdateLFTagResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

Show UpdateLFTagResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

NFData UpdateLFTagResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

Methods

rnf :: UpdateLFTagResponse -> () #

Eq UpdateLFTagResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

type Rep UpdateLFTagResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.UpdateLFTag

type Rep UpdateLFTagResponse = D1 ('MetaData "UpdateLFTagResponse" "Amazonka.LakeFormation.UpdateLFTag" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "UpdateLFTagResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateLFTagResponse Source #

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

Response Lenses