DescribeQuickConnectCommand

Suggest an Edit

Describes the quick connect.

Example Syntax

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

import { ConnectClient, DescribeQuickConnectCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DescribeQuickConnectCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DescribeQuickConnectRequest
  InstanceId: "STRING_VALUE", // required
  QuickConnectId: "STRING_VALUE", // required
};
const command = new DescribeQuickConnectCommand(input);
const response = await client.send(command);
// { // DescribeQuickConnectResponse
//   QuickConnect: { // QuickConnect
//     QuickConnectARN: "STRING_VALUE",
//     QuickConnectId: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     QuickConnectConfig: { // QuickConnectConfig
//       QuickConnectType: "USER" || "QUEUE" || "PHONE_NUMBER", // required
//       UserConfig: { // UserQuickConnectConfig
//         UserId: "STRING_VALUE", // required
//         ContactFlowId: "STRING_VALUE", // required
//       },
//       QueueConfig: { // QueueQuickConnectConfig
//         QueueId: "STRING_VALUE", // required
//         ContactFlowId: "STRING_VALUE", // required
//       },
//       PhoneConfig: { // PhoneNumberQuickConnectConfig
//         PhoneNumber: "STRING_VALUE", // required
//       },
//     },
//     Tags: { // TagMap
//       "<keys>": "STRING_VALUE",
//     },
//     LastModifiedTime: new Date("TIMESTAMP"),
//     LastModifiedRegion: "STRING_VALUE",
//   },
// };

DescribeQuickConnectCommand Input

See DescribeQuickConnectCommandInput for more details

Parameter
Type
Description
InstanceId
Required
string | undefined

The identifier of the Amazon Connect instance. You can find the instance ID  in the Amazon Resource Name (ARN) of the instance.

QuickConnectId
Required
string | undefined

The identifier for the quick connect.

DescribeQuickConnectCommand Output

See DescribeQuickConnectCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
QuickConnect
QuickConnect | undefined

Information about the quick connect.

Throws

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.