We are excited to announce our new API Documentation.
Protected
Deletes a GraphqlApi object.
GraphqlApi
Use a bare-bones client and the command you need to make an API call.
import { AppSyncClient, DeleteGraphqlApiCommand } from "@aws-sdk/client-appsync"; // ES Modules import// const { AppSyncClient, DeleteGraphqlApiCommand } = require("@aws-sdk/client-appsync"); // CommonJS importconst client = new AppSyncClient(config);const input = { // DeleteGraphqlApiRequest apiId: "STRING_VALUE", // required};const command = new DeleteGraphqlApiCommand(input);const response = await client.send(command);// {};
DeleteGraphqlApiCommandInput
DeleteGraphqlApiCommandOutput
input
response
config
AccessDeniedException (client fault)
You don't have access to perform this operation on this resource.
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.
ConcurrentModificationException (client fault)
Another modification is in progress at this time and it must complete before you can make your change.
InternalFailureException (server fault)
An internal AppSync error occurred. Try your request again.
NotFoundException (client fault)
The resource specified in the request was not found. Check the resource, and then try again.
UnauthorizedException (client fault)
You aren't authorized to perform this operation.
AppSyncServiceException
Base exception class for all service exceptions from AppSync service.
Readonly
Static
Deletes a
GraphqlApi
object.Example
Use a bare-bones client and the command you need to make an API call.
Param
DeleteGraphqlApiCommandInput
Returns
DeleteGraphqlApiCommandOutput
See
input
shape.response
shape.config
shape.Throws
AccessDeniedException (client fault)
You don't have access to perform this operation on this resource.
Throws
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
ConcurrentModificationException (client fault)
Another modification is in progress at this time and it must complete before you can make your change.
Throws
InternalFailureException (server fault)
An internal AppSync error occurred. Try your request again.
Throws
NotFoundException (client fault)
The resource specified in the request was not found. Check the resource, and then try again.
Throws
UnauthorizedException (client fault)
You aren't authorized to perform this operation.
Throws
AppSyncServiceException
Base exception class for all service exceptions from AppSync service.