Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/connect.ts?docs=full";

§Classes

Connect

§Interfaces

AgentInfo

Information about the agent who accepted the contact.

AgentStatus

Contains information about an agent status.

AgentStatusSummary

Summary information for an agent status.

AnswerMachineDetectionConfig

Configuration of the answering machine detection.

AssociateApprovedOriginRequest
AssociateBotRequest
AssociateInstanceStorageConfigRequest
AssociateInstanceStorageConfigResponse
AssociateLambdaFunctionRequest
AssociateLexBotRequest
AssociateQueueQuickConnectsRequest
AssociateRoutingProfileQueuesRequest
AssociateSecurityKeyRequest
AssociateSecurityKeyResponse
AttachmentReference

Information about the attachment reference if the referenceType is ATTACHMENT. Otherwise, null.

Attribute

A toggle for an individual feature at the instance level.

ChatMessage

A chat message.

ChatStreamingConfiguration

The streaming configuration, such as the Amazon SNS streaming endpoint.

Contact

Contains information about a contact.

ContactFlow

Contains information about a contact flow.

ContactFlowModule

Contains information about a contact flow module.

ContactFlowModuleSummary

Contains summary information about a contact flow.

ContactFlowSummary

Contains summary information about a contact flow.

CreateAgentStatusRequest
CreateAgentStatusResponse
CreateContactFlowModuleRequest
CreateContactFlowModuleResponse
CreateContactFlowRequest
CreateContactFlowResponse
CreateHoursOfOperationRequest
CreateHoursOfOperationResponse
CreateInstanceRequest
CreateInstanceResponse
CreateIntegrationAssociationRequest
CreateIntegrationAssociationResponse
CreateQueueRequest
CreateQueueResponse
CreateQuickConnectRequest
CreateQuickConnectResponse
CreateRoutingProfileRequest
CreateRoutingProfileResponse
CreateSecurityProfileRequest
CreateSecurityProfileResponse
CreateUseCaseRequest
CreateUseCaseResponse
CreateUserHierarchyGroupRequest
CreateUserHierarchyGroupResponse
CreateUserRequest
CreateUserResponse
Credentials

Contains credentials to use for federation.

CurrentMetric

Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

CurrentMetricData

Contains the data for a real-time metric.

CurrentMetricResult

Contains information about a set of real-time metrics.

DeleteContactFlowModuleRequest
DeleteContactFlowRequest
DeleteHoursOfOperationRequest
DeleteInstanceRequest
DeleteIntegrationAssociationRequest
DeleteQuickConnectRequest
DeleteSecurityProfileRequest
DeleteUseCaseRequest
DeleteUserHierarchyGroupRequest
DeleteUserRequest
DescribeAgentStatusRequest
DescribeAgentStatusResponse
DescribeContactFlowModuleRequest
DescribeContactFlowModuleResponse
DescribeContactFlowRequest
DescribeContactFlowResponse
DescribeContactRequest
DescribeContactResponse
DescribeHoursOfOperationRequest
DescribeHoursOfOperationResponse
DescribeInstanceAttributeRequest
DescribeInstanceAttributeResponse
DescribeInstanceRequest
DescribeInstanceResponse
DescribeInstanceStorageConfigRequest
DescribeInstanceStorageConfigResponse
DescribeQueueRequest
DescribeQueueResponse
DescribeQuickConnectRequest
DescribeQuickConnectResponse
DescribeRoutingProfileRequest
DescribeRoutingProfileResponse
DescribeSecurityProfileRequest
DescribeSecurityProfileResponse
DescribeUserHierarchyGroupRequest
DescribeUserHierarchyGroupResponse
DescribeUserHierarchyStructureRequest
DescribeUserHierarchyStructureResponse
DescribeUserRequest
DescribeUserResponse
Dimensions

Contains information about the dimensions for a set of metrics.

DisassociateApprovedOriginRequest
DisassociateBotRequest
DisassociateInstanceStorageConfigRequest
DisassociateLambdaFunctionRequest
DisassociateLexBotRequest
DisassociateQueueQuickConnectsRequest
DisassociateRoutingProfileQueuesRequest
DisassociateSecurityKeyRequest
EncryptionConfig

The encryption configuration.

Filters

Contains the filter to apply when retrieving metrics.

GetContactAttributesRequest
GetContactAttributesResponse
GetCurrentMetricDataRequest
GetCurrentMetricDataResponse
GetFederationTokenRequest
GetFederationTokenResponse
GetMetricDataRequest
GetMetricDataResponse
HierarchyGroup

Contains information about a hierarchy group.

HierarchyGroupSummary

Contains summary information about a hierarchy group.

HierarchyLevel

Contains information about a hierarchy level.

HierarchyLevelUpdate

Contains information about the hierarchy level to update.

HierarchyPath

Contains information about the levels of a hierarchy group.

HierarchyStructure

Contains information about a hierarchy structure.

HierarchyStructureUpdate

Contains information about the level hierarchy to update.

HistoricalMetric

Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

HistoricalMetricData

Contains the data for a historical metric.

HistoricalMetricResult

Contains information about the historical metrics retrieved.

HoursOfOperation

Information about of the hours of operation.

HoursOfOperationConfig

Contains information about the hours of operation.

HoursOfOperationSummary

Contains summary information about hours of operation for a contact center.

HoursOfOperationTimeSlice

The start time or end time for an hours of operation.

Instance

The Amazon Connect instance.

InstanceStatusReason

Relevant details why the instance was not successfully created.

InstanceStorageConfig

The storage configuration for the instance.

InstanceSummary

Information about the instance.

IntegrationAssociationSummary

Contains summary information about the associated AppIntegrations.

KinesisFirehoseConfig

Configuration information of a Kinesis Data Firehose delivery stream.

KinesisStreamConfig

Configuration information of a Kinesis data stream.

KinesisVideoStreamConfig

Configuration information of a Kinesis video stream.

LexBot

Configuration information of an Amazon Lex bot.

LexBotConfig

Configuration information of an Amazon Lex or Amazon Lex V2 bot.

LexV2Bot

Configuration information of an Amazon Lex V2 bot.

ListAgentStatusRequest
ListAgentStatusResponse
ListApprovedOriginsRequest
ListApprovedOriginsResponse
ListBotsRequest
ListBotsResponse
ListContactFlowModulesRequest
ListContactFlowModulesResponse
ListContactFlowsRequest
ListContactFlowsResponse
ListContactReferencesRequest
ListContactReferencesResponse
ListHoursOfOperationsRequest
ListHoursOfOperationsResponse
ListInstanceAttributesRequest
ListInstanceAttributesResponse
ListInstancesRequest
ListInstancesResponse
ListInstanceStorageConfigsRequest
ListInstanceStorageConfigsResponse
ListIntegrationAssociationsRequest
ListIntegrationAssociationsResponse
ListLambdaFunctionsRequest
ListLambdaFunctionsResponse
ListLexBotsRequest
ListLexBotsResponse
ListPhoneNumbersRequest
ListPhoneNumbersResponse
ListPromptsRequest
ListPromptsResponse
ListQueueQuickConnectsRequest
ListQueueQuickConnectsResponse
ListQueuesRequest
ListQueuesResponse
ListQuickConnectsRequest
ListQuickConnectsResponse
ListRoutingProfileQueuesRequest
ListRoutingProfileQueuesResponse
ListRoutingProfilesRequest
ListRoutingProfilesResponse
ListSecurityKeysRequest
ListSecurityKeysResponse
ListSecurityProfilePermissionsRequest
ListSecurityProfilePermissionsResponse
ListSecurityProfilesRequest
ListSecurityProfilesResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
ListUseCasesRequest

Provides summary information about the use cases for the specified integration association.

ListUseCasesResponse
ListUserHierarchyGroupsRequest
ListUserHierarchyGroupsResponse
ListUsersRequest
ListUsersResponse
MediaConcurrency

Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.

OutboundCallerConfig

The outbound caller ID name, number, and outbound whisper flow.

ParticipantDetails

The customer's details.

PhoneNumberQuickConnectConfig

Contains information about a phone number for a quick connect.

PhoneNumberSummary

Contains summary information about a phone number for a contact center.

PromptSummary

Contains information about the prompt.

Queue

Contains information about a queue.

QueueInfo

