import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient"; import type { GetGraphqlApiRequest, GetGraphqlApiResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetGraphqlApiCommand}. */ export interface GetGraphqlApiCommandInput extends GetGraphqlApiRequest { } /** * @public * * The output of {@link GetGraphqlApiCommand}. */ export interface GetGraphqlApiCommandOutput extends GetGraphqlApiResponse, __MetadataBearer { } declare const GetGraphqlApiCommand_base: { new (input: GetGraphqlApiCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetGraphqlApiCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Retrieves a GraphqlApi object.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { AppSyncClient, GetGraphqlApiCommand } from "@aws-sdk/client-appsync"; // ES Modules import * // const { AppSyncClient, GetGraphqlApiCommand } = require("@aws-sdk/client-appsync"); // CommonJS import * // import type { AppSyncClientConfig } from "@aws-sdk/client-appsync"; * const config = {}; // type is AppSyncClientConfig * const client = new AppSyncClient(config); * const input = { // GetGraphqlApiRequest * apiId: "STRING_VALUE", // required * }; * const command = new GetGraphqlApiCommand(input); * const response = await client.send(command); * // { // GetGraphqlApiResponse * // graphqlApi: { // 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 * // "": "STRING_VALUE", * // }, * // tags: { // TagMap * // "": "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: { * // "": "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 * // }, * // }, * // }; * * ``` * * @param GetGraphqlApiCommandInput - {@link GetGraphqlApiCommandInput} * @returns {@link GetGraphqlApiCommandOutput} * @see {@link GetGraphqlApiCommandInput} for command's `input` shape. * @see {@link GetGraphqlApiCommandOutput} for command's `response` shape. * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You don't have access to perform this operation on this resource.

* * @throws {@link BadRequestException} (client fault) *

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.

* * @throws {@link InternalFailureException} (server fault) *

An internal AppSync error occurred. Try your request again.

* * @throws {@link NotFoundException} (client fault) *

The resource specified in the request was not found. Check the resource, and then try * again.

* * @throws {@link UnauthorizedException} (client fault) *

You aren't authorized to perform this operation.

* * @throws {@link AppSyncServiceException} *

Base exception class for all service exceptions from AppSync service.

* * * @public */ export declare class GetGraphqlApiCommand extends GetGraphqlApiCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetGraphqlApiRequest; output: GetGraphqlApiResponse; }; sdk: { input: GetGraphqlApiCommandInput; output: GetGraphqlApiCommandOutput; }; }; }