Interfaces
Properties
connectClient?
optional connectClient?: ConnectClient;
connectClientConfig?
optional connectClientConfig?: ConnectClientConfig;
instanceId
participantClient?
optional participantClient?: ConnectParticipantClient;
participantClientConfig?
optional participantClientConfig?: ConnectParticipantClientConfig;
region
Properties
connectParticipant?
optional connectParticipant?: boolean;
participantToken
participantToken: string;
type?
optional type?: ConnectionType[];
AmazonConnectRawClients
Properties
connect
participant
participant: ConnectParticipantClient;
Properties
arn?
status?
optional status?: ReferenceStatus;
statusReason?
optional statusReason?: string;
type
type: NonNullable<ReferenceType>;
value
Properties
clientToken?
optional clientToken?: string;
connectionToken
content?
optional content?: string;
contentType
Properties
clientToken?
optional clientToken?: string;
connectionToken
content
contentType
Properties
attributes?
optional attributes?: Record<string, string>;
chatDurationInMinutes?
optional chatDurationInMinutes?: number;
clientToken?
optional clientToken?: string;
customerId?
optional customerId?: string;
disconnectOnCustomerExit?
optional disconnectOnCustomerExit?: "AGENT"[];
initialMessage?
optional initialMessage?: AmazonConnectChatMessageInput;
participantConfiguration?
optional participantConfiguration?: ParticipantConfiguration;
participantDetails
participantDetails: AmazonConnectParticipantDetailsInput;
persistentChat?
optional persistentChat?: PersistentChat;
optional relatedContactId?: string;
segmentAttributes?
optional segmentAttributes?: Record<string, SegmentAttributeValue>;
supportedMessagingContentTypes?
optional supportedMessagingContentTypes?: string[];
AmazonConnectStartChatResult
Properties
continuedFromContactId: string;
participantId
participantToken
participantToken: string;
raw
raw: StartChatContactCommandOutput;
Properties
attachments?
optional attachments?: TaskAttachment[];
attributes?
optional attributes?: Record<string, string>;
clientToken?
optional clientToken?: string;
optional contactFlowId?: string;
description?
optional description?: string;
name
optional previousContactId?: string;
quickConnectId?
optional quickConnectId?: string;
references?
optional references?: AmazonConnectContactReferencesInput;
optional relatedContactId?: string;
scheduledTime?
optional scheduledTime?: Date;
segmentAttributes?
optional segmentAttributes?: Record<string, SegmentAttributeValue>;
taskTemplateId?
optional taskTemplateId?: string;
AmazonConnectStartTaskResult
Properties
raw
raw: StartTaskContactCommandOutput;
Properties
connectionToken
optional contactId?: string;
maxResults?
optional maxResults?: number;
nextToken?
optional nextToken?: string;
scanDirection?
optional scanDirection?: ScanDirection;
sortOrder?
optional sortOrder?: SortKey;
startPosition?
optional startPosition?: StartPosition;
Properties
clientToken?
optional clientToken?: string;
queueId?
optional queueId?: string;
userId?
optional userId?: string;
Type Aliases
type AmazonConnectChatMessageInput =
| AwsChatMessage
| {
content: NonNullable<AwsChatMessage["Content"]>;
contentType: NonNullable<AwsChatMessage["ContentType"]>;
};
type AmazonConnectContactReferencesInput = Record<string,
| AmazonConnectReferenceInput
| Reference>;
type AmazonConnectParticipantDetailsInput =
| AwsParticipantDetails
| {
displayName: NonNullable<AwsParticipantDetails["DisplayName"]>;
};
Functions
function amazonConnectContactCenterCredentialStatuses(input): {
message: string;
providerPackageId: "contact-center.amazon-connect";
requirementId: string;
state: string;
}[];
Parameters
Returns
{
message: string;
providerPackageId: "contact-center.amazon-connect";
requirementId: string;
state: string;
}[]
function createAmazonConnectContactCenterClient(options): {
rawClients: AmazonConnectRawClients;
createParticipantConnection: Promise<CreateParticipantConnectionCommandOutput>;
describeInstance: Promise<DescribeInstanceCommandOutput>;
getParticipantTranscript: Promise<GetTranscriptCommandOutput>;
sendParticipantEvent: Promise<SendEventCommandOutput>;
sendParticipantMessage: Promise<SendMessageCommandOutput>;
startChatContact: Promise<AmazonConnectStartChatResult>;
startTaskContact: Promise<AmazonConnectStartTaskResult>;
transferContact: Promise<TransferContactCommandOutput>;
};
Parameters
Returns
{
rawClients: AmazonConnectRawClients;
createParticipantConnection: Promise<CreateParticipantConnectionCommandOutput>;
describeInstance: Promise<DescribeInstanceCommandOutput>;
getParticipantTranscript: Promise<GetTranscriptCommandOutput>;
sendParticipantEvent: Promise<SendEventCommandOutput>;
sendParticipantMessage: Promise<SendMessageCommandOutput>;
startChatContact: Promise<AmazonConnectStartChatResult>;
startTaskContact: Promise<AmazonConnectStartTaskResult>;
transferContact: Promise<TransferContactCommandOutput>;
}
| Name |
Type |
rawClients |
AmazonConnectRawClients |
createParticipantConnection() |
(input) => Promise\<CreateParticipantConnectionCommandOutput> |
describeInstance() |
() => Promise\<DescribeInstanceCommandOutput> |
getParticipantTranscript() |
(input) => Promise\<GetTranscriptCommandOutput> |
sendParticipantEvent() |
(input) => Promise\<SendEventCommandOutput> |
sendParticipantMessage() |
(input) => Promise\<SendMessageCommandOutput> |
startChatContact() |
(input) => Promise\<AmazonConnectStartChatResult> |
startTaskContact() |
(input) => Promise\<AmazonConnectStartTaskResult> |
transferContact() |
(input) => Promise\<TransferContactCommandOutput> |
function createAmazonConnectContactCenterIntegration(options): {
bindingReport: OperationBindingReport;
credentialStatuses: () => {
message: string;
providerPackageId: "contact-center.amazon-connect";
requirementId: string;
state: string;
}[];
manifest: {
capabilities: {
audiences?: ("customer-facing" | "internal-support" | "mixed")[];
capability: string;
changesWorkflow?: boolean;
description?: string;
exposesSensitiveData?: boolean;
extension?: boolean;
label?: string;
metadata?: Record<string, unknown>;
providerObjects?: {
description?: string;
kind: string;
label?: string;
metadata?: Record<string, unknown>;
schemaName?: string;
}[];
requiresCredential?: boolean;
sideEffect?: boolean;
}[];
category: string;
channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
coverage: {
evidence: {
label: string;
url?: string;
}[];
notes: string[];
scope: | "support-workflow-subset"
| "provider-api-subset"
| "connector-required"
| "local-protocol"
| "full-provider-api";
};
credentialRequirements: {
description?: string;
id: string;
label?: string;
metadata?: Record<string, unknown>;
required: boolean;
scopes: string[];
}[];
directions: (
| "receive-only"
| "send-only"
| "inbound-only"
| "outbound-only"
| "bidirectional")[];
id: string;
limitations: string[];
maintainers: {
name: string;
type: "community" | "official" | "unknown" | "partner";
url?: string;
}[];
metadata?: Record<string, unknown>;
name: string;
operations: {
alias: string;
audience?: "customer-facing" | "internal-support" | "mixed";
audiences?: ("customer-facing" | "internal-support" | "mixed")[];
capability: string;
changesWorkflow?: boolean;
description?: string;
exposesSensitiveData?: boolean;
extension: boolean;
externallyVisible?: boolean;
inputSchema?: unknown;
inputSchemaName?: string;
inputSchemaRef?: string;
label?: string;
metadata?: Record<string, unknown>;
outputSchema?: unknown;
outputSchemaName?: string;
outputSchemaRef?: string;
providerObject?: string;
providerObjects?: {
description?: string;
kind: string;
label?: string;
metadata?: Record<string, unknown>;
schemaName?: string;
}[];
providerOperation?: string;
requiredPolicyIds?: string[];
requiresApproval?: boolean;
requiresCredential?: boolean;
sideEffect?: boolean;
}[];
packageName: string;
privacyNotes: string[];
provider: string;
trustLevel: "community" | "official" | "verified" | "experimental";
} & {
capabilities: [{
capability: "handoff";
changesWorkflow: true;
exposesSensitiveData: true;
label: "Create Amazon Connect task handoffs";
providerObjects: [{
kind: "amazonConnectTaskContact";
label: "Amazon Connect Task Contact";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "send";
changesWorkflow: true;
exposesSensitiveData: true;
label: "Start Amazon Connect chat contacts and send participant messages";
providerObjects: [{
kind: "amazonConnectChatContact";
label: "Amazon Connect Chat Contact";
}, {
kind: "amazonConnectChatMessage";
label: "Amazon Connect Chat Message";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "transfer";
changesWorkflow: true;
exposesSensitiveData: true;
label: "Transfer Amazon Connect task or email contacts";
providerObjects: [{
kind: "amazonConnectContactTransfer";
label: "Amazon Connect Contact Transfer";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "read-provider-object";
exposesSensitiveData: true;
label: "Read Amazon Connect instance and transcript state";
providerObjects: [{
kind: "amazonConnectInstance";
label: "Amazon Connect Instance";
}, {
kind: "amazonConnectChatTranscript";
label: "Amazon Connect Chat Transcript";
}];
requiresCredential: true;
}];
category: "contact-center";
channelAudiences: ["customer-facing", "internal-support", "mixed"];
coverage: {
evidence: [{
label: "AWS SDK for JavaScript v3";
url: "https://github.com/aws/aws-sdk-js-v3";
}, {
label: "Amazon Connect API Reference";
url: "https://docs.aws.amazon.com/connect/latest/APIReference/Welcome.html";
}, {
label: "Amazon Connect Participant Service";
url: "https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Participant_Service.html";
}];
notes: ["Runtime uses AWS SDK v3 clients for normalized Amazon Connect support workflows.", "Raw AWS SDK clients are exposed as escape hatches for provider-specific operations.", "The previous generated Connect-family full-provider clone is not carried forward as a Cognidesk-owned API; broader Connect-family SDK clients should be added only when normalized support workflows need them.", "Connect Health was present in the old generated model bundle, but no @aws-sdk/client-connect-health npm package was found during the 2026-06-21 SDK check."];
scope: "support-workflow-subset";
};
credentialRequirements: [{
description: "Amazon Connect instance ID and AWS region.";
id: "amazon-connect-instance";
label: "Amazon Connect instance";
required: true;
}, {
description: "AWS SDK v3 credentials with the required Amazon Connect and Connect Participant permissions.";
id: "amazon-connect-api-access";
label: "Amazon Connect API access";
metadata: {
privilegeGuidance: "These are AWS IAM action names, not OAuth scopes.";
scopeKind: "provider-permission-labels";
};
required: true;
scopes: ["connect:StartTaskContact", "connect:StartChatContact", "connect:TransferContact", "connect:DescribeInstance"];
}];
directions: ["inbound-only", "outbound-only", "bidirectional"];
id: "contact-center.amazon-connect";
limitations: ["Contact flows, queue/quick-connect routing, outbound consent, IAM policy, participant token custody, and WebSocket subscription behavior remain application/AWS configuration.", "Raw AWS SDK clients are available for escape-hatch use, but raw SDK breadth is not declared as normalized Cognidesk adapter coverage."];
maintainers: [{
name: "Cognidesk";
type: "official";
}];
metadata: {
channelCoverage: {
chatContact: "sdk-normalized";
connectHealth: "sdk-gap";
participantMessages: "sdk-normalized";
participantTranscript: "sdk-normalized";
rawAwsSdkClients: "escape-hatch";
taskContact: "sdk-normalized";
taskEmailTransfer: "sdk-normalized";
};
implementation: {
sdkPackage: "@aws-sdk/client-connect, @aws-sdk/client-connectparticipant";
sdkPackages: readonly ["@aws-sdk/client-connect", "@aws-sdk/client-connectparticipant"];
strategy: "official-sdk";
};
};
name: "Amazon Connect";
operations: [{
alias: "contact-center.handoff.request";
capability: "handoff";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "contactTransfer";
providerOperation: "StartTaskContact";
sideEffect: true;
}, {
alias: "contact-center.task.create";
capability: "create-provider-object";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "contact-center-task";
providerOperation: "StartTaskContact";
sideEffect: true;
}, {
alias: "contact-center.contact.start";
capability: "send";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "contact";
providerOperation: "StartChatContact";
sideEffect: true;
}, {
alias: "contact-center.transfer.request";
capability: "transfer";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "contactTransfer";
providerOperation: "TransferContact";
sideEffect: true;
}, {
alias: "contact-center.transcript.read";
capability: "read-provider-object";
exposesSensitiveData: true;
providerObject: "contactTranscript";
providerOperation: "GetTranscript";
}];
packageName: "@cognidesk/integration-contact-center-amazon-connect";
privacyNotes: ["Task, chat, transfer, and transcript operations can include customer identifiers, routing attributes, messages, summaries, and participant tokens.", "AWS credentials remain inside the SDK user's runtime configuration."];
provider: "amazon-connect";
trustLevel: "official";
};
metadata?: Record<string, unknown>;
operationAliases: (
| "contact-center.transfer.request"
| "contact-center.handoff.request"
| "contact-center.contact.start"
| "contact-center.task.create"
| "contact-center.transcript.read")[];
operations: {
contact-center.contact.start: (input) => Promise<AmazonConnectStartChatResult>;
contact-center.handoff.request: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.task.create: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.transcript.read: (input) => Promise<GetTranscriptCommandOutput>;
contact-center.transfer.request: (input) => Promise<TransferContactCommandOutput>;
};
rawClient: AmazonConnectRawClients;
rawClients: AmazonConnectRawClients;
readiness: () => Promise<
| {
blockers?: never;
checkSource: string;
live: boolean;
providerPackageId: "contact-center.amazon-connect";
status: string;
}
| {
blockers: {
code: string;
kind: string;
message: string;
}[];
checkSource: string;
live: boolean;
providerPackageId: "contact-center.amazon-connect";
status: string;
}>;
getOperationHandler: {
contact-center.contact.start: (input) => Promise<AmazonConnectStartChatResult>;
contact-center.handoff.request: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.task.create: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.transcript.read: (input) => Promise<GetTranscriptCommandOutput>;
contact-center.transfer.request: (input) => Promise<TransferContactCommandOutput>;
}[Alias];
requireOperationHandler: {
contact-center.contact.start: (input) => Promise<AmazonConnectStartChatResult>;
contact-center.handoff.request: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.task.create: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.transcript.read: (input) => Promise<GetTranscriptCommandOutput>;
contact-center.transfer.request: (input) => Promise<TransferContactCommandOutput>;
}[Alias];
run: Promise<Awaited<ReturnType<{
contact-center.contact.start: (input) => Promise<AmazonConnectStartChatResult>;
contact-center.handoff.request: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.task.create: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.transcript.read: (input) => Promise<GetTranscriptCommandOutput>;
contact-center.transfer.request: (input) => Promise<TransferContactCommandOutput>;
}[Alias]>>>;
};
Parameters
Returns
{
bindingReport: OperationBindingReport;
credentialStatuses: () => {
message: string;
providerPackageId: "contact-center.amazon-connect";
requirementId: string;
state: string;
}[];
manifest: {
capabilities: {
audiences?: ("customer-facing" | "internal-support" | "mixed")[];
capability: string;
changesWorkflow?: boolean;
description?: string;
exposesSensitiveData?: boolean;
extension?: boolean;
label?: string;
metadata?: Record<string, unknown>;
providerObjects?: {
description?: string;
kind: string;
label?: string;
metadata?: Record<string, unknown>;
schemaName?: string;
}[];
requiresCredential?: boolean;
sideEffect?: boolean;
}[];
category: string;
channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
coverage: {
evidence: {
label: string;
url?: string;
}[];
notes: string[];
scope: | "support-workflow-subset"
| "provider-api-subset"
| "connector-required"
| "local-protocol"
| "full-provider-api";
};
credentialRequirements: {
description?: string;
id: string;
label?: string;
metadata?: Record<string, unknown>;
required: boolean;
scopes: string[];
}[];
directions: (
| "receive-only"
| "send-only"
| "inbound-only"
| "outbound-only"
| "bidirectional")[];
id: string;
limitations: string[];
maintainers: {
name: string;
type: "community" | "official" | "unknown" | "partner";
url?: string;
}[];
metadata?: Record<string, unknown>;
name: string;
operations: {
alias: string;
audience?: "customer-facing" | "internal-support" | "mixed";
audiences?: ("customer-facing" | "internal-support" | "mixed")[];
capability: string;
changesWorkflow?: boolean;
description?: string;
exposesSensitiveData?: boolean;
extension: boolean;
externallyVisible?: boolean;
inputSchema?: unknown;
inputSchemaName?: string;
inputSchemaRef?: string;
label?: string;
metadata?: Record<string, unknown>;
outputSchema?: unknown;
outputSchemaName?: string;
outputSchemaRef?: string;
providerObject?: string;
providerObjects?: {
description?: string;
kind: string;
label?: string;
metadata?: Record<string, unknown>;
schemaName?: string;
}[];
providerOperation?: string;
requiredPolicyIds?: string[];
requiresApproval?: boolean;
requiresCredential?: boolean;
sideEffect?: boolean;
}[];
packageName: string;
privacyNotes: string[];
provider: string;
trustLevel: "community" | "official" | "verified" | "experimental";
} & {
capabilities: [{
capability: "handoff";
changesWorkflow: true;
exposesSensitiveData: true;
label: "Create Amazon Connect task handoffs";
providerObjects: [{
kind: "amazonConnectTaskContact";
label: "Amazon Connect Task Contact";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "send";
changesWorkflow: true;
exposesSensitiveData: true;
label: "Start Amazon Connect chat contacts and send participant messages";
providerObjects: [{
kind: "amazonConnectChatContact";
label: "Amazon Connect Chat Contact";
}, {
kind: "amazonConnectChatMessage";
label: "Amazon Connect Chat Message";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "transfer";
changesWorkflow: true;
exposesSensitiveData: true;
label: "Transfer Amazon Connect task or email contacts";
providerObjects: [{
kind: "amazonConnectContactTransfer";
label: "Amazon Connect Contact Transfer";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "read-provider-object";
exposesSensitiveData: true;
label: "Read Amazon Connect instance and transcript state";
providerObjects: [{
kind: "amazonConnectInstance";
label: "Amazon Connect Instance";
}, {
kind: "amazonConnectChatTranscript";
label: "Amazon Connect Chat Transcript";
}];
requiresCredential: true;
}];
category: "contact-center";
channelAudiences: ["customer-facing", "internal-support", "mixed"];
coverage: {
evidence: [{
label: "AWS SDK for JavaScript v3";
url: "https://github.com/aws/aws-sdk-js-v3";
}, {
label: "Amazon Connect API Reference";
url: "https://docs.aws.amazon.com/connect/latest/APIReference/Welcome.html";
}, {
label: "Amazon Connect Participant Service";
url: "https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Participant_Service.html";
}];
notes: ["Runtime uses AWS SDK v3 clients for normalized Amazon Connect support workflows.", "Raw AWS SDK clients are exposed as escape hatches for provider-specific operations.", "The previous generated Connect-family full-provider clone is not carried forward as a Cognidesk-owned API; broader Connect-family SDK clients should be added only when normalized support workflows need them.", "Connect Health was present in the old generated model bundle, but no @aws-sdk/client-connect-health npm package was found during the 2026-06-21 SDK check."];
scope: "support-workflow-subset";
};
credentialRequirements: [{
description: "Amazon Connect instance ID and AWS region.";
id: "amazon-connect-instance";
label: "Amazon Connect instance";
required: true;
}, {
description: "AWS SDK v3 credentials with the required Amazon Connect and Connect Participant permissions.";
id: "amazon-connect-api-access";
label: "Amazon Connect API access";
metadata: {
privilegeGuidance: "These are AWS IAM action names, not OAuth scopes.";
scopeKind: "provider-permission-labels";
};
required: true;
scopes: ["connect:StartTaskContact", "connect:StartChatContact", "connect:TransferContact", "connect:DescribeInstance"];
}];
directions: ["inbound-only", "outbound-only", "bidirectional"];
id: "contact-center.amazon-connect";
limitations: ["Contact flows, queue/quick-connect routing, outbound consent, IAM policy, participant token custody, and WebSocket subscription behavior remain application/AWS configuration.", "Raw AWS SDK clients are available for escape-hatch use, but raw SDK breadth is not declared as normalized Cognidesk adapter coverage."];
maintainers: [{
name: "Cognidesk";
type: "official";
}];
metadata: {
channelCoverage: {
chatContact: "sdk-normalized";
connectHealth: "sdk-gap";
participantMessages: "sdk-normalized";
participantTranscript: "sdk-normalized";
rawAwsSdkClients: "escape-hatch";
taskContact: "sdk-normalized";
taskEmailTransfer: "sdk-normalized";
};
implementation: {
sdkPackage: "@aws-sdk/client-connect, @aws-sdk/client-connectparticipant";
sdkPackages: readonly ["@aws-sdk/client-connect", "@aws-sdk/client-connectparticipant"];
strategy: "official-sdk";
};
};
name: "Amazon Connect";
operations: [{
alias: "contact-center.handoff.request";
capability: "handoff";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "contactTransfer";
providerOperation: "StartTaskContact";
sideEffect: true;
}, {
alias: "contact-center.task.create";
capability: "create-provider-object";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "contact-center-task";
providerOperation: "StartTaskContact";
sideEffect: true;
}, {
alias: "contact-center.contact.start";
capability: "send";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "contact";
providerOperation: "StartChatContact";
sideEffect: true;
}, {
alias: "contact-center.transfer.request";
capability: "transfer";
changesWorkflow: true;
exposesSensitiveData: true;
providerObject: "contactTransfer";
providerOperation: "TransferContact";
sideEffect: true;
}, {
alias: "contact-center.transcript.read";
capability: "read-provider-object";
exposesSensitiveData: true;
providerObject: "contactTranscript";
providerOperation: "GetTranscript";
}];
packageName: "@cognidesk/integration-contact-center-amazon-connect";
privacyNotes: ["Task, chat, transfer, and transcript operations can include customer identifiers, routing attributes, messages, summaries, and participant tokens.", "AWS credentials remain inside the SDK user's runtime configuration."];
provider: "amazon-connect";
trustLevel: "official";
};
metadata?: Record<string, unknown>;
operationAliases: (
| "contact-center.transfer.request"
| "contact-center.handoff.request"
| "contact-center.contact.start"
| "contact-center.task.create"
| "contact-center.transcript.read")[];
operations: {
contact-center.contact.start: (input) => Promise<AmazonConnectStartChatResult>;
contact-center.handoff.request: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.task.create: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.transcript.read: (input) => Promise<GetTranscriptCommandOutput>;
contact-center.transfer.request: (input) => Promise<TransferContactCommandOutput>;
};
rawClient: AmazonConnectRawClients;
rawClients: AmazonConnectRawClients;
readiness: () => Promise<
| {
blockers?: never;
checkSource: string;
live: boolean;
providerPackageId: "contact-center.amazon-connect";
status: string;
}
| {
blockers: {
code: string;
kind: string;
message: string;
}[];
checkSource: string;
live: boolean;
providerPackageId: "contact-center.amazon-connect";
status: string;
}>;
getOperationHandler: {
contact-center.contact.start: (input) => Promise<AmazonConnectStartChatResult>;
contact-center.handoff.request: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.task.create: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.transcript.read: (input) => Promise<GetTranscriptCommandOutput>;
contact-center.transfer.request: (input) => Promise<TransferContactCommandOutput>;
}[Alias];
requireOperationHandler: {
contact-center.contact.start: (input) => Promise<AmazonConnectStartChatResult>;
contact-center.handoff.request: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.task.create: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.transcript.read: (input) => Promise<GetTranscriptCommandOutput>;
contact-center.transfer.request: (input) => Promise<TransferContactCommandOutput>;
}[Alias];
run: Promise<Awaited<ReturnType<{
contact-center.contact.start: (input) => Promise<AmazonConnectStartChatResult>;
contact-center.handoff.request: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.task.create: (input) => Promise<AmazonConnectStartTaskResult>;
contact-center.transcript.read: (input) => Promise<GetTranscriptCommandOutput>;
contact-center.transfer.request: (input) => Promise<TransferContactCommandOutput>;
}[Alias]>>>;
}
| Name |
Type |
bindingReport |
OperationBindingReport |
credentialStatuses() |
() => { message: string; providerPackageId: "contact-center.amazon-connect"; requirementId: string; state: string; }[] |
manifest |
{ capabilities: { audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension?: boolean; label?: string; metadata?: Record\<string, unknown>; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; requiresCredential?: boolean; sideEffect?: boolean; }[]; category: string; channelAudiences: ("customer-facing" | "internal-support" | "mixed")[]; coverage: { evidence: { label: string; url?: string; }[]; notes: string[]; scope: | "support-workflow-subset" | "provider-api-subset" | "connector-required" | "local-protocol" | "full-provider-api"; }; credentialRequirements: { description?: string; id: string; label?: string; metadata?: Record\<string, unknown>; required: boolean; scopes: string[]; }[]; directions: ( | "receive-only" | "send-only" | "inbound-only" | "outbound-only" | "bidirectional")[]; id: string; limitations: string[]; maintainers: { name: string; type: "community" | "official" | "unknown" | "partner"; url?: string; }[]; metadata?: Record\<string, unknown>; name: string; operations: { alias: string; audience?: "customer-facing" | "internal-support" | "mixed"; audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension: boolean; externallyVisible?: boolean; inputSchema?: unknown; inputSchemaName?: string; inputSchemaRef?: string; label?: string; metadata?: Record\<string, unknown>; outputSchema?: unknown; outputSchemaName?: string; outputSchemaRef?: string; providerObject?: string; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; providerOperation?: string; requiredPolicyIds?: string[]; requiresApproval?: boolean; requiresCredential?: boolean; sideEffect?: boolean; }[]; packageName: string; privacyNotes: string[]; provider: string; trustLevel: "community" | "official" | "verified" | "experimental"; } & { capabilities: [{ capability: "handoff"; changesWorkflow: true; exposesSensitiveData: true; label: "Create Amazon Connect task handoffs"; providerObjects: [{ kind: "amazonConnectTaskContact"; label: "Amazon Connect Task Contact"; }]; requiresCredential: true; sideEffect: true; }, { capability: "send"; changesWorkflow: true; exposesSensitiveData: true; label: "Start Amazon Connect chat contacts and send participant messages"; providerObjects: [{ kind: "amazonConnectChatContact"; label: "Amazon Connect Chat Contact"; }, { kind: "amazonConnectChatMessage"; label: "Amazon Connect Chat Message"; }]; requiresCredential: true; sideEffect: true; }, { capability: "transfer"; changesWorkflow: true; exposesSensitiveData: true; label: "Transfer Amazon Connect task or email contacts"; providerObjects: [{ kind: "amazonConnectContactTransfer"; label: "Amazon Connect Contact Transfer"; }]; requiresCredential: true; sideEffect: true; }, { capability: "read-provider-object"; exposesSensitiveData: true; label: "Read Amazon Connect instance and transcript state"; providerObjects: [{ kind: "amazonConnectInstance"; label: "Amazon Connect Instance"; }, { kind: "amazonConnectChatTranscript"; label: "Amazon Connect Chat Transcript"; }]; requiresCredential: true; }]; category: "contact-center"; channelAudiences: ["customer-facing", "internal-support", "mixed"]; coverage: { evidence: [{ label: "AWS SDK for JavaScript v3"; url: "https://github.com/aws/aws-sdk-js-v3"; }, { label: "Amazon Connect API Reference"; url: "https://docs.aws.amazon.com/connect/latest/APIReference/Welcome.html"; }, { label: "Amazon Connect Participant Service"; url: "https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Participant_Service.html"; }]; notes: ["Runtime uses AWS SDK v3 clients for normalized Amazon Connect support workflows.", "Raw AWS SDK clients are exposed as escape hatches for provider-specific operations.", "The previous generated Connect-family full-provider clone is not carried forward as a Cognidesk-owned API; broader Connect-family SDK clients should be added only when normalized support workflows need them.", "Connect Health was present in the old generated model bundle, but no @aws-sdk/client-connect-health npm package was found during the 2026-06-21 SDK check."]; scope: "support-workflow-subset"; }; credentialRequirements: [{ description: "Amazon Connect instance ID and AWS region."; id: "amazon-connect-instance"; label: "Amazon Connect instance"; required: true; }, { description: "AWS SDK v3 credentials with the required Amazon Connect and Connect Participant permissions."; id: "amazon-connect-api-access"; label: "Amazon Connect API access"; metadata: { privilegeGuidance: "These are AWS IAM action names, not OAuth scopes."; scopeKind: "provider-permission-labels"; }; required: true; scopes: ["connect:StartTaskContact", "connect:StartChatContact", "connect:TransferContact", "connect:DescribeInstance"]; }]; directions: ["inbound-only", "outbound-only", "bidirectional"]; id: "contact-center.amazon-connect"; limitations: ["Contact flows, queue/quick-connect routing, outbound consent, IAM policy, participant token custody, and WebSocket subscription behavior remain application/AWS configuration.", "Raw AWS SDK clients are available for escape-hatch use, but raw SDK breadth is not declared as normalized Cognidesk adapter coverage."]; maintainers: [{ name: "Cognidesk"; type: "official"; }]; metadata: { channelCoverage: { chatContact: "sdk-normalized"; connectHealth: "sdk-gap"; participantMessages: "sdk-normalized"; participantTranscript: "sdk-normalized"; rawAwsSdkClients: "escape-hatch"; taskContact: "sdk-normalized"; taskEmailTransfer: "sdk-normalized"; }; implementation: { sdkPackage: "@aws-sdk/client-connect, @aws-sdk/client-connectparticipant"; sdkPackages: readonly ["@aws-sdk/client-connect", "@aws-sdk/client-connectparticipant"]; strategy: "official-sdk"; }; }; name: "Amazon Connect"; operations: [{ alias: "contact-center.handoff.request"; capability: "handoff"; changesWorkflow: true; exposesSensitiveData: true; providerObject: "contactTransfer"; providerOperation: "StartTaskContact"; sideEffect: true; }, { alias: "contact-center.task.create"; capability: "create-provider-object"; changesWorkflow: true; exposesSensitiveData: true; providerObject: "contact-center-task"; providerOperation: "StartTaskContact"; sideEffect: true; }, { alias: "contact-center.contact.start"; capability: "send"; changesWorkflow: true; exposesSensitiveData: true; providerObject: "contact"; providerOperation: "StartChatContact"; sideEffect: true; }, { alias: "contact-center.transfer.request"; capability: "transfer"; changesWorkflow: true; exposesSensitiveData: true; providerObject: "contactTransfer"; providerOperation: "TransferContact"; sideEffect: true; }, { alias: "contact-center.transcript.read"; capability: "read-provider-object"; exposesSensitiveData: true; providerObject: "contactTranscript"; providerOperation: "GetTranscript"; }]; packageName: "@cognidesk/integration-contact-center-amazon-connect"; privacyNotes: ["Task, chat, transfer, and transcript operations can include customer identifiers, routing attributes, messages, summaries, and participant tokens.", "AWS credentials remain inside the SDK user's runtime configuration."]; provider: "amazon-connect"; trustLevel: "official"; } |
metadata? |
Record\<string, unknown> |
operationAliases |
( | "contact-center.transfer.request" | "contact-center.handoff.request" | "contact-center.contact.start" | "contact-center.task.create" | "contact-center.transcript.read")[] |
operations |
{ contact-center.contact.start: (input) => Promise\<AmazonConnectStartChatResult>; contact-center.handoff.request: (input) => Promise\<AmazonConnectStartTaskResult>; contact-center.task.create: (input) => Promise\<AmazonConnectStartTaskResult>; contact-center.transcript.read: (input) => Promise\<GetTranscriptCommandOutput>; contact-center.transfer.request: (input) => Promise\<TransferContactCommandOutput>; } |
operations.contact-center.contact.start() |
(input) => Promise\<AmazonConnectStartChatResult> |
operations.contact-center.handoff.request() |
(input) => Promise\<AmazonConnectStartTaskResult> |
operations.contact-center.task.create() |
(input) => Promise\<AmazonConnectStartTaskResult> |
operations.contact-center.transcript.read() |
(input) => Promise\<GetTranscriptCommandOutput> |
operations.contact-center.transfer.request() |
(input) => Promise\<TransferContactCommandOutput> |
rawClient |
AmazonConnectRawClients |
rawClients |
AmazonConnectRawClients |
readiness() |
() => Promise\< | { blockers?: never; checkSource: string; live: boolean; providerPackageId: "contact-center.amazon-connect"; status: string; } | { blockers: { code: string; kind: string; message: string; }[]; checkSource: string; live: boolean; providerPackageId: "contact-center.amazon-connect"; status: string; }> |
getOperationHandler() |
(alias) => { contact-center.contact.start: (input) => Promise\<AmazonConnectStartChatResult>; contact-center.handoff.request: (input) => Promise\<AmazonConnectStartTaskResult>; contact-center.task.create: (input) => Promise\<AmazonConnectStartTaskResult>; contact-center.transcript.read: (input) => Promise\<GetTranscriptCommandOutput>; contact-center.transfer.request: (input) => Promise\<TransferContactCommandOutput>; }[Alias] |
requireOperationHandler() |
(alias) => { contact-center.contact.start: (input) => Promise\<AmazonConnectStartChatResult>; contact-center.handoff.request: (input) => Promise\<AmazonConnectStartTaskResult>; contact-center.task.create: (input) => Promise\<AmazonConnectStartTaskResult>; contact-center.transcript.read: (input) => Promise\<GetTranscriptCommandOutput>; contact-center.transfer.request: (input) => Promise\<TransferContactCommandOutput>; }[Alias] |
run() |
( alias, input, context?) => Promise\<Awaited\<ReturnType\<{ contact-center.contact.start: (input) => Promise\<AmazonConnectStartChatResult>; contact-center.handoff.request: (input) => Promise\<AmazonConnectStartTaskResult>; contact-center.task.create: (input) => Promise\<AmazonConnectStartTaskResult>; contact-center.transcript.read: (input) => Promise\<GetTranscriptCommandOutput>; contact-center.transfer.request: (input) => Promise\<TransferContactCommandOutput>; }[Alias]>>> |
References
Re-exports amazonConnectContactCenterManifest