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

UpdateGraphqlApi

Updates a GraphqlApi object.

Request Syntax

POST /apis/apiId HTTP/1.1 Content-type: application/json { "authenticationType": "string", "name": "string", "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string" } }

URI Request Parameters

The request requires the following URI parameters.

apiId

The API ID.

Request Body

The request accepts the following data in JSON format.

authenticationType

The new authentication type for the GraphqlApi object.

Type: String

Valid Values: API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS

Required: No

name

The new name for the GraphqlApi object.

Type: String

Required: Yes

userPoolConfig

The new Amazon Cognito User Pool configuration for the GraphqlApi object.

Type: UserPoolConfig object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "graphqlApi": { "apiId": "string", "arn": "string", "authenticationType": "string", "name": "string", "uris": { "string" : "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "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.

graphqlApi

The updated GraphqlApi object.

Type: GraphqlApi object

Errors

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

BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.

HTTP Status Code: 400

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: