View a markdown version of this page

API Reference - Amazon Connect

API Reference

All operations follow the Command pattern. Import the client and the command, then call client.send(command).

import { AgenticCXDesignerClient, <CommandName> } from "amazon-connect-acxd-sdk";

const client = new AgenticCXDesignerClient({
  apiKey: 'acxd_live_...',
  workspaceId: 'your-workspace-uuid',
});

const response = await client.send(new <CommandName>({ ... }));

Most List operations use token-based pagination:

const response = await client.send(new ListApplicationsCommand({
    maxResults: 50,
    nextToken: '...',
}));

API Operations

The following section lists the API operations by resource.

API Token Operations

  • ListApiTokens

  • CreateApiToken

  • DeleteApiToken

Application Operations

  • ListApplications

  • CreateApplication

  • GetApplication

  • UpdateApplication

  • DeleteApplication

Application Build Operations

  • ListApplicationBuilds

  • CreateApplicationBuild

  • GetApplicationBuild

  • GetApplicationBuildDiff

Application Deployment Operations

  • ListApplicationDeployments

  • CreateApplicationDeployment

  • GetApplicationDeployment

  • UpdateApplicationDeployment

  • DeleteApplicationDeployment

Analytics Tag Operations

  • ListAnalyticsTags

  • CreateAnalyticsTag

  • UpdateAnalyticsTag

  • DeleteAnalyticsTag

Context Variables Operations

  • ListContextVariables

  • CreateContextVariable

  • UpdateContextVariable

  • DeleteContextVariable

Conversation Operations

  • ListConversations

  • GetConversation

Data Request Operations

  • ListDataRequests

  • CreateDataRequest

  • GetDataRequest

  • UpdateDataRequest

  • DeleteDataRequest

Downloads Operations

  • GetDownload

Flow Operations

  • ListFlows

  • CreateFlow

  • GetFlow

  • UpdateFlow

  • DeleteFlow

Guardrail Operations

  • ListGuardrails

  • CreateGuardrail

  • GetGuardrail

  • UpdateGuardrail

  • DeleteGuardrail

  • TestGuardrail

  • ListGuardrailEvents

Knowledge Base Operations

  • ListKnowledgeBases

  • CreateKnowledgeBase

  • GetKnowledgeBase

  • UpdateKnowledgeBase

  • DeleteKnowledgeBase

  • CloneKnowledgeBase

  • PublishKnowledgeBase

  • GetKnowledgeBasePublication

  • ListKnowledgeBasePublications

Knowledge Base Article Operations

  • ListKnowledgeBaseArticles

  • CreateKnowledgeBaseArticle

  • GetKnowledgeBaseArticle

  • UpdateKnowledgeBaseArticle

  • DeleteKnowledgeBaseArticle

Knowledge Base Document Operations

  • ListKnowledgeBaseDocuments

  • GetKnowledgeBaseDocument

  • PutKnowledgeBaseDocument

  • DeleteKnowledgeBaseDocument

Live Sync Script Operations

  • ListLiveSyncScripts

  • CreateLiveSyncScript

  • GetLiveSyncScript

  • UpdateLiveSyncScript

  • DeleteLiveSyncScript

  • ListLiveSyncScriptBuilds

  • CreateLiveSyncScriptBuild

  • GetLiveSyncScriptBuild

  • ListLiveSyncScriptDeployments

  • CreateLiveSyncScriptDeployment

  • GetLiveSyncScriptDeployment

  • UpdateLiveSyncScriptDeployment

  • DeleteLiveSyncScriptDeployment

Log Operations

  • QueryLogs

Modality Operations

  • ListModalities

  • CreateModality

  • GetModality

  • UpdateModality

  • DeleteModality

Programmatic User Operations

  • ListProgrammaticUsers

  • CreateProgrammaticUser

  • GetProgrammaticUser

  • UpdateProgrammaticUser

  • DeleteProgrammaticUser

Role Operations

  • ListRoles

  • CreateRole

  • GetRole

  • UpdateRole

  • DeleteRole

  • GetRolePermissions

Secret Operations

  • ListSecrets

  • CreateSecret

  • GetSecret

  • UpdateSecret

  • DeleteSecret

Slot Type Operations

  • ListSlotTypes

  • CreateSlotType

  • GetSlotType

  • UpdateSlotType

  • DeleteSlotType

Team Operations

  • GetTeam

Trail Operations

  • StartTrailQuery

  • GetTrailQueryResults

User Operations

  • ListUsers

  • CreateUser

  • GetUser

  • UpdateUser

  • DeleteUser

Version Operations

  • ListResourceVersions

  • GetResourceVersion

Workspace Operations

  • ListWorkspaces

  • CreateWorkspace

  • GetWorkspace

  • UpdateWorkspace

  • DeleteWorkspace

Contents