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.Glue.UpdateSchema

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the description, compatibility setting, or version checkpoint for a schema set.

For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility is provided, the VersionNumber (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.

If the value for the VersionNumber (checkpoint) is provided, Compatibility is optional and this can be used to set/reset a checkpoint for the schema.

This update will happen only if the schema is in the AVAILABLE state.

Synopsis

data UpdateSchema = UpdateSchema' {
- compatibility :: Maybe Compatibility
- description :: Maybe Text
- schemaVersionNumber :: Maybe SchemaVersionNumber
- schemaId :: SchemaId
}
newUpdateSchema :: SchemaId -> UpdateSchema
updateSchema_compatibility :: Lens' UpdateSchema (Maybe Compatibility)
updateSchema_description :: Lens' UpdateSchema (Maybe Text)
updateSchema_schemaVersionNumber :: Lens' UpdateSchema (Maybe SchemaVersionNumber)
updateSchema_schemaId :: Lens' UpdateSchema SchemaId
data UpdateSchemaResponse = UpdateSchemaResponse' {
- registryName :: Maybe Text
- schemaArn :: Maybe Text
- schemaName :: Maybe Text
- httpStatus :: Int
}
newUpdateSchemaResponse :: Int -> UpdateSchemaResponse
updateSchemaResponse_registryName :: Lens' UpdateSchemaResponse (Maybe Text)
updateSchemaResponse_schemaArn :: Lens' UpdateSchemaResponse (Maybe Text)
updateSchemaResponse_schemaName :: Lens' UpdateSchemaResponse (Maybe Text)
updateSchemaResponse_httpStatus :: Lens' UpdateSchemaResponse Int

Creating a Request

data UpdateSchema Source #

See: newUpdateSchema smart constructor.

Constructors

UpdateSchema'

Fields

compatibility :: Maybe Compatibility
The new compatibility setting for the schema.
description :: Maybe Text
The new description for the schema.
schemaVersionNumber :: Maybe SchemaVersionNumber
Version number required for check pointing. One of VersionNumber or Compatibility has to be provided.
schemaId :: SchemaId
This is a wrapper structure to contain schema identity fields. The structure contains:
- SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
- SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.

Instances

Instances details

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

newUpdateSchema Source #

Arguments

:: SchemaId	`UpdateSchema`
-> UpdateSchema

Create a value of UpdateSchema 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:compatibility:UpdateSchema', updateSchema_compatibility - The new compatibility setting for the schema.

UpdateSchema, updateSchema_description - The new description for the schema.

UpdateSchema, updateSchema_schemaVersionNumber - Version number required for check pointing. One of VersionNumber or Compatibility has to be provided.

UpdateSchema, updateSchema_schemaId - This is a wrapper structure to contain schema identity fields. The structure contains:

SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.

Request Lenses

updateSchema_compatibility :: Lens' UpdateSchema (Maybe Compatibility) Source #

The new compatibility setting for the schema.

updateSchema_description :: Lens' UpdateSchema (Maybe Text) Source #

The new description for the schema.

updateSchema_schemaVersionNumber :: Lens' UpdateSchema (Maybe SchemaVersionNumber) Source #

Version number required for check pointing. One of VersionNumber or Compatibility has to be provided.

updateSchema_schemaId :: Lens' UpdateSchema SchemaId Source #

This is a wrapper structure to contain schema identity fields. The structure contains:

SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.

Destructuring the Response

data UpdateSchemaResponse Source #

See: newUpdateSchemaResponse smart constructor.

Constructors

UpdateSchemaResponse'
Fields registryName :: Maybe Text The name of the registry that contains the schema. schemaArn :: Maybe Text The Amazon Resource Name (ARN) of the schema. schemaName :: Maybe Text The name of the schema. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateSchemaResponse Source #
Instance details Defined in Amazonka.Glue.UpdateSchema Associated Types type Rep UpdateSchemaResponse :: Type -> Type # Methods from :: UpdateSchemaResponse -> Rep UpdateSchemaResponse x # to :: Rep UpdateSchemaResponse x -> UpdateSchemaResponse #
Read UpdateSchemaResponse Source #
Instance details Defined in Amazonka.Glue.UpdateSchema Methods readsPrec :: Int -> ReadS UpdateSchemaResponse # readList :: ReadS [UpdateSchemaResponse] # readPrec :: ReadPrec UpdateSchemaResponse # readListPrec :: ReadPrec [UpdateSchemaResponse] #
Show UpdateSchemaResponse Source #
Instance details Defined in Amazonka.Glue.UpdateSchema Methods showsPrec :: Int -> UpdateSchemaResponse -> ShowS # show :: UpdateSchemaResponse -> String # showList :: [UpdateSchemaResponse] -> ShowS #
NFData UpdateSchemaResponse Source #
Instance details Defined in Amazonka.Glue.UpdateSchema Methods rnf :: UpdateSchemaResponse -> () #
Eq UpdateSchemaResponse Source #
Instance details Defined in Amazonka.Glue.UpdateSchema Methods (==) :: UpdateSchemaResponse -> UpdateSchemaResponse -> Bool # (/=) :: UpdateSchemaResponse -> UpdateSchemaResponse -> Bool #
type Rep UpdateSchemaResponse Source #
Instance details Defined in Amazonka.Glue.UpdateSchema type Rep UpdateSchemaResponse = D1 ('MetaData "UpdateSchemaResponse" "Amazonka.Glue.UpdateSchema" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "UpdateSchemaResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "registryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schemaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "schemaName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateSchemaResponse Source #

Arguments

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

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

UpdateSchemaResponse, updateSchemaResponse_registryName - The name of the registry that contains the schema.

UpdateSchemaResponse, updateSchemaResponse_schemaArn - The Amazon Resource Name (ARN) of the schema.

UpdateSchemaResponse, updateSchemaResponse_schemaName - The name of the schema.

$sel:httpStatus:UpdateSchemaResponse', updateSchemaResponse_httpStatus - The response's http status code.

Response Lenses

updateSchemaResponse_registryName :: Lens' UpdateSchemaResponse (Maybe Text) Source #

The name of the registry that contains the schema.

updateSchemaResponse_schemaArn :: Lens' UpdateSchemaResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

updateSchemaResponse_schemaName :: Lens' UpdateSchemaResponse (Maybe Text) Source #

The name of the schema.

updateSchemaResponse_httpStatus :: Lens' UpdateSchemaResponse Int Source #

The response's http status code.