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.GetSchema

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified schema in detail.

Synopsis

data GetSchema = GetSchema' {
- schemaId :: SchemaId
}
newGetSchema :: SchemaId -> GetSchema
getSchema_schemaId :: Lens' GetSchema SchemaId
data GetSchemaResponse = GetSchemaResponse' {
- compatibility :: Maybe Compatibility
- createdTime :: Maybe Text
- dataFormat :: Maybe DataFormat
- description :: Maybe Text
- latestSchemaVersion :: Maybe Natural
- nextSchemaVersion :: Maybe Natural
- registryArn :: Maybe Text
- registryName :: Maybe Text
- schemaArn :: Maybe Text
- schemaCheckpoint :: Maybe Natural
- schemaName :: Maybe Text
- schemaStatus :: Maybe SchemaStatus
- updatedTime :: Maybe Text
- httpStatus :: Int
}
newGetSchemaResponse :: Int -> GetSchemaResponse
getSchemaResponse_compatibility :: Lens' GetSchemaResponse (Maybe Compatibility)
getSchemaResponse_createdTime :: Lens' GetSchemaResponse (Maybe Text)
getSchemaResponse_dataFormat :: Lens' GetSchemaResponse (Maybe DataFormat)
getSchemaResponse_description :: Lens' GetSchemaResponse (Maybe Text)
getSchemaResponse_latestSchemaVersion :: Lens' GetSchemaResponse (Maybe Natural)
getSchemaResponse_nextSchemaVersion :: Lens' GetSchemaResponse (Maybe Natural)
getSchemaResponse_registryArn :: Lens' GetSchemaResponse (Maybe Text)
getSchemaResponse_registryName :: Lens' GetSchemaResponse (Maybe Text)
getSchemaResponse_schemaArn :: Lens' GetSchemaResponse (Maybe Text)
getSchemaResponse_schemaCheckpoint :: Lens' GetSchemaResponse (Maybe Natural)
getSchemaResponse_schemaName :: Lens' GetSchemaResponse (Maybe Text)
getSchemaResponse_schemaStatus :: Lens' GetSchemaResponse (Maybe SchemaStatus)
getSchemaResponse_updatedTime :: Lens' GetSchemaResponse (Maybe Text)
getSchemaResponse_httpStatus :: Lens' GetSchemaResponse Int

Creating a Request

data GetSchema Source #

See: newGetSchema smart constructor.

Constructors

GetSchema'
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.

Instances

Instances details

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

newGetSchema Source #

Arguments

:: SchemaId	`GetSchema`
-> GetSchema

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

GetSchema, getSchema_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.

Request Lenses

getSchema_schemaId :: Lens' GetSchema 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.

Destructuring the Response

data GetSchemaResponse Source #

See: newGetSchemaResponse smart constructor.

Constructors

GetSchemaResponse'

Fields

compatibility :: Maybe Compatibility
The compatibility mode of the schema.
createdTime :: Maybe Text
The date and time the schema was created.
dataFormat :: Maybe DataFormat
The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
description :: Maybe Text
A description of schema if specified when created
latestSchemaVersion :: Maybe Natural
The latest version of the schema associated with the returned schema definition.
nextSchemaVersion :: Maybe Natural
The next version of the schema associated with the returned schema definition.
registryArn :: Maybe Text
The Amazon Resource Name (ARN) of the registry.
registryName :: Maybe Text
The name of the registry.
schemaArn :: Maybe Text
The Amazon Resource Name (ARN) of the schema.
schemaCheckpoint :: Maybe Natural
The version number of the checkpoint (the last time the compatibility mode was changed).
schemaName :: Maybe Text
The name of the schema.
schemaStatus :: Maybe SchemaStatus
The status of the schema.
updatedTime :: Maybe Text
The date and time the schema was updated.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetSchemaResponse Source #

Arguments

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

Create a value of GetSchemaResponse 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:GetSchemaResponse', getSchemaResponse_compatibility - The compatibility mode of the schema.

GetSchemaResponse, getSchemaResponse_createdTime - The date and time the schema was created.

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

GetSchemaResponse, getSchemaResponse_description - A description of schema if specified when created

$sel:latestSchemaVersion:GetSchemaResponse', getSchemaResponse_latestSchemaVersion - The latest version of the schema associated with the returned schema definition.

$sel:nextSchemaVersion:GetSchemaResponse', getSchemaResponse_nextSchemaVersion - The next version of the schema associated with the returned schema definition.

GetSchemaResponse, getSchemaResponse_registryArn - The Amazon Resource Name (ARN) of the registry.

GetSchemaResponse, getSchemaResponse_registryName - The name of the registry.

GetSchemaResponse, getSchemaResponse_schemaArn - The Amazon Resource Name (ARN) of the schema.

$sel:schemaCheckpoint:GetSchemaResponse', getSchemaResponse_schemaCheckpoint - The version number of the checkpoint (the last time the compatibility mode was changed).

GetSchemaResponse, getSchemaResponse_schemaName - The name of the schema.

GetSchemaResponse, getSchemaResponse_schemaStatus - The status of the schema.

GetSchemaResponse, getSchemaResponse_updatedTime - The date and time the schema was updated.

$sel:httpStatus:GetSchemaResponse', getSchemaResponse_httpStatus - The response's http status code.

Response Lenses

getSchemaResponse_compatibility :: Lens' GetSchemaResponse (Maybe Compatibility) Source #

The compatibility mode of the schema.

getSchemaResponse_createdTime :: Lens' GetSchemaResponse (Maybe Text) Source #

The date and time the schema was created.

getSchemaResponse_dataFormat :: Lens' GetSchemaResponse (Maybe DataFormat) Source #

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

getSchemaResponse_description :: Lens' GetSchemaResponse (Maybe Text) Source #

A description of schema if specified when created

getSchemaResponse_latestSchemaVersion :: Lens' GetSchemaResponse (Maybe Natural) Source #

The latest version of the schema associated with the returned schema definition.

getSchemaResponse_nextSchemaVersion :: Lens' GetSchemaResponse (Maybe Natural) Source #

The next version of the schema associated with the returned schema definition.

getSchemaResponse_registryArn :: Lens' GetSchemaResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the registry.

getSchemaResponse_registryName :: Lens' GetSchemaResponse (Maybe Text) Source #

The name of the registry.

getSchemaResponse_schemaArn :: Lens' GetSchemaResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

getSchemaResponse_schemaCheckpoint :: Lens' GetSchemaResponse (Maybe Natural) Source #

The version number of the checkpoint (the last time the compatibility mode was changed).

getSchemaResponse_schemaName :: Lens' GetSchemaResponse (Maybe Text) Source #

The name of the schema.

getSchemaResponse_schemaStatus :: Lens' GetSchemaResponse (Maybe SchemaStatus) Source #

The status of the schema.

getSchemaResponse_updatedTime :: Lens' GetSchemaResponse (Maybe Text) Source #

The date and time the schema was updated.

getSchemaResponse_httpStatus :: Lens' GetSchemaResponse Int Source #

The response's http status code.