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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a schema by the SchemaDefinition. The schema definition is sent to the Schema Registry, canonicalized, and hashed. If the hash is matched within the scope of the SchemaName or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in Deleted statuses will not be included in the results.

Synopsis

Creating a Request

data GetSchemaByDefinition Source #

See: newGetSchemaByDefinition smart constructor.

Constructors

GetSchemaByDefinition'

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. 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.
schemaDefinition :: Text
The definition of the schema for which schema details are required.

Instances

Instances details

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

newGetSchemaByDefinition Source #

Arguments

:: SchemaId	`GetSchemaByDefinition`
-> Text	`$sel:schemaDefinition:GetSchemaByDefinition'`
-> GetSchemaByDefinition

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

GetSchemaByDefinition, getSchemaByDefinition_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.

$sel:schemaDefinition:GetSchemaByDefinition', getSchemaByDefinition_schemaDefinition - The definition of the schema for which schema details are required.

Request Lenses

getSchemaByDefinition_schemaId :: Lens' GetSchemaByDefinition 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.

getSchemaByDefinition_schemaDefinition :: Lens' GetSchemaByDefinition Text Source #

The definition of the schema for which schema details are required.

Destructuring the Response

data GetSchemaByDefinitionResponse Source #

See: newGetSchemaByDefinitionResponse smart constructor.

Constructors

GetSchemaByDefinitionResponse'

Fields

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.
schemaArn :: Maybe Text
The Amazon Resource Name (ARN) of the schema.
schemaVersionId :: Maybe Text
The schema ID of the schema version.
status :: Maybe SchemaVersionStatus
The status of the schema version.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetSchemaByDefinitionResponse Source #

Arguments

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

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

GetSchemaByDefinitionResponse, getSchemaByDefinitionResponse_createdTime - The date and time the schema was created.

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

GetSchemaByDefinitionResponse, getSchemaByDefinitionResponse_schemaArn - The Amazon Resource Name (ARN) of the schema.

GetSchemaByDefinitionResponse, getSchemaByDefinitionResponse_schemaVersionId - The schema ID of the schema version.

GetSchemaByDefinitionResponse, getSchemaByDefinitionResponse_status - The status of the schema version.

$sel:httpStatus:GetSchemaByDefinitionResponse', getSchemaByDefinitionResponse_httpStatus - The response's http status code.

Response Lenses

getSchemaByDefinitionResponse_createdTime :: Lens' GetSchemaByDefinitionResponse (Maybe Text) Source #

The date and time the schema was created.

getSchemaByDefinitionResponse_dataFormat :: Lens' GetSchemaByDefinitionResponse (Maybe DataFormat) Source #

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

getSchemaByDefinitionResponse_schemaArn :: Lens' GetSchemaByDefinitionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

getSchemaByDefinitionResponse_schemaVersionId :: Lens' GetSchemaByDefinitionResponse (Maybe Text) Source #

The schema ID of the schema version.

getSchemaByDefinitionResponse_status :: Lens' GetSchemaByDefinitionResponse (Maybe SchemaVersionStatus) Source #

The status of the schema version.

getSchemaByDefinitionResponse_httpStatus :: Lens' GetSchemaByDefinitionResponse Int Source #

The response's http status code.