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

CreateFunction

Creates a Function object.

A function is a reusable entity. Multiple functions can be used to compose the resolver logic.

Request Syntax

POST /v1/apis/apiId/functions HTTP/1.1 Content-type: application/json { "dataSourceName": "string", "description": "string", "functionVersion": "string", "name": "string", "requestMappingTemplate": "string", "responseMappingTemplate": "string" }

URI Request Parameters

The request requires the following URI parameters.

apiId

The GraphQL API ID.

Request Body

The request accepts the following data in JSON format.

dataSourceName

The Function DataSource name.

Type: String

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

Required: Yes

description

The Function description.

Type: String

Required: No

functionVersion

The version of the request mapping template. Currently the supported value is 2018-05-29.

Type: String

Required: Yes

name

The Function name. The function name does not have to be unique.

Type: String

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

Required: Yes

requestMappingTemplate

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

Type: String

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

Required: Yes

responseMappingTemplate

The Function response mapping template.

Type: String

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

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "functionConfiguration": { "dataSourceName": "string", "description": "string", "functionArn": "string", "functionId": "string", "functionVersion": "string", "name": "string", "requestMappingTemplate": "string", "responseMappingTemplate": "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.

functionConfiguration

The Function object.

Type: FunctionConfiguration object

Errors

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

ConcurrentModificationException

Another modification is in progress at this time and it 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 then 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: