GetSchemaCreationStatus - AWS AppSync

GetSchemaCreationStatus

Retrieves the current status of a schema creation operation.

Request Syntax

GET /apis/apiId/schemacreation HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

apiId

The API ID.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "details": "string", "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.

details

Detailed information about the status of the schema creation operation.

Type: String

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.

Type: String

Valid Values: PROCESSING | ACTIVE | DELETING | FAILED | SUCCESS | NOT_APPLICABLE

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

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

See Also

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