amazonka-glue-2.0: Amazon Glue 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.Glue.GetSchemaVersion

Description

Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.

Synopsis

Creating a Request

data GetSchemaVersion Source #

See: newGetSchemaVersion smart constructor.

Constructors

GetSchemaVersion' 

Fields

  • schemaId :: Maybe 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.
  • schemaVersionId :: Maybe Text

    The SchemaVersionId of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.

  • schemaVersionNumber :: Maybe SchemaVersionNumber

    The version number of the schema.

Instances

Instances details
ToJSON GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

ToHeaders GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

ToPath GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

ToQuery GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

AWSRequest GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

Associated Types

type AWSResponse GetSchemaVersion #

Generic GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

Associated Types

type Rep GetSchemaVersion :: Type -> Type #

Read GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

Show GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

NFData GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

Methods

rnf :: GetSchemaVersion -> () #

Eq GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

Hashable GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

type AWSResponse GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

type Rep GetSchemaVersion Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

type Rep GetSchemaVersion = D1 ('MetaData "GetSchemaVersion" "Amazonka.Glue.GetSchemaVersion" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetSchemaVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "schemaId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaId)) :*: (S1 ('MetaSel ('Just "schemaVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "schemaVersionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaVersionNumber)))))

newGetSchemaVersion :: GetSchemaVersion Source #

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

GetSchemaVersion, getSchemaVersion_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.

GetSchemaVersion, getSchemaVersion_schemaVersionId - The SchemaVersionId of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.

GetSchemaVersion, getSchemaVersion_schemaVersionNumber - The version number of the schema.

Request Lenses

getSchemaVersion_schemaId :: Lens' GetSchemaVersion (Maybe 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.

getSchemaVersion_schemaVersionId :: Lens' GetSchemaVersion (Maybe Text) Source #

The SchemaVersionId of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.

Destructuring the Response

data GetSchemaVersionResponse Source #

See: newGetSchemaVersionResponse smart constructor.

Constructors

GetSchemaVersionResponse' 

Fields

Instances

Instances details
Generic GetSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

Associated Types

type Rep GetSchemaVersionResponse :: Type -> Type #

Read GetSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

Show GetSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

NFData GetSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

Eq GetSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

type Rep GetSchemaVersionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetSchemaVersion

newGetSchemaVersionResponse Source #

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

GetSchemaVersionResponse, getSchemaVersionResponse_createdTime - The date and time the schema version was created.

$sel:dataFormat:GetSchemaVersionResponse', getSchemaVersionResponse_dataFormat - The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

GetSchemaVersionResponse, getSchemaVersionResponse_schemaArn - The Amazon Resource Name (ARN) of the schema.

$sel:schemaDefinition:GetSchemaVersionResponse', getSchemaVersionResponse_schemaDefinition - The schema definition for the schema ID.

GetSchemaVersion, getSchemaVersionResponse_schemaVersionId - The SchemaVersionId of the schema version.

GetSchemaVersionResponse, getSchemaVersionResponse_status - The status of the schema version.

GetSchemaVersionResponse, getSchemaVersionResponse_versionNumber - The version number of the schema.

$sel:httpStatus:GetSchemaVersionResponse', getSchemaVersionResponse_httpStatus - The response's http status code.

Response Lenses

getSchemaVersionResponse_createdTime :: Lens' GetSchemaVersionResponse (Maybe Text) Source #

The date and time the schema version was created.

getSchemaVersionResponse_dataFormat :: Lens' GetSchemaVersionResponse (Maybe DataFormat) Source #

The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

getSchemaVersionResponse_schemaArn :: Lens' GetSchemaVersionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.