GetGraphqlApiEnvironmentVariables

Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.

Request Syntax


GET /v1/apis/apiId/environmentVariables HTTP/1.1

The request uses the following URI parameters.

The ID of the API from which the environmental variable list will be retrieved.

Required: Yes

The request does not have a request body.


HTTP/1.1 200
Content-type: application/json

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

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

The following data is returned in JSON format by the service.

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.

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.

detail: Provides further details for the reason behind the bad request. For reason type CODE_ERROR, the detail will contain a list of code errors.
reason: Provides context for the cause of the bad request. The only supported value is CODE_ERROR.

HTTP Status Code: 400

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

HTTP Status Code: 401