If this contact was queued, this contains information about the queue.

QueueQuickConnectConfig

Contains information about a queue for a quick connect. The contact flow must be of type Transfer to Queue.

QueueReference

Contains information about a queue resource for which metrics are returned.

QueueSummary

Contains summary information about a queue.

QuickConnect

Contains information about a quick connect.

QuickConnectConfig

Contains configuration settings for a quick connect.

QuickConnectSummary

Contains summary information about a quick connect.

Reference

A link that an agent selects to complete a given task. You can have up to 4,096 UTF-8 bytes across all references for a contact.

ReferenceSummary

Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.

ResumeContactRecordingRequest
RoutingProfile

Contains information about a routing profile.

RoutingProfileQueueConfig

Contains information about the queue and channel for which priority and delay can be set.

RoutingProfileQueueConfigSummary

Contains summary information about a routing profile queue.

RoutingProfileQueueReference

Contains the channel and queue identifier for a routing profile.

RoutingProfileSummary

Contains summary information about a routing profile.

S3Config

Information about the Amazon Simple Storage Service (Amazon S3) storage type.

SecurityKey

Configuration information of the security key.

SecurityProfile

Contains information about a security profile.

SecurityProfileSummary

Contains information about a security profile.

StartChatContactRequest
StartChatContactResponse
StartContactRecordingRequest
StartContactStreamingRequest
StartContactStreamingResponse
StartOutboundVoiceContactRequest
StartOutboundVoiceContactResponse
StartTaskContactRequest
StartTaskContactResponse
StopContactRecordingRequest
StopContactRequest
StopContactStreamingRequest
SuspendContactRecordingRequest
TagResourceRequest
Threshold

Contains information about the threshold for service level metrics.

UntagResourceRequest
UpdateAgentStatusRequest
UpdateContactAttributesRequest
UpdateContactFlowContentRequest
UpdateContactFlowMetadataRequest
UpdateContactFlowModuleContentRequest
UpdateContactFlowModuleMetadataRequest
UpdateContactFlowNameRequest
UpdateContactRequest
UpdateContactScheduleRequest
UpdateHoursOfOperationRequest
UpdateInstanceAttributeRequest
UpdateInstanceStorageConfigRequest
UpdateQueueHoursOfOperationRequest
UpdateQueueMaxContactsRequest
UpdateQueueNameRequest
UpdateQueueOutboundCallerConfigRequest
UpdateQueueStatusRequest
UpdateQuickConnectConfigRequest
UpdateQuickConnectNameRequest
UpdateRoutingProfileConcurrencyRequest
UpdateRoutingProfileDefaultOutboundQueueRequest
UpdateRoutingProfileNameRequest
UpdateRoutingProfileQueuesRequest
UpdateSecurityProfileRequest
UpdateUserHierarchyGroupNameRequest
UpdateUserHierarchyRequest
UpdateUserHierarchyStructureRequest
UpdateUserIdentityInfoRequest
UpdateUserPhoneConfigRequest
UpdateUserRoutingProfileRequest
UpdateUserSecurityProfilesRequest
UrlReference

The URL reference.

UseCase

Contains the use case.

User

Contains information about a user account for a Amazon Connect instance.

UserIdentityInfo

Contains information about the identity of a user.

UserPhoneConfig

Contains information about the phone configuration settings for a user.

UserQuickConnectConfig

Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.

UserSummary

Contains summary information about a user.

VoiceRecordingConfiguration

Contains information about the recording configuration settings.

§Type Aliases

AgentStatusState
AgentStatusType
Channel
Comparison
ContactFlowModuleState
ContactFlowModuleStatus
ContactFlowState
ContactFlowType
ContactInitiationMethod
CurrentMetricName

The current metric names.

DirectoryType
EncryptionType
Grouping
HistoricalMetricName

The historical metric names.

HoursOfOperationDays
InstanceAttributeType
InstanceStatus
InstanceStorageResourceType
IntegrationType
LexVersion
PhoneNumberCountryCode
PhoneNumberType
PhoneType
QueueStatus
QueueType
QuickConnectType
ReferenceStatus
ReferenceType
SourceType
Statistic
StorageType
TrafficType
Unit
UseCaseType
VoiceRecordingTrack