import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import type { StartTaskContactRequest, StartTaskContactResponse } from "../models/models_3"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link StartTaskContactCommand}. */ export interface StartTaskContactCommandInput extends StartTaskContactRequest { } /** * @public * * The output of {@link StartTaskContactCommand}. */ export interface StartTaskContactCommandOutput extends StartTaskContactResponse, __MetadataBearer { } declare const StartTaskContactCommand_base: { new (input: StartTaskContactCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: StartTaskContactCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the * Amazon Connect Administrator Guide.

*

When using PreviousContactId and RelatedContactId input parameters, note the * following:

* *

In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, * QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task * template has a flow configured to run it. If more than one parameter is specified, or only the * TaskTemplateID is specified but it does not have a flow configured, the request returns an error * because Amazon Connect cannot identify the unique flow to run when the task is created.

*

A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota * or there are already 12 tasks referencing the same PreviousContactId. For more information about service * quotas for task contacts, see Amazon Connect service quotas in the * Amazon Connect Administrator Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ConnectClient, StartTaskContactCommand } from "@aws-sdk/client-connect"; // ES Modules import * // const { ConnectClient, StartTaskContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import * // import type { ConnectClientConfig } from "@aws-sdk/client-connect"; * const config = {}; // type is ConnectClientConfig * const client = new ConnectClient(config); * const input = { // StartTaskContactRequest * InstanceId: "STRING_VALUE", // required * PreviousContactId: "STRING_VALUE", * ContactFlowId: "STRING_VALUE", * Attributes: { // Attributes * "": "STRING_VALUE", * }, * Name: "STRING_VALUE", // required * References: { // ContactReferences * "": { // Reference * Value: "STRING_VALUE", * Type: "URL" || "ATTACHMENT" || "CONTACT_ANALYSIS" || "NUMBER" || "STRING" || "DATE" || "EMAIL" || "EMAIL_MESSAGE" || "EMAIL_MESSAGE_PLAIN_TEXT" || "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED" || "EMAIL_MESSAGE_REDACTED", // required * Status: "AVAILABLE" || "DELETED" || "APPROVED" || "REJECTED" || "PROCESSING" || "FAILED", * Arn: "STRING_VALUE", * StatusReason: "STRING_VALUE", * }, * }, * Description: "STRING_VALUE", * ClientToken: "STRING_VALUE", * ScheduledTime: new Date("TIMESTAMP"), * TaskTemplateId: "STRING_VALUE", * QuickConnectId: "STRING_VALUE", * RelatedContactId: "STRING_VALUE", * SegmentAttributes: { // SegmentAttributes * "": { // SegmentAttributeValue * ValueString: "STRING_VALUE", * ValueMap: { // SegmentAttributeValueMap * "": { * ValueString: "STRING_VALUE", * ValueMap: { * "": "", * }, * ValueInteger: Number("int"), * ValueList: [ // SegmentAttributeValueList * "", * ], * ValueArn: "STRING_VALUE", * }, * }, * ValueInteger: Number("int"), * ValueList: [ * "", * ], * ValueArn: "STRING_VALUE", * }, * }, * Attachments: [ // TaskAttachments * { // TaskAttachment * FileName: "STRING_VALUE", // required * S3Url: "STRING_VALUE", // required * }, * ], * }; * const command = new StartTaskContactCommand(input); * const response = await client.send(command); * // { // StartTaskContactResponse * // ContactId: "STRING_VALUE", * // }; * * ``` * * @param StartTaskContactCommandInput - {@link StartTaskContactCommandInput} * @returns {@link StartTaskContactCommandOutput} * @see {@link StartTaskContactCommandInput} for command's `input` shape. * @see {@link StartTaskContactCommandOutput} for command's `response` shape. * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. * * @throws {@link InternalServiceException} (server fault) *

Request processing failed because of an error or failure with the service.

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

One or more of the specified parameters are not valid.

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

The request is not valid.

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

The specified resource was not found.

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

The service quota has been exceeded.

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

The throttling limit has been exceeded.

* * @throws {@link ConnectServiceException} *

Base exception class for all service exceptions from Connect service.

* * * @public */ export declare class StartTaskContactCommand extends StartTaskContactCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartTaskContactRequest; output: StartTaskContactResponse; }; sdk: { input: StartTaskContactCommandInput; output: StartTaskContactCommandOutput; }; }; }