ListGraphqlApis
Lists your GraphQL APIs.
Request Syntax
GET /v1/apis?apiType=apiType&maxResults=maxResults&nextToken=nextToken&owner=owner HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- apiType
-
The value that indicates whether the GraphQL API is a standard API (
GRAPHQL) or merged API (MERGED).Valid Values:
GRAPHQL | MERGED - 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]+ - owner
-
The account owner of the GraphQL API.
Valid Values:
CURRENT_ACCOUNT | OTHER_ACCOUNTS
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"graphqlApis": [
{
"additionalAuthenticationProviders": [
{
"authenticationType": "string",
"lambdaAuthorizerConfig": {
"authorizerResultTtlInSeconds": number,
"authorizerUri": "string",
"identityValidationExpression": "string"
},
"openIDConnectConfig": {
"authTTL": number,
"clientId": "string",
"iatTTL": number,
"issuer": "string"
},
"userPoolConfig": {
"appIdClientRegex": "string",
"awsRegion": "string",
"userPoolId": "string"
}
}
],
"apiId": "string",
"apiType": "string",
"arn": "string",
"authenticationType": "string",
"dns": {
"string" : "string"
},
"enhancedMetricsConfig": {
"dataSourceLevelMetricsBehavior": "string",
"operationLevelMetricsConfig": "string",
"resolverLevelMetricsBehavior": "string"
},
"introspectionConfig": "string",
"lambdaAuthorizerConfig": {
"authorizerResultTtlInSeconds": number,
"authorizerUri": "string",
"identityValidationExpression": "string"
},
"logConfig": {
"cloudWatchLogsRoleArn": "string",
"excludeVerboseContent": boolean,
"fieldLogLevel": "string"
},
"mergedApiExecutionRoleArn": "string",
"name": "string",
"openIDConnectConfig": {
"authTTL": number,
"clientId": "string",
"iatTTL": number,
"issuer": "string"
},
"owner": "string",
"ownerContact": "string",
"queryDepthLimit": number,
"resolverCountLimit": number,
"tags": {
"string" : "string"
},
"uris": {
"string" : "string"
},
"userPoolConfig": {
"appIdClientRegex": "string",
"awsRegion": "string",
"defaultAction": "string",
"userPoolId": "string"
},
"visibility": "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.
- graphqlApis
-
The
GraphqlApiobjects.Type: Array of GraphqlApi objects
- nextToken
-
An identifier to pass in the next request to this operation to return the next set of items in the list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern:
[\S]+
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:
