AWS AppSync
API Reference (API Version 2017-07-25)

StartSchemaCreation

Adds a new schema to your GraphQL API.

This operation is asynchronous. Use GetSchemaCreationStatus to determine when it has completed.

Request Syntax

POST /apis/apiId/schemacreation HTTP/1.1 Content-type: application/json { "definition": blob }

URI Request Parameters

The request requires the following URI parameters.

apiId

The API ID.

Request Body

The request accepts the following data in JSON format.

definition

The schema definition, in GraphQL schema language format.

Type: Base64-encoded binary data object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "status": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

status

The current state of the schema (PROCESSING, ACTIVE, or DELETING). When the schema is in the ACTIVE state, you can add data.

Type: String

Valid Values: PROCESSING | ACTIVE | DELETING

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

HTTP Status Code: 400

ConcurrentModificationException

Another modification is in progress at this time and it must complete before you can make your change.

HTTP Status Code: 409

InternalFailureException

An internal AWS AppSync error occurred. Try your request again.

HTTP Status Code: 500

NotFoundException

The resource specified in the request was not found. Check the resource, and then try again.

HTTP Status Code: 404

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: