ListGraphqlApisCommand

Suggest an Edit

Lists your GraphQL APIs.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppSyncClient, ListGraphqlApisCommand } from "@aws-sdk/client-appsync"; // ES Modules import
// const { AppSyncClient, ListGraphqlApisCommand } = require("@aws-sdk/client-appsync"); // CommonJS import
const client = new AppSyncClient(config);
const input = { // ListGraphqlApisRequest
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  apiType: "GRAPHQL" || "MERGED",
  owner: "CURRENT_ACCOUNT" || "OTHER_ACCOUNTS",
};
const command = new ListGraphqlApisCommand(input);
const response = await client.send(command);
// { // ListGraphqlApisResponse
//   graphqlApis: [ // GraphqlApis
//     { // GraphqlApi
//       name: "STRING_VALUE",
//       apiId: "STRING_VALUE",
//       authenticationType: "API_KEY" || "AWS_IAM" || "AMAZON_COGNITO_USER_POOLS" || "OPENID_CONNECT" || "AWS_LAMBDA",
//       logConfig: { // LogConfig
//         fieldLogLevel: "NONE" || "ERROR" || "ALL" || "INFO" || "DEBUG", // required
//         cloudWatchLogsRoleArn: "STRING_VALUE", // required
//         excludeVerboseContent: true || false,
//       },
//       userPoolConfig: { // UserPoolConfig
//         userPoolId: "STRING_VALUE", // required
//         awsRegion: "STRING_VALUE", // required
//         defaultAction: "ALLOW" || "DENY", // required
//         appIdClientRegex: "STRING_VALUE",
//       },
//       openIDConnectConfig: { // OpenIDConnectConfig
//         issuer: "STRING_VALUE", // required
//         clientId: "STRING_VALUE",
//         iatTTL: Number("long"),
//         authTTL: Number("long"),
//       },
//       arn: "STRING_VALUE",
//       uris: { // MapOfStringToString
//         "<keys>": "STRING_VALUE",
//       },
//       tags: { // TagMap
//         "<keys>": "STRING_VALUE",
//       },
//       additionalAuthenticationProviders: [ // AdditionalAuthenticationProviders
//         { // AdditionalAuthenticationProvider
//           authenticationType: "API_KEY" || "AWS_IAM" || "AMAZON_COGNITO_USER_POOLS" || "OPENID_CONNECT" || "AWS_LAMBDA",
//           openIDConnectConfig: {
//             issuer: "STRING_VALUE", // required
//             clientId: "STRING_VALUE",
//             iatTTL: Number("long"),
//             authTTL: Number("long"),
//           },
//           userPoolConfig: { // CognitoUserPoolConfig
//             userPoolId: "STRING_VALUE", // required
//             awsRegion: "STRING_VALUE", // required
//             appIdClientRegex: "STRING_VALUE",
//           },
//           lambdaAuthorizerConfig: { // LambdaAuthorizerConfig
//             authorizerResultTtlInSeconds: Number("int"),
//             authorizerUri: "STRING_VALUE", // required
//             identityValidationExpression: "STRING_VALUE",
//           },
//         },
//       ],
//       xrayEnabled: true || false,
//       wafWebAclArn: "STRING_VALUE",
//       lambdaAuthorizerConfig: {
//         authorizerResultTtlInSeconds: Number("int"),
//         authorizerUri: "STRING_VALUE", // required
//         identityValidationExpression: "STRING_VALUE",
//       },
//       dns: {
//         "<keys>": "STRING_VALUE",
//       },
//       visibility: "GLOBAL" || "PRIVATE",
//       apiType: "GRAPHQL" || "MERGED",
//       mergedApiExecutionRoleArn: "STRING_VALUE",
//       owner: "STRING_VALUE",
//       ownerContact: "STRING_VALUE",
//       introspectionConfig: "ENABLED" || "DISABLED",
//       queryDepthLimit: Number("int"),
//       resolverCountLimit: Number("int"),
//       enhancedMetricsConfig: { // EnhancedMetricsConfig
//         resolverLevelMetricsBehavior: "FULL_REQUEST_RESOLVER_METRICS" || "PER_RESOLVER_METRICS", // required
//         dataSourceLevelMetricsBehavior: "FULL_REQUEST_DATA_SOURCE_METRICS" || "PER_DATA_SOURCE_METRICS", // required
//         operationLevelMetricsConfig: "ENABLED" || "DISABLED", // required
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListGraphqlApisCommand Input

See ListGraphqlApisCommandInput for more details

Parameter
Type
Description
apiType
GraphQLApiType | undefined

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

maxResults
number | undefined

The maximum number of results that you want the request to return.

nextToken
string | undefined

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.

owner
Ownership | undefined

The account owner of the GraphQL API.

ListGraphqlApisCommand Output

See ListGraphqlApisCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
graphqlApis
GraphqlApi[] | undefined

The GraphqlApi objects.

nextToken
string | undefined

An identifier to pass in the next request to this operation to return the next set of items in the list.

Throws

Name
Fault
Details
BadRequestException
client

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.

InternalFailureException
server

An internal AppSync error occurred. Try your request again.

UnauthorizedException
client

You aren't authorized to perform this operation.

AppSyncServiceException
Base exception class for all service exceptions from AppSync service.