ListApis
Lists the APIs in your AWS AppSync account.
ListApis returns only the high level API details. For more detailed
information about an API, use GetApi.
Request Syntax
GET /v2/apis?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results that you want the request to return.
Valid Range: Minimum value of 0. Maximum value of 25.
- nextToken
-
An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern:
[\S]+
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"apis": [
{
"apiArn": "string",
"apiId": "string",
"created": number,
"dns": {
"string" : "string"
},
"eventConfig": {
"authProviders": [
{
"authType": "string",
"cognitoConfig": {
"appIdClientRegex": "string",
"awsRegion": "string",
"userPoolId": "string"
},
"lambdaAuthorizerConfig": {
"authorizerResultTtlInSeconds": number,
"authorizerUri": "string",
"identityValidationExpression": "string"
},
"openIDConnectConfig": {
"authTTL": number,
"clientId": "string",
"iatTTL": number,
"issuer": "string"
}
}
],
"connectionAuthModes": [
{
"authType": "string"
}
],
"defaultPublishAuthModes": [
{
"authType": "string"
}
],
"defaultSubscribeAuthModes": [
{
"authType": "string"
}
],
"logConfig": {
"cloudWatchLogsRoleArn": "string",
"logLevel": "string"
}
},
"name": "string",
"ownerContact": "string",
"tags": {
"string" : "string"
},
"wafWebAclArn": "string",
"xrayEnabled": boolean
}
],
"nextToken": "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.
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 then try again.
HTTP Status Code: 400
- InternalFailureException
-
An internal AWS AppSync error occurred. Try your request again.
HTTP Status Code: 500
- 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:
