Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutGraphqlApiEnvironmentVariables

Creates a list of environmental variables in an API by its ID value.

When creating an environmental variable, it must follow the constraints below:

Both JavaScript and VTL templates support environmental variables.
Environmental variables are not evaluated before function invocation.
Environmental variables only support string values.
Any defined value in an environmental variable is considered a string literal and not expanded.
Variable evaluations should ideally be performed in the function code.

When creating an environmental variable key-value pair, it must follow the additional constraints below:

Keys must begin with a letter.
Keys must be at least two characters long.
Keys can only contain letters, numbers, and the underscore character (_).
Values can be up to 512 characters long.
You can configure up to 50 key-value pairs in a GraphQL API.

You can create a list of environmental variables by adding it to the environmentVariables payload as a list in the format {"key1":"value1","key2":"value2", …}. Note that each call of the PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.

Request Syntax


PUT /apis/apiId/environmentVariables HTTP/1.1
Content-type: application/json

{
   "environmentVariables": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

apiId

The ID of the API to which the environmental variable list will be written.

Required: Yes

Request Body

The request accepts the following data in JSON format.

environmentVariables

The list of environmental variables to add to the API.

When creating an environmental variable key-value pair, it must follow the additional constraints below:

Keys must begin with a letter.
Keys must be at least two characters long.
Keys can only contain letters, numbers, and the underscore character (_).
Values can be up to 512 characters long.
You can configure up to 50 key-value pairs in a GraphQL API.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 2. Maximum length of 64.

Key Pattern: ^[A-Za-z]+\w*$

Value Length Constraints: Minimum length of 0. Maximum length of 512.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "environmentVariables": { 
      "string" : "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.

environmentVariables

The payload containing each environmental variable in the "key" : "value" format.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 2. Maximum length of 64.

Key Pattern: ^[A-Za-z]+\w*$

Value Length Constraints: Minimum length of 0. Maximum length of 512.

Errors

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

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 field is missing. Check the field values, and then try again.

HTTP Status Code: 400

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 Amazon 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 aren't authorized to perform this operation.

HTTP Status Code: 401