CreateType - Amazon AppSync
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Creates a Type object.

Request Syntax

POST /apis/apiId/types HTTP/1.1 Content-type: application/json { "definition": "string", "format": "string" }

URI Request Parameters

The request uses the following URI parameters.



Required: Yes

Request Body

The request accepts the following data in JSON format.


The type definition, in GraphQL Schema Definition Language (SDL) format.

For more information, see the GraphQL SDL documentation.

Type: String

Required: Yes


The type format: SDL or JSON.

Type: String

Valid Values: SDL | JSON

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "type": { "arn": "string", "definition": "string", "description": "string", "format": "string", "name": "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.


The Type object.

Type: Type object


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


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


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

HTTP Status Code: 409


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

HTTP Status Code: 500


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

HTTP Status Code: 404


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 Amazon SDKs, see the following: