AWS AppSync

(1)

AWS AppSync

API Reference

API Version 2017-07-25

(2)

AWS AppSync: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.

This document was last published on March 6, 2022.

API Version 2017-07-25 1

(13)

Actions

The following actions are supported:

• AssociateApi (p. 4)

• CreateApiCache (p. 6)

• CreateApiKey (p. 10)

• CreateDataSource (p. 13)

• CreateDomainName (p. 18)

• CreateFunction (p. 21)

• CreateGraphqlApi (p. 25)

• CreateResolver (p. 30)

• CreateType (p. 35)

• DeleteApiCache (p. 38)

• DeleteApiKey (p. 40)

• DeleteDataSource (p. 42)

• DeleteDomainName (p. 44)

• DeleteFunction (p. 46)

• DeleteGraphqlApi (p. 48)

• DeleteResolver (p. 50)

• DeleteType (p. 52)

• DisassociateApi (p. 54)

• FlushApiCache (p. 56)

• GetApiAssociation (p. 58)

• GetApiCache (p. 60)

• GetDataSource (p. 62)

• GetDomainName (p. 65)

• GetFunction (p. 67)

• GetGraphqlApi (p. 69)

• GetIntrospectionSchema (p. 72)

• GetResolver (p. 74)

• GetSchemaCreationStatus (p. 77)

• GetType (p. 79)

• ListApiKeys (p. 82)

• ListDataSources (p. 85)

• ListDomainNames (p. 88)

• ListFunctions (p. 90)

• ListGraphqlApis (p. 93)

• ListResolvers (p. 96)

• ListResolversByFunction (p. 99)

• ListTagsForResource (p. 102)

• ListTypes (p. 105)

• StartSchemaCreation (p. 108)

• TagResource (p. 111)

(14)

• UntagResource (p. 114)

• UpdateApiCache (p. 116)

• UpdateApiKey (p. 119)

• UpdateDataSource (p. 122)

• UpdateDomainName (p. 127)

• UpdateFunction (p. 130)

• UpdateGraphqlApi (p. 134)

• UpdateResolver (p. 139)

• UpdateType (p. 143)

(15)

AssociateApi

Maps an endpoint to your custom domain.

Request Syntax

POST /v1/domainnames/domainName/apiassociation HTTP/1.1 Content-type: application/json

{

"apiId": "string"

}

URI Request Parameters

The request uses the following URI parameters.

domainName (p. 4) The domain name.

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

Pattern: ^(\*[\w\d-]*\.)?([\w\d-]+\.)+[\w\d-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

apiId (p. 4)

The API ID.

Type: String Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json { "apiAssociation": {

"apiId": "string",

"associationStatus": "string", "deploymentDetail": "string", "domainName": "string"

}}

(16)

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.

apiAssociation (p. 4)

The ApiAssociation object.

Type: ApiAssociation (p. 148) object

Errors

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

AccessDeniedException

You don't have access to perform this operation on this resource.

HTTP Status Code: 403 BadRequestException

The request is not well formed. For example, a value is invalid or a required ﬁeld is missing. Check the ﬁeld 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 speciﬁed in the request was not found. Check the resource, and then try again.

HTTP Status Code: 404

CreateApiCache

Creates a cache for the GraphQL API.

Request Syntax

POST /v1/apis/apiId/ApiCaches HTTP/1.1 Content-type: application/json

{ "apiCachingBehavior": "string", "atRestEncryptionEnabled": boolean, "transitEncryptionEnabled": boolean, "ttl": number,

"type": "string"

}

URI Request Parameters

apiId (p. 6)

The GraphQL API ID.

Required: Yes

Request Body

apiCachingBehavior (p. 6) Caching behavior.

• FULL_REQUEST_CACHING: All requests are fully cached.

• PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

Type: String

Valid Values: FULL_REQUEST_CACHING | PER_RESOLVER_CACHING Required: Yes

atRestEncryptionEnabled (p. 6)

At-rest encryption ﬂag for cache. You cannot update this setting after creation.

Type: Boolean Required: No

transitEncryptionEnabled (p. 6)

Transit encryption ﬂag when connecting to cache. You cannot update this setting after creation.

Type: Boolean

(18)

Required: No ttl (p. 6)

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

Type: Long Required: Yes type (p. 6)

The cache instance type. Valid values are

• SMALL

• MEDIUM

• LARGE

• XLARGE

• LARGE_2X

• LARGE_4X

• LARGE_8X (not available in all regions)

• LARGE_12X

Historically, instance types were identiﬁed by an EC2-style value. As of July 2020, this is deprecated, and the generic identiﬁers above should be used.

The following legacy instance types are available, but their use is discouraged:

• T2_SMALL: A t2.small instance type.

• T2_MEDIUM: A t2.medium instance type.

• R4_LARGE: A r4.large instance type.

• R4_XLARGE: A r4.xlarge instance type.

• R4_2XLARGE: A r4.2xlarge instance type.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json { "apiCache": {

"apiCachingBehavior": "string", "atRestEncryptionEnabled": boolean, "status": "string",

"transitEncryptionEnabled": boolean, "ttl": number,

(19)

Response Elements

"type": "string"

}}

Response Elements

apiCache (p. 7)

The ApiCache object.

Type: ApiCache (p. 149) object

Errors

BadRequestException

HTTP Status Code: 400 ConcurrentModiﬁcationException

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

HTTP Status Code: 404 UnauthorizedException

You aren't authorized to perform this operation.

CreateApiKey

Creates a unique key that you can distribute to clients who invoke your API.

Request Syntax

POST /v1/apis/apiId/apikeys HTTP/1.1 Content-type: application/json { "description": "string", "expires": number }

URI Request Parameters

apiId (p. 10)

The ID for your GraphQL API.

Required: Yes

Request Body

description (p. 10)

A description of the purpose of the API key.

Type: String Required: No expires (p. 10)

From the creation time, the time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see ApiKey (p. 151).

Type: Long Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "apiKey": {

"deletes": number, "description": "string",

(22)

"expires": number, "id": "string"

}}

Response Elements

apiKey (p. 10) The API key.

Type: ApiKey (p. 151) object

Errors

ApiKeyLimitExceededException

The API key exceeded a limit. Try your request again.

ApiKeyValidityOutOfBoundsException

The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey) or from update (for UpdateApiKey).

HTTP Status Code: 500 LimitExceededException

The request exceeded a limit. Try your request again.

(23)

CreateDataSource

Creates a DataSource object.

Request Syntax

POST /v1/apis/apiId/datasources HTTP/1.1 Content-type: application/json

{ "description": "string", "dynamodbConfig": { "awsRegion": "string", "deltaSyncConfig": { "baseTableTTL": number,

"deltaSyncTableName": "string", "deltaSyncTableTTL": number },

"tableName": "string",

"useCallerCredentials": boolean, "versioned": boolean

},

"elasticsearchConfig": { "awsRegion": "string", "endpoint": "string"

},

"httpConfig": {

"authorizationConfig": {

"authorizationType": "string", "awsIamConfig": {

"signingRegion": "string", "signingServiceName": "string"

} },

"endpoint": "string"

},

"lambdaConfig": {

"lambdaFunctionArn": "string"

},

"name": "string",

"openSearchServiceConfig": { "awsRegion": "string", "endpoint": "string"

},

"relationalDatabaseConfig": { "rdsHttpEndpointConfig": { "awsRegion": "string",

"awsSecretStoreArn": "string", "databaseName": "string", "dbClusterIdentifier": "string", "schema": "string"

},

"relationalDatabaseSourceType": "string"

},

"serviceRoleArn": "string", "type": "string"

}

URI Request Parameters

(25)

Request Body

apiId (p. 13)

The API ID for the GraphQL API for the DataSource.

Required: Yes

Request Body

description (p. 13)

A description of the DataSource.

Type: String Required: No dynamodbConﬁg (p. 13)

Amazon DynamoDB settings.

Type: DynamodbDataSourceConﬁg (p. 162) object Required: No

elasticsearchConﬁg (p. 13)

Amazon OpenSearch Service settings.

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This conﬁguration is deprecated. For new data sources, use

CreateDataSource:openSearchServiceConﬁg (p. 15) to create an OpenSearch data source.

Type: ElasticsearchDataSourceConﬁg (p. 163) object Required: No

httpConﬁg (p. 13)

HTTP endpoint settings.

Type: HttpDataSourceConﬁg (p. 169) object Required: No

lambdaConﬁg (p. 13) AWS Lambda settings.

Type: LambdaDataSourceConﬁg (p. 172) object Required: No

name (p. 13)

A user-supplied name for the DataSource.

Type: String

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

(26)

Required: Yes

openSearchServiceConﬁg (p. 13)

Amazon OpenSearch Service settings.

Type: OpenSearchServiceDataSourceConﬁg (p. 175) object Required: No

relationalDatabaseConﬁg (p. 13) Relational database settings.

Type: RelationalDatabaseDataSourceConﬁg (p. 178) object Required: No

serviceRoleArn (p. 13)

The AWS Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.

Type: String Required: No type (p. 13)

The type of the DataSource.

Type: String

Valid Values: AWS_LAMBDA | AMAZON_DYNAMODB | AMAZON_ELASTICSEARCH | NONE | HTTP

| RELATIONAL_DATABASE | AMAZON_OPENSEARCH_SERVICE Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json { "dataSource": {

"dataSourceArn": "string", "description": "string", "dynamodbConfig": { "awsRegion": "string", "deltaSyncConfig": { "baseTableTTL": number,

"deltaSyncTableName": "string", "deltaSyncTableTTL": number },

"tableName": "string",

"useCallerCredentials": boolean, "versioned": boolean

},

"elasticsearchConfig": { "awsRegion": "string", "endpoint": "string"

},

"httpConfig": {

(27)

Response Elements

"authorizationConfig": {

"authorizationType": "string", "awsIamConfig": {

"signingRegion": "string", "signingServiceName": "string"

} },

"endpoint": "string"

},

"lambdaConfig": {

"lambdaFunctionArn": "string"

},

"name": "string",

"openSearchServiceConfig": { "awsRegion": "string", "endpoint": "string"

},

"relationalDatabaseConfig": { "rdsHttpEndpointConfig": { "awsRegion": "string",

"awsSecretStoreArn": "string", "databaseName": "string", "dbClusterIdentifier": "string", "schema": "string"

},

"relationalDatabaseSourceType": "string"

},

"serviceRoleArn": "string", "type": "string"

}}

Response Elements

dataSource (p. 15)

The DataSource object.

Type: DataSource (p. 157) object

Errors

(28)

InternalFailureException

CreateDomainName

Creates a custom DomainName object.

Request Syntax

POST /v1/domainnames HTTP/1.1 Content-type: application/json {

"certificateArn": "string", "description": "string", "domainName": "string"

}

URI Request Parameters

The request does not use any URI parameters.

Request Body

certiﬁcateArn (p. 18)

The Amazon Resource Name (ARN) of the certificate. This can be an AWS Certificate Manager (ACM) certificate or an AWS Identity and Access Management (IAM) server certificate.

Type: String

Pattern: ^arn:[a-z-]*:(acm|iam):[a-z0-9-]*:\d{12}:(certificate|server- certificate)/[0-9A-Za-z_/-]*$

Required: Yes description (p. 18)

A description of the DomainName.

Type: String

Pattern: ^.*$

Required: No domainName (p. 18)

The domain name.

Type: String

Pattern: ^(\*[\w\d-]*\.)?([\w\d-]+\.)+[\w\d-]+$

(30)

Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json { "domainNameConfig": {

"appsyncDomainName": "string", "certificateArn": "string", "description": "string", "domainName": "string", "hostedZoneId": "string"

}}

Response Elements

domainNameConﬁg (p. 19)

The conﬁguration for the DomainName.

Type: DomainNameConﬁg (p. 160) object

Errors

CreateFunction

Creates a Function object.

A function is a reusable entity. You can use multiple functions 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", "maxBatchSize": number, "name": "string",

"requestMappingTemplate": "string", "responseMappingTemplate": "string", "syncConfig": {

"conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string"

} }}

URI Request Parameters

apiId (p. 21)

The GraphQL API ID.

Required: Yes

Request Body

dataSourceName (p. 21)

The Function DataSource name.

Type: String

Required: Yes description (p. 21)

The Function description.

(33)

Request Body

Type: String Required: No functionVersion (p. 21)

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

Type: String Required: Yes maxBatchSize (p. 21)

The maximum batching size for a resolver.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2000.

Required: No name (p. 21)

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

Type: String

Required: Yes

requestMappingTemplate (p. 21)

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

Type: String

Pattern: ^.*$

Required: No

responseMappingTemplate (p. 21)

The Function response mapping template.

Type: String

Pattern: ^.*$

Required: No syncConﬁg (p. 21)

Describes a Sync conﬁguration for a resolver.

Speciﬁes which Conﬂict Detection strategy and Resolution strategy to use when the resolver is invoked.

(34)

Type: SyncConﬁg (p. 182) object Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "functionConfiguration": { "dataSourceName": "string", "description": "string", "functionArn": "string", "functionId": "string", "functionVersion": "string", "maxBatchSize": number, "name": "string",

} } }}

Response Elements

functionConﬁguration (p. 23) The Function object.

Type: FunctionConﬁguration (p. 164) object

Errors

ConcurrentModiﬁcationException

(35)

CreateGraphqlApi

Creates a GraphqlApi object.

Request Syntax

POST /v1/apis HTTP/1.1

Content-type: application/json {

"additionalAuthenticationProviders": [ {

"authenticationType": "string", "lambdaAuthorizerConfig": {

"authorizerResultTtlInSeconds": number, "authorizerUri": "string",

"identityValidationExpression": "string"

},

"openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string"

},

"userPoolConfig": {

"appIdClientRegex": "string", "awsRegion": "string", "userPoolId": "string"

} } ],

},

"logConfig": {

"cloudWatchLogsRoleArn": "string", "excludeVerboseContent": boolean, "fieldLogLevel": "string"

},

"name": "string",

},

"tags": {

"string" : "string"

},

"userPoolConfig": {

"appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string"

},

"xrayEnabled": boolean }

(37)

URI Request Parameters

The request does not use any URI parameters.

Request Body

additionalAuthenticationProviders (p. 25)

A list of additional authentication providers for the GraphqlApi API.

Type: Array of AdditionalAuthenticationProvider (p. 147) objects Required: No

authenticationType (p. 25)

The authentication type: API key, AWS Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or AWS Lambda.

Type: String

Valid Values: API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT | AWS_LAMBDA

Required: Yes

lambdaAuthorizerConﬁg (p. 25)

Conﬁguration for AWS Lambda function authorization.

Type: LambdaAuthorizerConﬁg (p. 170) object Required: No

logConﬁg (p. 25)

The Amazon CloudWatch Logs conﬁguration.

Type: LogConﬁg (p. 173) object Required: No

name (p. 25)

A user-supplied name for the GraphqlApi.

Type: String Required: Yes

openIDConnectConﬁg (p. 25) The OIDC conﬁguration.

Type: OpenIDConnectConﬁg (p. 174) object Required: No

tags (p. 25)

A TagMap object.

(38)

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[ a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Value Pattern: ^[\s\w+-=\.:/@]*$

Required: No userPoolConﬁg (p. 25)

The Amazon Cognito user pool conﬁguration.

Type: UserPoolConﬁg (p. 185) object Required: No

xrayEnabled (p. 25)

A ﬂag indicating whether to use AWS X-Ray tracing for the GraphqlApi.

Type: Boolean Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "graphqlApi": {

"additionalAuthenticationProviders": [ {

},

"userPoolConfig": {

"appIdClientRegex": "string", "awsRegion": "string", "userPoolId": "string"

} } ],

"apiId": "string", "arn": "string",

(39)

Response Elements

},

"logConfig": {

"cloudWatchLogsRoleArn": "string", "excludeVerboseContent": boolean, "fieldLogLevel": "string"

},

"name": "string",

},

"tags": {

"string" : "string"

},

"uris": {

"string" : "string"

},

"userPoolConfig": {

"appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string"

},

"wafWebAclArn": "string", "xrayEnabled": boolean }

}

Response Elements

graphqlApi (p. 27) The GraphqlApi.

Type: GraphqlApi (p. 166) object

Errors

ApiLimitExceededException

The GraphQL API exceeded a limit. Try your request again.

(40)

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 /v1/apis/apiId/types/typeName/resolvers HTTP/1.1 Content-type: application/json

{ "cachingConfig": {

"cachingKeys": [ "string" ], "ttl": number

},

"dataSourceName": "string", "fieldName": "string", "kind": "string", "maxBatchSize": number, "pipelineConfig": {

"functions": [ "string" ] },

} }}

URI Request Parameters

apiId (p. 30)

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

Required: Yes typeName (p. 30)

The name of the Type.

Required: Yes

Request Body

(42)

cachingConﬁg (p. 30)

The caching conﬁguration for the resolver.

Type: CachingConﬁg (p. 155) object Required: No

dataSourceName (p. 30)

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

Type: String

Required: No ﬁeldName (p. 30)

The name of the ﬁeld to attach the resolver to.

Type: String

Required: Yes kind (p. 30)

The resolver type.

• 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.

• PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

Type: String

Valid Values: UNIT | PIPELINE Required: No

maxBatchSize (p. 30)

The maximum batching size for a resolver.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2000.

Required: No pipelineConﬁg (p. 30)

The PipelineConfig.

Type: PipelineConﬁg (p. 176) object Required: No

(43)

Response Syntax

requestMappingTemplate (p. 30)

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 AWS Lambda data source. For all other data sources, VTL request and response mapping templates are required.

Type: String

Pattern: ^.*$

Required: No

responseMappingTemplate (p. 30)

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

Type: String

Pattern: ^.*$

Required: No syncConﬁg (p. 30)

The SyncConfig for a resolver attached to a versioned data source.

Type: SyncConﬁg (p. 182) object Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"resolver": {

"cachingConfig": {

"cachingKeys": [ "string" ], "ttl": number

},

"dataSourceName": "string", "fieldName": "string", "kind": "string", "maxBatchSize": number, "pipelineConfig": {

"functions": [ "string" ] },

"requestMappingTemplate": "string", "resolverArn": "string",

"responseMappingTemplate": "string", "syncConfig": {

"conflictDetection": "string",

(44)

"conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string"

} },

"typeName": "string"

}}

Response Elements

resolver (p. 32)

The Resolver object.

Type: Resolver (p. 179) object

Errors

CreateType

Creates a Type object.

Request Syntax

POST /v1/apis/apiId/types HTTP/1.1 Content-type: application/json {

"definition": "string", "format": "string"

}

URI Request Parameters

apiId (p. 35) The API ID.

Required: Yes

Request Body

deﬁnition (p. 35)

The type deﬁnition, in GraphQL Schema Deﬁnition Language (SDL) format.

For more information, see the GraphQL SDL documentation.

Type: String Required: Yes format (p. 35)

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": {

(47)

Response Elements

"arn": "string", "definition": "string", "description": "string", "format": "string", "name": "string"

} }

Response Elements

type (p. 35)

The Type object.

Type: Type (p. 183) object

Errors

DeleteApiCache

Deletes an ApiCache object.

Request Syntax

DELETE /v1/apis/apiId/ApiCaches HTTP/1.1

URI Request Parameters

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

(50)

DeleteApiKey

Deletes an API key.

Request Syntax

DELETE /v1/apis/apiId/apikeys/id HTTP/1.1

URI Request Parameters

Required: Yes id (p. 40)

The ID for the API key.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Response Elements

Errors

(52)

DeleteDataSource

Deletes a DataSource object.

Request Syntax

DELETE /v1/apis/apiId/datasources/name HTTP/1.1

URI Request Parameters

Required: Yes name (p. 42)

The name of the data source.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Response Elements

Errors

(54)

DeleteDomainName

Deletes a custom DomainName object.

Request Syntax

DELETE /v1/domainnames/domainName HTTP/1.1

URI Request Parameters

domainName (p. 44) The domain name.

Pattern: ^(\*[\w\d-]*\.)?([\w\d-]+\.)+[\w\d-]+$

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Response Elements

Errors

(56)

DeleteFunction

Deletes a Function.

Request Syntax

DELETE /v1/apis/apiId/functions/functionId HTTP/1.1

URI Request Parameters

apiId (p. 46)

The GraphQL API ID.

Required: Yes functionId (p. 46)

The Function ID.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Response Elements

Errors

(58)

AWS AppSync

AWS AppSync

API Reference

API Version 2017-07-25

AWS AppSync: API Reference

Table of Contents

Welcome

Actions

AssociateApi

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateApiCache

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateApiKey

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateDataSource

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateDomainName

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateFunction

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateGraphqlApi

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateResolver

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateType

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also