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
URI Request Parameters
The request uses the following URI parameters.
- apiId
-
The ID of the API from which the environmental variable list will be retrieved.
Required: Yes
Request Body
The request does not have a request body.
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: