| 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.StartSchemaCreation
Description
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
Synopsis
- data StartSchemaCreation = StartSchemaCreation' {
- apiId :: Text
- definition :: Base64
- newStartSchemaCreation :: Text -> ByteString -> StartSchemaCreation
- startSchemaCreation_apiId :: Lens' StartSchemaCreation Text
- startSchemaCreation_definition :: Lens' StartSchemaCreation ByteString
- data StartSchemaCreationResponse = StartSchemaCreationResponse' {
- status :: Maybe SchemaStatus
- httpStatus :: Int
- newStartSchemaCreationResponse :: Int -> StartSchemaCreationResponse
- startSchemaCreationResponse_status :: Lens' StartSchemaCreationResponse (Maybe SchemaStatus)
- startSchemaCreationResponse_httpStatus :: Lens' StartSchemaCreationResponse Int
Creating a Request
data StartSchemaCreation Source #
See: newStartSchemaCreation smart constructor.
Constructors
| StartSchemaCreation' | |
Fields
| |
Instances
newStartSchemaCreation Source #
Arguments
| :: Text | |
| -> ByteString | |
| -> StartSchemaCreation |
Create a value of StartSchemaCreation 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:apiId:StartSchemaCreation', startSchemaCreation_apiId - The API ID.
$sel:definition:StartSchemaCreation', startSchemaCreation_definition - The schema definition, in GraphQL schema language format.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
Request Lenses
startSchemaCreation_apiId :: Lens' StartSchemaCreation Text Source #
The API ID.
startSchemaCreation_definition :: Lens' StartSchemaCreation ByteString Source #
The schema definition, in GraphQL schema language format.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
Destructuring the Response
data StartSchemaCreationResponse Source #
See: newStartSchemaCreationResponse smart constructor.
Constructors
| StartSchemaCreationResponse' | |
Fields
| |
Instances
newStartSchemaCreationResponse Source #
Create a value of StartSchemaCreationResponse 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:status:StartSchemaCreationResponse', startSchemaCreationResponse_status - The current state of the schema (PROCESSING, FAILED, SUCCESS, or
NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add
data.
$sel:httpStatus:StartSchemaCreationResponse', startSchemaCreationResponse_httpStatus - The response's http status code.
Response Lenses
startSchemaCreationResponse_status :: Lens' StartSchemaCreationResponse (Maybe SchemaStatus) Source #
The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
startSchemaCreationResponse_httpStatus :: Lens' StartSchemaCreationResponse Int Source #
The response's http status code.