Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Schemas.DescribeSchema

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieve the schema definition.

Synopsis

data DescribeSchema = DescribeSchema' {
- schemaVersion :: Maybe Text
- registryName :: Text
- schemaName :: Text
}
newDescribeSchema :: Text -> Text -> DescribeSchema
describeSchema_schemaVersion :: Lens' DescribeSchema (Maybe Text)
describeSchema_registryName :: Lens' DescribeSchema Text
describeSchema_schemaName :: Lens' DescribeSchema Text
data DescribeSchemaResponse = DescribeSchemaResponse' {
- schemaVersion :: Maybe Text
- schemaName :: Maybe Text
- content :: Maybe Text
- schemaArn :: Maybe Text
- type' :: Maybe Text
- lastModified :: Maybe POSIX
- description :: Maybe Text
- versionCreatedDate :: Maybe POSIX
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newDescribeSchemaResponse :: Int -> DescribeSchemaResponse
describeSchemaResponse_schemaVersion :: Lens' DescribeSchemaResponse (Maybe Text)
describeSchemaResponse_schemaName :: Lens' DescribeSchemaResponse (Maybe Text)
describeSchemaResponse_content :: Lens' DescribeSchemaResponse (Maybe Text)
describeSchemaResponse_schemaArn :: Lens' DescribeSchemaResponse (Maybe Text)
describeSchemaResponse_type :: Lens' DescribeSchemaResponse (Maybe Text)
describeSchemaResponse_lastModified :: Lens' DescribeSchemaResponse (Maybe UTCTime)
describeSchemaResponse_description :: Lens' DescribeSchemaResponse (Maybe Text)
describeSchemaResponse_versionCreatedDate :: Lens' DescribeSchemaResponse (Maybe UTCTime)
describeSchemaResponse_tags :: Lens' DescribeSchemaResponse (Maybe (HashMap Text Text))
describeSchemaResponse_httpStatus :: Lens' DescribeSchemaResponse Int

Creating a Request

data DescribeSchema Source #

See: newDescribeSchema smart constructor.

Constructors

DescribeSchema'
Fields schemaVersion :: Maybe Text Specifying this limits the results to only this schema version. registryName :: Text The name of the registry. schemaName :: Text The name of the schema.

Instances

Instances details

Eq DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods (==) :: DescribeSchema -> DescribeSchema -> Bool # (/=) :: DescribeSchema -> DescribeSchema -> Bool #
Read DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods readsPrec :: Int -> ReadS DescribeSchema # readList :: ReadS [DescribeSchema] # readPrec :: ReadPrec DescribeSchema # readListPrec :: ReadPrec [DescribeSchema] #
Show DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods showsPrec :: Int -> DescribeSchema -> ShowS # show :: DescribeSchema -> String # showList :: [DescribeSchema] -> ShowS #
Generic DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Associated Types type Rep DescribeSchema :: Type -> Type # Methods from :: DescribeSchema -> Rep DescribeSchema x # to :: Rep DescribeSchema x -> DescribeSchema #
NFData DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods rnf :: DescribeSchema -> () #
Hashable DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods hashWithSalt :: Int -> DescribeSchema -> Int # hash :: DescribeSchema -> Int #
AWSRequest DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Associated Types type AWSResponse DescribeSchema # Methods request :: DescribeSchema -> Request DescribeSchema # response :: MonadResource m => Logger -> Service -> Proxy DescribeSchema -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSchema))) #
ToHeaders DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods toHeaders :: DescribeSchema -> [Header] #
ToPath DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods toPath :: DescribeSchema -> ByteString #
ToQuery DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods toQuery :: DescribeSchema -> QueryString #
type Rep DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema type Rep DescribeSchema = D1 ('MetaData "DescribeSchema" "Amazonka.Schemas.DescribeSchema" "libZSservicesZSamazonka-schemasZSamazonka-schemas" 'False) (C1 ('MetaCons "DescribeSchema'" 'PrefixI 'True) (S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "registryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "schemaName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeSchema Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema type AWSResponse DescribeSchema = DescribeSchemaResponse

newDescribeSchema Source #

Arguments

:: Text	`$sel:registryName:DescribeSchema'`
-> Text	`$sel:schemaName:DescribeSchema'`
-> DescribeSchema

Create a value of DescribeSchema 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:schemaVersion:DescribeSchema', describeSchema_schemaVersion - Specifying this limits the results to only this schema version.

$sel:registryName:DescribeSchema', describeSchema_registryName - The name of the registry.

$sel:schemaName:DescribeSchema', describeSchema_schemaName - The name of the schema.

Request Lenses

describeSchema_schemaVersion :: Lens' DescribeSchema (Maybe Text) Source #

Specifying this limits the results to only this schema version.

describeSchema_registryName :: Lens' DescribeSchema Text Source #

The name of the registry.

describeSchema_schemaName :: Lens' DescribeSchema Text Source #

The name of the schema.

Destructuring the Response

data DescribeSchemaResponse Source #

See: newDescribeSchemaResponse smart constructor.

Constructors

DescribeSchemaResponse'

Fields

schemaVersion :: Maybe Text
The version number of the schema
schemaName :: Maybe Text
The name of the schema.
content :: Maybe Text
The source of the schema definition.
schemaArn :: Maybe Text
The ARN of the schema.
type' :: Maybe Text
The type of the schema.
lastModified :: Maybe POSIX
The date and time that schema was modified.
description :: Maybe Text
The description of the schema.
versionCreatedDate :: Maybe POSIX
The date the schema version was created.
tags :: Maybe (HashMap Text Text)
Tags associated with the resource.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeSchemaResponse Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods (==) :: DescribeSchemaResponse -> DescribeSchemaResponse -> Bool # (/=) :: DescribeSchemaResponse -> DescribeSchemaResponse -> Bool #
Read DescribeSchemaResponse Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods readsPrec :: Int -> ReadS DescribeSchemaResponse # readList :: ReadS [DescribeSchemaResponse] # readPrec :: ReadPrec DescribeSchemaResponse # readListPrec :: ReadPrec [DescribeSchemaResponse] #
Show DescribeSchemaResponse Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods showsPrec :: Int -> DescribeSchemaResponse -> ShowS # show :: DescribeSchemaResponse -> String # showList :: [DescribeSchemaResponse] -> ShowS #
Generic DescribeSchemaResponse Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Associated Types type Rep DescribeSchemaResponse :: Type -> Type # Methods from :: DescribeSchemaResponse -> Rep DescribeSchemaResponse x # to :: Rep DescribeSchemaResponse x -> DescribeSchemaResponse #
NFData DescribeSchemaResponse Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema Methods rnf :: DescribeSchemaResponse -> () #
type Rep DescribeSchemaResponse Source #
Instance details Defined in Amazonka.Schemas.DescribeSchema type Rep DescribeSchemaResponse = D1 ('MetaData "DescribeSchemaResponse" "Amazonka.Schemas.DescribeSchema" "libZSservicesZSamazonka-schemasZSamazonka-schemas" 'False) (C1 ('MetaCons "DescribeSchemaResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schemaName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "schemaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "lastModified") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "versionCreatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))