GetSchemaCreationStatus

Retrieves the current status of a schema creation operation.

Request Syntax


GET /v1/apis/apiId/schemacreation HTTP/1.1

The request uses the following URI parameters.

The API ID.

Required: Yes

The request does not have a request body.


HTTP/1.1 200
Content-type: application/json

{
   "details": "string",
   "status": "string"
}

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

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

Detailed information about the status of the schema creation operation.

Type: String

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

Type: String

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

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 aren't authorized to perform this operation.

HTTP Status Code: 401