- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteApiCommand
Deletes an Api object
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { AppSyncClient, DeleteApiCommand } from "@aws-sdk/client-appsync"; // ES Modules import
// const { AppSyncClient, DeleteApiCommand } = require("@aws-sdk/client-appsync"); // CommonJS import
const client = new AppSyncClient(config);
const input = { // DeleteApiRequest
apiId: "STRING_VALUE", // required
};
const command = new DeleteApiCommand(input);
const response = await client.send(command);
// {};
DeleteApiCommand Input
See DeleteApiCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
apiIdRequired | string | undefined | The |
DeleteApiCommand Output
See DeleteApiCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You don't have access to perform this operation on this resource. |
| 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. |
| ConcurrentModificationException | client | Another modification is in progress at this time and it must complete before you can make your change. |
| InternalFailureException | server | An internal AppSync error occurred. Try your request again. |
| NotFoundException | client | The resource specified in the request was not found. Check the resource, and then try again. |
| UnauthorizedException | client | You aren't authorized to perform this operation. |
| AppSyncServiceException | Base exception class for all service exceptions from AppSync service. |