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 |
Retrieves the introspection schema for a GraphQL API.
Synopsis
- data GetIntrospectionSchema = GetIntrospectionSchema' {
- includeDirectives :: Maybe Bool
- apiId :: Text
- format :: OutputType
- newGetIntrospectionSchema :: Text -> OutputType -> GetIntrospectionSchema
- getIntrospectionSchema_includeDirectives :: Lens' GetIntrospectionSchema (Maybe Bool)
- getIntrospectionSchema_apiId :: Lens' GetIntrospectionSchema Text
- getIntrospectionSchema_format :: Lens' GetIntrospectionSchema OutputType
- data GetIntrospectionSchemaResponse = GetIntrospectionSchemaResponse' {
- schema :: Maybe ByteString
- httpStatus :: Int
- newGetIntrospectionSchemaResponse :: Int -> GetIntrospectionSchemaResponse
- getIntrospectionSchemaResponse_schema :: Lens' GetIntrospectionSchemaResponse (Maybe ByteString)
- getIntrospectionSchemaResponse_httpStatus :: Lens' GetIntrospectionSchemaResponse Int
Creating a Request
data GetIntrospectionSchema Source #
See: newGetIntrospectionSchema
smart constructor.
GetIntrospectionSchema' | |
|
Instances
newGetIntrospectionSchema Source #
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) Source #
A flag that specifies whether the schema introspection should contain directives.
getIntrospectionSchema_apiId :: Lens' GetIntrospectionSchema Text Source #
The API ID.
getIntrospectionSchema_format :: Lens' GetIntrospectionSchema OutputType Source #
The schema format: SDL or JSON.
Destructuring the Response
data GetIntrospectionSchemaResponse Source #
See: newGetIntrospectionSchemaResponse
smart constructor.
GetIntrospectionSchemaResponse' | |
|
Instances
Generic GetIntrospectionSchemaResponse Source # | |
Read GetIntrospectionSchemaResponse Source # | |
Show GetIntrospectionSchemaResponse Source # | |
Defined in Amazonka.AppSync.GetIntrospectionSchema | |
NFData GetIntrospectionSchemaResponse Source # | |
Defined in Amazonka.AppSync.GetIntrospectionSchema rnf :: GetIntrospectionSchemaResponse -> () # | |
Eq GetIntrospectionSchemaResponse Source # | |
type Rep GetIntrospectionSchemaResponse Source # | |
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 Source #
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) Source #
The schema, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation.
getIntrospectionSchemaResponse_httpStatus :: Lens' GetIntrospectionSchemaResponse Int Source #
The response's http status code.