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

CreateResolver

Creates a Resolver object.

A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.

Request Syntax

POST /apis/apiId/types/typeName/resolvers HTTP/1.1 Content-type: application/json { "dataSourceName": "string", "fieldName": "string", "requestMappingTemplate": "string", "responseMappingTemplate": "string" }

URI Request Parameters

The request requires the following URI parameters.

apiId

The ID for the GraphQL API for which the resolver is being created.

typeName

The name of the Type.

Pattern: [_A-Za-z][_0-9A-Za-z]*

Request Body

The request accepts the following data in JSON format.

dataSourceName

The name of the data source for which the resolver is being created.

Type: String

Pattern: [_A-Za-z][_0-9A-Za-z]*

Required: Yes

fieldName

The name of the field to attach the resolver to.

Type: String

Pattern: [_A-Za-z][_0-9A-Za-z]*

Required: Yes

requestMappingTemplate

The mapping template to be used for requests.

A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

Type: String

Length Constraints: Minimum length of 0. Maximum length of 65536.

Required: Yes

responseMappingTemplate

The mapping template to be used for responses from the data source.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 65536.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "resolver": { "dataSourceName": "string", "fieldName": "string", "requestMappingTemplate": "string", "resolverArn": "string", "responseMappingTemplate": "string", "typeName": "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.

resolver

The Resolver object.

Type: Resolver object

Errors

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

ConcurrentModificationException

Another modification is being made. That modification 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 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: