| 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.AppSync.GetIntrospectionSchema
Description
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.
Constructors
| GetIntrospectionSchema' | |
Fields
| |
Instances
newGetIntrospectionSchema Source #
Arguments
| :: Text | |
| -> OutputType | |
| -> 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.
$sel:apiId:GetIntrospectionSchema', getIntrospectionSchema_apiId - The API ID.
$sel:format: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.
Constructors
| GetIntrospectionSchemaResponse' | |
Fields
| |
Instances
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:
$sel:schema: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.