Amazonka.AppSync.GetIntrospectionSchema

Retrieves the introspection schema for a GraphQL API.

Creating a Request

data GetIntrospectionSchema

See: newGetIntrospectionSchema smart constructor.

Constructors

GetIntrospectionSchema'

Fields

• includeDirectives :: Maybe Bool

  A flag that specifies whether the schema introspection should contain directives.

• apiId :: Text

  The API ID.

• format :: OutputType

  The schema format: SDL or JSON.

Instances

ToHeaders GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

toHeaders :: GetIntrospectionSchema -> [Header]

ToPath GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

toPath :: GetIntrospectionSchema -> ByteString

ToQuery GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

toQuery :: GetIntrospectionSchema -> QueryString

AWSRequest GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

Associated Types

type AWSResponse GetIntrospectionSchema

Methods

request :: (Service -> Service) -> GetIntrospectionSchema -> Request GetIntrospectionSchema

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetIntrospectionSchema -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetIntrospectionSchema)))

Generic GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

Associated Types

type Rep GetIntrospectionSchema :: Type -> Type

Methods

from :: GetIntrospectionSchema -> Rep GetIntrospectionSchema x

to :: Rep GetIntrospectionSchema x -> GetIntrospectionSchema

Read GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

readsPrec :: Int -> ReadS GetIntrospectionSchema

readList :: ReadS [GetIntrospectionSchema]

readPrec :: ReadPrec GetIntrospectionSchema

readListPrec :: ReadPrec [GetIntrospectionSchema]

Show GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

showsPrec :: Int -> GetIntrospectionSchema -> ShowS

show :: GetIntrospectionSchema -> String

showList :: [GetIntrospectionSchema] -> ShowS

NFData GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

rnf :: GetIntrospectionSchema -> ()

Eq GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

(==) :: GetIntrospectionSchema -> GetIntrospectionSchema -> Bool

(/=) :: GetIntrospectionSchema -> GetIntrospectionSchema -> Bool

Hashable GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

hashWithSalt :: Int -> GetIntrospectionSchema -> Int

hash :: GetIntrospectionSchema -> Int

type AWSResponse GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

type AWSResponse GetIntrospectionSchema = GetIntrospectionSchemaResponse

type Rep GetIntrospectionSchema

Defined in Amazonka.AppSync.GetIntrospectionSchema

type Rep GetIntrospectionSchema = D1 ('MetaData "GetIntrospectionSchema" "Amazonka.AppSync.GetIntrospectionSchema" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "GetIntrospectionSchema'" 'PrefixI 'True) (S1 ('MetaSel ('Just "includeDirectives") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputType))))

newGetIntrospectionSchema

Arguments

:: Text

GetIntrospectionSchema

-> OutputType

GetIntrospectionSchema

-> GetIntrospectionSchema

Create a value of GetIntrospectionSchema 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:includeDirectives:GetIntrospectionSchema', getIntrospectionSchema_includeDirectives - A flag that specifies whether the schema introspection should contain directives.

GetIntrospectionSchema, getIntrospectionSchema_apiId - The API ID.

GetIntrospectionSchema, getIntrospectionSchema_format - The schema format: SDL or JSON.

Request Lenses

getIntrospectionSchema_includeDirectives :: Lens' GetIntrospectionSchema (Maybe Bool)

A flag that specifies whether the schema introspection should contain directives.

getIntrospectionSchema_apiId :: Lens' GetIntrospectionSchema Text

The API ID.

getIntrospectionSchema_format :: Lens' GetIntrospectionSchema OutputType

The schema format: SDL or JSON.

Destructuring the Response

data GetIntrospectionSchemaResponse

See: newGetIntrospectionSchemaResponse smart constructor.

Constructors

GetIntrospectionSchemaResponse'

Fields

• schema :: Maybe ByteString

  The schema, in GraphQL Schema Definition Language (SDL) format.

  For more information, see the GraphQL SDL documentation.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetIntrospectionSchemaResponse

Defined in Amazonka.AppSync.GetIntrospectionSchema

Associated Types

type Rep GetIntrospectionSchemaResponse :: Type -> Type

Methods

from :: GetIntrospectionSchemaResponse -> Rep GetIntrospectionSchemaResponse x

to :: Rep GetIntrospectionSchemaResponse x -> GetIntrospectionSchemaResponse

Read GetIntrospectionSchemaResponse

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

readsPrec :: Int -> ReadS GetIntrospectionSchemaResponse

readList :: ReadS [GetIntrospectionSchemaResponse]

readPrec :: ReadPrec GetIntrospectionSchemaResponse

readListPrec :: ReadPrec [GetIntrospectionSchemaResponse]

Show GetIntrospectionSchemaResponse

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

showsPrec :: Int -> GetIntrospectionSchemaResponse -> ShowS

show :: GetIntrospectionSchemaResponse -> String

showList :: [GetIntrospectionSchemaResponse] -> ShowS

NFData GetIntrospectionSchemaResponse

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

rnf :: GetIntrospectionSchemaResponse -> ()

Eq GetIntrospectionSchemaResponse

Defined in Amazonka.AppSync.GetIntrospectionSchema

Methods

(==) :: GetIntrospectionSchemaResponse -> GetIntrospectionSchemaResponse -> Bool

(/=) :: GetIntrospectionSchemaResponse -> GetIntrospectionSchemaResponse -> Bool

type Rep GetIntrospectionSchemaResponse

Defined in Amazonka.AppSync.GetIntrospectionSchema

type Rep GetIntrospectionSchemaResponse = D1 ('MetaData "GetIntrospectionSchemaResponse" "Amazonka.AppSync.GetIntrospectionSchema" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "GetIntrospectionSchemaResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetIntrospectionSchemaResponse

Arguments

:: Int

$sel:httpStatus:GetIntrospectionSchemaResponse'

-> GetIntrospectionSchemaResponse

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

GetIntrospectionSchemaResponse, getIntrospectionSchemaResponse_schema - The schema, in GraphQL Schema Definition Language (SDL) format.

For more information, see the GraphQL SDL documentation.

$sel:httpStatus:GetIntrospectionSchemaResponse', getIntrospectionSchemaResponse_httpStatus - The response's http status code.

Response Lenses

getIntrospectionSchemaResponse_schema :: Lens' GetIntrospectionSchemaResponse (Maybe ByteString)

The schema, in GraphQL Schema Definition Language (SDL) format.

For more information, see the GraphQL SDL documentation.

getIntrospectionSchemaResponse_httpStatus :: Lens' GetIntrospectionSchemaResponse Int

The response's http status code.