libZSservicesZSamazonka-glueZSamazonka-glue
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Glue.RegisterSchemaVersion

Description

Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.

If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes.

If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.

Synopsis

Creating a Request

data RegisterSchemaVersion Source #

See: newRegisterSchemaVersion smart constructor.

Constructors

RegisterSchemaVersion' 

Fields

  • 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. Either SchemaArn or SchemaName and RegistryName has to be provided.
    • SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
  • schemaDefinition :: Text

    The schema definition using the DataFormat setting for the SchemaName.

Instances

Instances details
Eq RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

(==) :: RegisterSchemaVersion -> RegisterSchemaVersion -> Bool #

(/=) :: RegisterSchemaVersion -> RegisterSchemaVersion -> Bool #

Read RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

readsPrec :: Int -> ReadS RegisterSchemaVersion #

readList :: ReadS [RegisterSchemaVersion] #

readPrec :: ReadPrec RegisterSchemaVersion #

readListPrec :: ReadPrec [RegisterSchemaVersion] #

Show RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

showsPrec :: Int -> RegisterSchemaVersion -> ShowS #

show :: RegisterSchemaVersion -> String #

showList :: [RegisterSchemaVersion] -> ShowS #

Generic RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Associated Types

type Rep RegisterSchemaVersion :: Type -> Type #

Methods

from :: RegisterSchemaVersion -> Rep RegisterSchemaVersion x #

to :: Rep RegisterSchemaVersion x -> RegisterSchemaVersion #

NFData RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

rnf :: RegisterSchemaVersion -> () #

Hashable RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

hashWithSalt :: Int -> RegisterSchemaVersion -> Int #

hash :: RegisterSchemaVersion -> Int #

ToJSON RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

toJSON :: RegisterSchemaVersion -> Value #

toEncoding :: RegisterSchemaVersion -> Encoding #

toJSONList :: [RegisterSchemaVersion] -> Value #

toEncodingList :: [RegisterSchemaVersion] -> Encoding #

AWSRequest RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Associated Types

type AWSResponse RegisterSchemaVersion #

Methods

request :: RegisterSchemaVersion -> Request RegisterSchemaVersion #

response :: MonadResource m => Logger -> Service -> Proxy RegisterSchemaVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterSchemaVersion))) #

ToHeaders RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

toHeaders :: RegisterSchemaVersion -> [Header] #

ToPath RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

toPath :: RegisterSchemaVersion -> ByteString #

ToQuery RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

toQuery :: RegisterSchemaVersion -> QueryString #

type Rep RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

type Rep RegisterSchemaVersion = D1 ('MetaData "RegisterSchemaVersion" "Amazonka.Glue.RegisterSchemaVersion" "libZSservicesZSamazonka-glueZSamazonka-glue" 'False) (C1 ('MetaCons "RegisterSchemaVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "schemaId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaId) :*: S1 ('MetaSel ('Just "schemaDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse RegisterSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

type AWSResponse RegisterSchemaVersion = RegisterSchemaVersionResponse

newRegisterSchemaVersion Source #

Arguments

:: SchemaId

$sel:schemaId:RegisterSchemaVersion'

-> Text

$sel:schemaDefinition:RegisterSchemaVersion'

-> RegisterSchemaVersion 

Create a value of RegisterSchemaVersion 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:schemaId:RegisterSchemaVersion', registerSchemaVersion_schemaId - This is a wrapper structure to contain schema identity fields. The structure contains:

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

$sel:schemaDefinition:RegisterSchemaVersion', registerSchemaVersion_schemaDefinition - The schema definition using the DataFormat setting for the SchemaName.

Request Lenses

registerSchemaVersion_schemaId :: Lens' RegisterSchemaVersion 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. Either SchemaArn or SchemaName and RegistryName has to be provided.
  • SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.

registerSchemaVersion_schemaDefinition :: Lens' RegisterSchemaVersion Text Source #

The schema definition using the DataFormat setting for the SchemaName.

Destructuring the Response

data RegisterSchemaVersionResponse Source #

See: newRegisterSchemaVersionResponse smart constructor.

Constructors

RegisterSchemaVersionResponse' 

Fields

Instances

Instances details
Eq RegisterSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

(==) :: RegisterSchemaVersionResponse -> RegisterSchemaVersionResponse -> Bool #

(/=) :: RegisterSchemaVersionResponse -> RegisterSchemaVersionResponse -> Bool #

Read RegisterSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

readsPrec :: Int -> ReadS RegisterSchemaVersionResponse #

readList :: ReadS [RegisterSchemaVersionResponse] #

readPrec :: ReadPrec RegisterSchemaVersionResponse #

readListPrec :: ReadPrec [RegisterSchemaVersionResponse] #

Show RegisterSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

showsPrec :: Int -> RegisterSchemaVersionResponse -> ShowS #

show :: RegisterSchemaVersionResponse -> String #

showList :: [RegisterSchemaVersionResponse] -> ShowS #

Generic RegisterSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Associated Types

type Rep RegisterSchemaVersionResponse :: Type -> Type #

Methods

from :: RegisterSchemaVersionResponse -> Rep RegisterSchemaVersionResponse x #

to :: Rep RegisterSchemaVersionResponse x -> RegisterSchemaVersionResponse #

NFData RegisterSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

Methods

rnf :: RegisterSchemaVersionResponse -> () #

type Rep RegisterSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.RegisterSchemaVersion

type Rep RegisterSchemaVersionResponse = D1 ('MetaData "RegisterSchemaVersionResponse" "Amazonka.Glue.RegisterSchemaVersion" "libZSservicesZSamazonka-glueZSamazonka-glue" 'False) (C1 ('MetaCons "RegisterSchemaVersionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaVersionStatus)) :*: S1 ('MetaSel ('Just "schemaVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "versionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRegisterSchemaVersionResponse Source #

Arguments

:: Int

$sel:httpStatus:RegisterSchemaVersionResponse'

-> RegisterSchemaVersionResponse 

Create a value of RegisterSchemaVersionResponse 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:status:RegisterSchemaVersionResponse', registerSchemaVersionResponse_status - The status of the schema version.

$sel:schemaVersionId:RegisterSchemaVersionResponse', registerSchemaVersionResponse_schemaVersionId - The unique ID that represents the version of this schema.

$sel:versionNumber:RegisterSchemaVersionResponse', registerSchemaVersionResponse_versionNumber - The version of this schema (for sync flow only, in case this is the first version).

$sel:httpStatus:RegisterSchemaVersionResponse', registerSchemaVersionResponse_httpStatus - The response's http status code.

Response Lenses

registerSchemaVersionResponse_status :: Lens' RegisterSchemaVersionResponse (Maybe SchemaVersionStatus) Source #

The status of the schema version.

registerSchemaVersionResponse_schemaVersionId :: Lens' RegisterSchemaVersionResponse (Maybe Text) Source #

The unique ID that represents the version of this schema.

registerSchemaVersionResponse_versionNumber :: Lens' RegisterSchemaVersionResponse (Maybe Natural) Source #

The version of this schema (for sync flow only, in case this is the first version).

registerSchemaVersionResponse_httpStatus :: Lens' RegisterSchemaVersionResponse Int Source #

The response's http status code.