POST

/v1/apis/{apiId}/types/{typeName}/resolvers

http://appsync.{region}.amazonaws.com/v1/apis/{apiId}/types/{typeName}/resolvers

Creates a <code>Resolver</code> object. A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL.

Access Token Required: API Key

Path Parameters

apiIdstringrequired

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

typeNamestringrequired

The name of the <code>Type</code>.

Body Params

codestring

The <code>resolver</code> code that contains the request and response functions. When code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.

kindstring

The resolver type. <ul> <li> UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source. </li> <li> PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of <code>Function</code> objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources. </li> </ul>

runtimeobject

Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

fieldNamestringrequired

The name of the field to attach the resolver to.

syncConfigobject

Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

maxBatchSizeinteger

The maximum batching size for a resolver.

cachingConfigobject

The caching configuration for a resolver that has caching activated.

dataSourceNamestring

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

pipelineConfigobject

The pipeline configuration for a resolver of kind <code>PIPELINE</code>.

requestMappingTemplatestring

The mapping template to use 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). VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

responseMappingTemplatestring

The mapping template to use for responses from the data source.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://appsync.{region}.amazonaws.com/v1/apis/{apiId}/types/{typeName}/resolvers' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request POST \ 2 --url 'http://appsync.{region}.amazonaws.com/v1/apis/{apiId}/types/{typeName}/resolvers' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'