- 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.
DeleteQuickConnectCommand
Deletes a quick connect.
After calling DeleteUser , it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
-
Avoid dangling resources that impact your service quotas.
-
Remove deleted users so they don't appear to agents as transfer options.
-
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, DeleteQuickConnectCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DeleteQuickConnectCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DeleteQuickConnectRequest
InstanceId: "STRING_VALUE", // required
QuickConnectId: "STRING_VALUE", // required
};
const command = new DeleteQuickConnectCommand(input);
const response = await client.send(command);
// {};
DeleteQuickConnectCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
InstanceIdRequired | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
QuickConnectIdRequired | string | undefined | The identifier for the quick connect. |
DeleteQuickConnectCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServiceException | server | Request processing failed because of an error or failure with the service. |
| InvalidParameterException | client | One or more of the specified parameters are not valid. |
| InvalidRequestException | client | The request is not valid. |
| ResourceNotFoundException | client | The specified resource was not found. |
| ThrottlingException | client | The throttling limit has been exceeded. |
| ConnectServiceException | Base exception class for all service exceptions from Connect service. |