Connect

import { Connect } from "https://aws-api.deno.dev/v0.4/services/connect.ts?docs=full";

class Connect {

constructor(apiFactory: client.ApiFactory);

async associateApprovedOrigin(params: AssociateApprovedOriginRequest, opts?: client.RequestOptions): Promise<void>;

async associateBot(params: AssociateBotRequest, opts?: client.RequestOptions): Promise<void>;

async associateDefaultVocabulary(params: AssociateDefaultVocabularyRequest, opts?: client.RequestOptions): Promise<void>;

async associateInstanceStorageConfig(params: AssociateInstanceStorageConfigRequest, opts?: client.RequestOptions): Promise<AssociateInstanceStorageConfigResponse>;

async associateLambdaFunction(params: AssociateLambdaFunctionRequest, opts?: client.RequestOptions): Promise<void>;

async associateLexBot(params: AssociateLexBotRequest, opts?: client.RequestOptions): Promise<void>;

async associatePhoneNumberContactFlow(params: AssociatePhoneNumberContactFlowRequest, opts?: client.RequestOptions): Promise<void>;

async associateQueueQuickConnects(params: AssociateQueueQuickConnectsRequest, opts?: client.RequestOptions): Promise<void>;

async associateRoutingProfileQueues(params: AssociateRoutingProfileQueuesRequest, opts?: client.RequestOptions): Promise<void>;

async associateSecurityKey(params: AssociateSecurityKeyRequest, opts?: client.RequestOptions): Promise<AssociateSecurityKeyResponse>;

async claimPhoneNumber(params: ClaimPhoneNumberRequest, opts?: client.RequestOptions): Promise<ClaimPhoneNumberResponse>;

async createAgentStatus(params: CreateAgentStatusRequest, opts?: client.RequestOptions): Promise<CreateAgentStatusResponse>;

async createContactFlow(params: CreateContactFlowRequest, opts?: client.RequestOptions): Promise<CreateContactFlowResponse>;

async createContactFlowModule(params: CreateContactFlowModuleRequest, opts?: client.RequestOptions): Promise<CreateContactFlowModuleResponse>;

async createHoursOfOperation(params: CreateHoursOfOperationRequest, opts?: client.RequestOptions): Promise<CreateHoursOfOperationResponse>;

async createInstance(params: CreateInstanceRequest, opts?: client.RequestOptions): Promise<CreateInstanceResponse>;

async createIntegrationAssociation(params: CreateIntegrationAssociationRequest, opts?: client.RequestOptions): Promise<CreateIntegrationAssociationResponse>;

async createQueue(params: CreateQueueRequest, opts?: client.RequestOptions): Promise<CreateQueueResponse>;

async createQuickConnect(params: CreateQuickConnectRequest, opts?: client.RequestOptions): Promise<CreateQuickConnectResponse>;

async createRoutingProfile(params: CreateRoutingProfileRequest, opts?: client.RequestOptions): Promise<CreateRoutingProfileResponse>;

async createRule(params: CreateRuleRequest, opts?: client.RequestOptions): Promise<CreateRuleResponse>;

async createSecurityProfile(params: CreateSecurityProfileRequest, opts?: client.RequestOptions): Promise<CreateSecurityProfileResponse>;

async createTaskTemplate(params: CreateTaskTemplateRequest, opts?: client.RequestOptions): Promise<CreateTaskTemplateResponse>;

async createTrafficDistributionGroup(params: CreateTrafficDistributionGroupRequest, opts?: client.RequestOptions): Promise<CreateTrafficDistributionGroupResponse>;

async createUseCase(params: CreateUseCaseRequest, opts?: client.RequestOptions): Promise<CreateUseCaseResponse>;

async createUser(params: CreateUserRequest, opts?: client.RequestOptions): Promise<CreateUserResponse>;

async createUserHierarchyGroup(params: CreateUserHierarchyGroupRequest, opts?: client.RequestOptions): Promise<CreateUserHierarchyGroupResponse>;

async createVocabulary(params: CreateVocabularyRequest, opts?: client.RequestOptions): Promise<CreateVocabularyResponse>;

async deleteContactFlow(params: DeleteContactFlowRequest, opts?: client.RequestOptions): Promise<void>;

async deleteContactFlowModule(params: DeleteContactFlowModuleRequest, opts?: client.RequestOptions): Promise<void>;

async deleteHoursOfOperation(params: DeleteHoursOfOperationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteInstance(params: DeleteInstanceRequest, opts?: client.RequestOptions): Promise<void>;

async deleteIntegrationAssociation(params: DeleteIntegrationAssociationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteQuickConnect(params: DeleteQuickConnectRequest, opts?: client.RequestOptions): Promise<void>;

async deleteRule(params: DeleteRuleRequest, opts?: client.RequestOptions): Promise<void>;

async deleteSecurityProfile(params: DeleteSecurityProfileRequest, opts?: client.RequestOptions): Promise<void>;

async deleteTaskTemplate(params: DeleteTaskTemplateRequest, opts?: client.RequestOptions): Promise<void>;

async deleteTrafficDistributionGroup(params: DeleteTrafficDistributionGroupRequest, opts?: client.RequestOptions): Promise<void>;

async deleteUseCase(params: DeleteUseCaseRequest, opts?: client.RequestOptions): Promise<void>;

async deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<void>;

async deleteUserHierarchyGroup(params: DeleteUserHierarchyGroupRequest, opts?: client.RequestOptions): Promise<void>;

async deleteVocabulary(params: DeleteVocabularyRequest, opts?: client.RequestOptions): Promise<DeleteVocabularyResponse>;

async describeAgentStatus(params: DescribeAgentStatusRequest, opts?: client.RequestOptions): Promise<DescribeAgentStatusResponse>;

async describeContact(params: DescribeContactRequest, opts?: client.RequestOptions): Promise<DescribeContactResponse>;

async describeContactFlow(params: DescribeContactFlowRequest, opts?: client.RequestOptions): Promise<DescribeContactFlowResponse>;

async describeContactFlowModule(params: DescribeContactFlowModuleRequest, opts?: client.RequestOptions): Promise<DescribeContactFlowModuleResponse>;

async describeHoursOfOperation(params: DescribeHoursOfOperationRequest, opts?: client.RequestOptions): Promise<DescribeHoursOfOperationResponse>;

async describeInstance(params: DescribeInstanceRequest, opts?: client.RequestOptions): Promise<DescribeInstanceResponse>;

async describeInstanceAttribute(params: DescribeInstanceAttributeRequest, opts?: client.RequestOptions): Promise<DescribeInstanceAttributeResponse>;

async describeInstanceStorageConfig(params: DescribeInstanceStorageConfigRequest, opts?: client.RequestOptions): Promise<DescribeInstanceStorageConfigResponse>;

async describePhoneNumber(params: DescribePhoneNumberRequest, opts?: client.RequestOptions): Promise<DescribePhoneNumberResponse>;

async describeQueue(params: DescribeQueueRequest, opts?: client.RequestOptions): Promise<DescribeQueueResponse>;

async describeQuickConnect(params: DescribeQuickConnectRequest, opts?: client.RequestOptions): Promise<DescribeQuickConnectResponse>;

async describeRoutingProfile(params: DescribeRoutingProfileRequest, opts?: client.RequestOptions): Promise<DescribeRoutingProfileResponse>;

async describeRule(params: DescribeRuleRequest, opts?: client.RequestOptions): Promise<DescribeRuleResponse>;

async describeSecurityProfile(params: DescribeSecurityProfileRequest, opts?: client.RequestOptions): Promise<DescribeSecurityProfileResponse>;

async describeTrafficDistributionGroup(params: DescribeTrafficDistributionGroupRequest, opts?: client.RequestOptions): Promise<DescribeTrafficDistributionGroupResponse>;

async describeUser(params: DescribeUserRequest, opts?: client.RequestOptions): Promise<DescribeUserResponse>;

async describeUserHierarchyGroup(params: DescribeUserHierarchyGroupRequest, opts?: client.RequestOptions): Promise<DescribeUserHierarchyGroupResponse>;

async describeUserHierarchyStructure(params: DescribeUserHierarchyStructureRequest, opts?: client.RequestOptions): Promise<DescribeUserHierarchyStructureResponse>;

async describeVocabulary(params: DescribeVocabularyRequest, opts?: client.RequestOptions): Promise<DescribeVocabularyResponse>;

async disassociateApprovedOrigin(params: DisassociateApprovedOriginRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateBot(params: DisassociateBotRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateInstanceStorageConfig(params: DisassociateInstanceStorageConfigRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateLambdaFunction(params: DisassociateLambdaFunctionRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateLexBot(params: DisassociateLexBotRequest, opts?: client.RequestOptions): Promise<void>;

async disassociatePhoneNumberContactFlow(params: DisassociatePhoneNumberContactFlowRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateQueueQuickConnects(params: DisassociateQueueQuickConnectsRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateRoutingProfileQueues(params: DisassociateRoutingProfileQueuesRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateSecurityKey(params: DisassociateSecurityKeyRequest, opts?: client.RequestOptions): Promise<void>;

async dismissUserContact(params: DismissUserContactRequest, opts?: client.RequestOptions): Promise<void>;

async getContactAttributes(params: GetContactAttributesRequest, opts?: client.RequestOptions): Promise<GetContactAttributesResponse>;

async getCurrentMetricData(params: GetCurrentMetricDataRequest, opts?: client.RequestOptions): Promise<GetCurrentMetricDataResponse>;

async getCurrentUserData(params: GetCurrentUserDataRequest, opts?: client.RequestOptions): Promise<GetCurrentUserDataResponse>;

async getFederationToken(params: GetFederationTokenRequest, opts?: client.RequestOptions): Promise<GetFederationTokenResponse>;

async getMetricData(params: GetMetricDataRequest, opts?: client.RequestOptions): Promise<GetMetricDataResponse>;

async getTaskTemplate(params: GetTaskTemplateRequest, opts?: client.RequestOptions): Promise<GetTaskTemplateResponse>;

async getTrafficDistribution(params: GetTrafficDistributionRequest, opts?: client.RequestOptions): Promise<GetTrafficDistributionResponse>;

async listAgentStatuses(params: ListAgentStatusRequest, opts?: client.RequestOptions): Promise<ListAgentStatusResponse>;

async listApprovedOrigins(params: ListApprovedOriginsRequest, opts?: client.RequestOptions): Promise<ListApprovedOriginsResponse>;

async listBots(params: ListBotsRequest, opts?: client.RequestOptions): Promise<ListBotsResponse>;

async listContactFlowModules(params: ListContactFlowModulesRequest, opts?: client.RequestOptions): Promise<ListContactFlowModulesResponse>;

async listContactFlows(params: ListContactFlowsRequest, opts?: client.RequestOptions): Promise<ListContactFlowsResponse>;

async listContactReferences(params: ListContactReferencesRequest, opts?: client.RequestOptions): Promise<ListContactReferencesResponse>;

async listDefaultVocabularies(params: ListDefaultVocabulariesRequest, opts?: client.RequestOptions): Promise<ListDefaultVocabulariesResponse>;

async listHoursOfOperations(params: ListHoursOfOperationsRequest, opts?: client.RequestOptions): Promise<ListHoursOfOperationsResponse>;

async listInstanceAttributes(params: ListInstanceAttributesRequest, opts?: client.RequestOptions): Promise<ListInstanceAttributesResponse>;

async listInstances(params?: ListInstancesRequest, opts?: client.RequestOptions): Promise<ListInstancesResponse>;

async listInstanceStorageConfigs(params: ListInstanceStorageConfigsRequest, opts?: client.RequestOptions): Promise<ListInstanceStorageConfigsResponse>;

async listIntegrationAssociations(params: ListIntegrationAssociationsRequest, opts?: client.RequestOptions): Promise<ListIntegrationAssociationsResponse>;

async listLambdaFunctions(params: ListLambdaFunctionsRequest, opts?: client.RequestOptions): Promise<ListLambdaFunctionsResponse>;

async listLexBots(params: ListLexBotsRequest, opts?: client.RequestOptions): Promise<ListLexBotsResponse>;

async listPhoneNumbers(params: ListPhoneNumbersRequest, opts?: client.RequestOptions): Promise<ListPhoneNumbersResponse>;

async listPhoneNumbersV2(params?: ListPhoneNumbersV2Request, opts?: client.RequestOptions): Promise<ListPhoneNumbersV2Response>;

async listPrompts(params: ListPromptsRequest, opts?: client.RequestOptions): Promise<ListPromptsResponse>;

async listQueueQuickConnects(params: ListQueueQuickConnectsRequest, opts?: client.RequestOptions): Promise<ListQueueQuickConnectsResponse>;

async listQueues(params: ListQueuesRequest, opts?: client.RequestOptions): Promise<ListQueuesResponse>;

async listQuickConnects(params: ListQuickConnectsRequest, opts?: client.RequestOptions): Promise<ListQuickConnectsResponse>;

async listRoutingProfileQueues(params: ListRoutingProfileQueuesRequest, opts?: client.RequestOptions): Promise<ListRoutingProfileQueuesResponse>;

async listRoutingProfiles(params: ListRoutingProfilesRequest, opts?: client.RequestOptions): Promise<ListRoutingProfilesResponse>;

async listRules(params: ListRulesRequest, opts?: client.RequestOptions): Promise<ListRulesResponse>;

async listSecurityKeys(params: ListSecurityKeysRequest, opts?: client.RequestOptions): Promise<ListSecurityKeysResponse>;

async listSecurityProfilePermissions(params: ListSecurityProfilePermissionsRequest, opts?: client.RequestOptions): Promise<ListSecurityProfilePermissionsResponse>;

async listSecurityProfiles(params: ListSecurityProfilesRequest, opts?: client.RequestOptions): Promise<ListSecurityProfilesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTaskTemplates(params: ListTaskTemplatesRequest, opts?: client.RequestOptions): Promise<ListTaskTemplatesResponse>;

async listTrafficDistributionGroups(params?: ListTrafficDistributionGroupsRequest, opts?: client.RequestOptions): Promise<ListTrafficDistributionGroupsResponse>;

async listUseCases(params: ListUseCasesRequest, opts?: client.RequestOptions): Promise<ListUseCasesResponse>;

async listUserHierarchyGroups(params: ListUserHierarchyGroupsRequest, opts?: client.RequestOptions): Promise<ListUserHierarchyGroupsResponse>;

async listUsers(params: ListUsersRequest, opts?: client.RequestOptions): Promise<ListUsersResponse>;

async monitorContact(params: MonitorContactRequest, opts?: client.RequestOptions): Promise<MonitorContactResponse>;

async putUserStatus(params: PutUserStatusRequest, opts?: client.RequestOptions): Promise<void>;

async releasePhoneNumber(params: ReleasePhoneNumberRequest, opts?: client.RequestOptions): Promise<void>;

async replicateInstance(params: ReplicateInstanceRequest, opts?: client.RequestOptions): Promise<ReplicateInstanceResponse>;

async resumeContactRecording(params: ResumeContactRecordingRequest, opts?: client.RequestOptions): Promise<void>;

async searchAvailablePhoneNumbers(params: SearchAvailablePhoneNumbersRequest, opts?: client.RequestOptions): Promise<SearchAvailablePhoneNumbersResponse>;

async searchQueues(params: SearchQueuesRequest, opts?: client.RequestOptions): Promise<SearchQueuesResponse>;

async searchRoutingProfiles(params: SearchRoutingProfilesRequest, opts?: client.RequestOptions): Promise<SearchRoutingProfilesResponse>;

async searchSecurityProfiles(params: SearchSecurityProfilesRequest, opts?: client.RequestOptions): Promise<SearchSecurityProfilesResponse>;

async searchUsers(params?: SearchUsersRequest, opts?: client.RequestOptions): Promise<SearchUsersResponse>;

async searchVocabularies(params: SearchVocabulariesRequest, opts?: client.RequestOptions): Promise<SearchVocabulariesResponse>;

async startChatContact(params: StartChatContactRequest, opts?: client.RequestOptions): Promise<StartChatContactResponse>;

async startContactRecording(params: StartContactRecordingRequest, opts?: client.RequestOptions): Promise<void>;

async startContactStreaming(params: StartContactStreamingRequest, opts?: client.RequestOptions): Promise<StartContactStreamingResponse>;

async startOutboundVoiceContact(params: StartOutboundVoiceContactRequest, opts?: client.RequestOptions): Promise<StartOutboundVoiceContactResponse>;

async startTaskContact(params: StartTaskContactRequest, opts?: client.RequestOptions): Promise<StartTaskContactResponse>;

async stopContact(params: StopContactRequest, opts?: client.RequestOptions): Promise<void>;

async stopContactRecording(params: StopContactRecordingRequest, opts?: client.RequestOptions): Promise<void>;

async stopContactStreaming(params: StopContactStreamingRequest, opts?: client.RequestOptions): Promise<void>;

async suspendContactRecording(params: SuspendContactRecordingRequest, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async transferContact(params: TransferContactRequest, opts?: client.RequestOptions): Promise<TransferContactResponse>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateAgentStatus(params: UpdateAgentStatusRequest, opts?: client.RequestOptions): Promise<void>;

async updateContact(params: UpdateContactRequest, opts?: client.RequestOptions): Promise<void>;

async updateContactAttributes(params: UpdateContactAttributesRequest, opts?: client.RequestOptions): Promise<void>;

async updateContactFlowContent(params: UpdateContactFlowContentRequest, opts?: client.RequestOptions): Promise<void>;

async updateContactFlowMetadata(params: UpdateContactFlowMetadataRequest, opts?: client.RequestOptions): Promise<void>;

async updateContactFlowModuleContent(params: UpdateContactFlowModuleContentRequest, opts?: client.RequestOptions): Promise<void>;

async updateContactFlowModuleMetadata(params: UpdateContactFlowModuleMetadataRequest, opts?: client.RequestOptions): Promise<void>;

async updateContactFlowName(params: UpdateContactFlowNameRequest, opts?: client.RequestOptions): Promise<void>;

async updateContactSchedule(params: UpdateContactScheduleRequest, opts?: client.RequestOptions): Promise<void>;

async updateHoursOfOperation(params: UpdateHoursOfOperationRequest, opts?: client.RequestOptions): Promise<void>;

async updateInstanceAttribute(params: UpdateInstanceAttributeRequest, opts?: client.RequestOptions): Promise<void>;

async updateInstanceStorageConfig(params: UpdateInstanceStorageConfigRequest, opts?: client.RequestOptions): Promise<void>;

async updateParticipantRoleConfig(params: UpdateParticipantRoleConfigRequest, opts?: client.RequestOptions): Promise<void>;

async updatePhoneNumber(params: UpdatePhoneNumberRequest, opts?: client.RequestOptions): Promise<UpdatePhoneNumberResponse>;

async updateQueueHoursOfOperation(params: UpdateQueueHoursOfOperationRequest, opts?: client.RequestOptions): Promise<void>;

async updateQueueMaxContacts(params: UpdateQueueMaxContactsRequest, opts?: client.RequestOptions): Promise<void>;

async updateQueueName(params: UpdateQueueNameRequest, opts?: client.RequestOptions): Promise<void>;

async updateQueueOutboundCallerConfig(params: UpdateQueueOutboundCallerConfigRequest, opts?: client.RequestOptions): Promise<void>;

async updateQueueStatus(params: UpdateQueueStatusRequest, opts?: client.RequestOptions): Promise<void>;

async updateQuickConnectConfig(params: UpdateQuickConnectConfigRequest, opts?: client.RequestOptions): Promise<void>;

async updateQuickConnectName(params: UpdateQuickConnectNameRequest, opts?: client.RequestOptions): Promise<void>;

async updateRoutingProfileConcurrency(params: UpdateRoutingProfileConcurrencyRequest, opts?: client.RequestOptions): Promise<void>;

async updateRoutingProfileDefaultOutboundQueue(params: UpdateRoutingProfileDefaultOutboundQueueRequest, opts?: client.RequestOptions): Promise<void>;

async updateRoutingProfileName(params: UpdateRoutingProfileNameRequest, opts?: client.RequestOptions): Promise<void>;

async updateRoutingProfileQueues(params: UpdateRoutingProfileQueuesRequest, opts?: client.RequestOptions): Promise<void>;

async updateRule(params: UpdateRuleRequest, opts?: client.RequestOptions): Promise<void>;

async updateSecurityProfile(params: UpdateSecurityProfileRequest, opts?: client.RequestOptions): Promise<void>;

async updateTaskTemplate(params: UpdateTaskTemplateRequest, opts?: client.RequestOptions): Promise<UpdateTaskTemplateResponse>;

async updateTrafficDistribution(params: UpdateTrafficDistributionRequest, opts?: client.RequestOptions): Promise<void>;

async updateUserHierarchy(params: UpdateUserHierarchyRequest, opts?: client.RequestOptions): Promise<void>;

async updateUserHierarchyGroupName(params: UpdateUserHierarchyGroupNameRequest, opts?: client.RequestOptions): Promise<void>;

async updateUserHierarchyStructure(params: UpdateUserHierarchyStructureRequest, opts?: client.RequestOptions): Promise<void>;

async updateUserIdentityInfo(params: UpdateUserIdentityInfoRequest, opts?: client.RequestOptions): Promise<void>;

async updateUserPhoneConfig(params: UpdateUserPhoneConfigRequest, opts?: client.RequestOptions): Promise<void>;

async updateUserRoutingProfile(params: UpdateUserRoutingProfileRequest, opts?: client.RequestOptions): Promise<void>;

async updateUserSecurityProfiles(params: UpdateUserSecurityProfilesRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Connect(apiFactory: client.ApiFactory)

[src]

§Methods

associateApprovedOrigin(params: AssociateApprovedOriginRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Associates an approved origin to an Amazon Connect instance.

associateBot(params: AssociateBotRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.

associateDefaultVocabulary(params: AssociateDefaultVocabularyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

associateInstanceStorageConfig(params: AssociateInstanceStorageConfigRequest, opts?: client.RequestOptions): Promise<AssociateInstanceStorageConfigResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.

This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

associateLambdaFunction(params: AssociateLambdaFunctionRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Lambda function.

associateLexBot(params: AssociateLexBotRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.

associatePhoneNumberContactFlow(params: AssociatePhoneNumberContactFlowRequest, opts?: client.RequestOptions): Promise<void>

[src]

Associates a flow with a phone number claimed to your Amazon Connect instance.

! IMPORTANT: ! If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. ! However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. ! If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

associateQueueQuickConnects(params: AssociateQueueQuickConnectsRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Associates a set of quick connects with a queue.

associateRoutingProfileQueues(params: AssociateRoutingProfileQueuesRequest, opts?: client.RequestOptions): Promise<void>

[src]

Associates a set of queues with a routing profile.

associateSecurityKey(params: AssociateSecurityKeyRequest, opts?: client.RequestOptions): Promise<AssociateSecurityKeyResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Associates a security key to the instance.

claimPhoneNumber(params: ClaimPhoneNumberRequest, opts?: client.RequestOptions): Promise<ClaimPhoneNumberResponse>

[src]

Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.

! IMPORTANT: ! You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. ! Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.

createAgentStatus(params: CreateAgentStatusRequest, opts?: client.RequestOptions): Promise<CreateAgentStatusResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Creates an agent status for the specified Amazon Connect instance.

createContactFlow(params: CreateContactFlowRequest, opts?: client.RequestOptions): Promise<CreateContactFlowResponse>

[src]

Creates a flow for the specified Amazon Connect instance.

You can also create and update flows using the Amazon Connect Flow language.

createContactFlowModule(params: CreateContactFlowModuleRequest, opts?: client.RequestOptions): Promise<CreateContactFlowModuleResponse>

[src]

Creates a flow module for the specified Amazon Connect instance.

createHoursOfOperation(params: CreateHoursOfOperationRequest, opts?: client.RequestOptions): Promise<CreateHoursOfOperationResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Creates hours of operation.

createInstance(params: CreateInstanceRequest, opts?: client.RequestOptions): Promise<CreateInstanceResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

createIntegrationAssociation(params: CreateIntegrationAssociationRequest, opts?: client.RequestOptions): Promise<CreateIntegrationAssociationResponse>

[src]

Creates an Amazon Web Services resource association with an Amazon Connect instance.

createQueue(params: CreateQueueRequest, opts?: client.RequestOptions): Promise<CreateQueueResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Creates a new queue for the specified Amazon Connect instance.

! IMPORTANT: ! If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. ! However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. ! If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

createQuickConnect(params: CreateQuickConnectRequest, opts?: client.RequestOptions): Promise<CreateQuickConnectResponse>

[src]

Creates a quick connect for the specified Amazon Connect instance.

createRoutingProfile(params: CreateRoutingProfileRequest, opts?: client.RequestOptions): Promise<CreateRoutingProfileResponse>

[src]

Creates a new routing profile.

createRule(params: CreateRuleRequest, opts?: client.RequestOptions): Promise<CreateRuleResponse>

[src]

Creates a rule for the specified Amazon Connect instance.

Use the Rules Function language to code conditions for the rule.

createSecurityProfile(params: CreateSecurityProfileRequest, opts?: client.RequestOptions): Promise<CreateSecurityProfileResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Creates a security profile.

createTaskTemplate(params: CreateTaskTemplateRequest, opts?: client.RequestOptions): Promise<CreateTaskTemplateResponse>

[src]

Creates a new task template in the specified Amazon Connect instance.

createTrafficDistributionGroup(params: CreateTrafficDistributionGroupRequest, opts?: client.RequestOptions): Promise<CreateTrafficDistributionGroupResponse>

[src]

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.

createUseCase(params: CreateUseCaseRequest, opts?: client.RequestOptions): Promise<CreateUseCaseResponse>

[src]

Creates a use case for an integration association.

createUser(params: CreateUserRequest, opts?: client.RequestOptions): Promise<CreateUserResponse>

[src]

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

createUserHierarchyGroup(params: CreateUserHierarchyGroupRequest, opts?: client.RequestOptions): Promise<CreateUserHierarchyGroupResponse>

[src]

Creates a new user hierarchy group.

createVocabulary(params: CreateVocabularyRequest, opts?: client.RequestOptions): Promise<CreateVocabularyResponse>

[src]

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

deleteContactFlow(params: DeleteContactFlowRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a flow for the specified Amazon Connect instance.

deleteContactFlowModule(params: DeleteContactFlowModuleRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the specified flow module.

deleteHoursOfOperation(params: DeleteHoursOfOperationRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Deletes an hours of operation.

deleteInstance(params: DeleteInstanceRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Deletes the Amazon Connect instance.

deleteIntegrationAssociation(params: DeleteIntegrationAssociationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.

deleteQuickConnect(params: DeleteQuickConnectRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a quick connect.

deleteRule(params: DeleteRuleRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a rule for the specified Amazon Connect instance.

deleteSecurityProfile(params: DeleteSecurityProfileRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Deletes a security profile.

deleteTaskTemplate(params: DeleteTaskTemplateRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the task template.

deleteTrafficDistributionGroup(params: DeleteTrafficDistributionGroupRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.

deleteUseCase(params: DeleteUseCaseRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a use case from an integration association.

deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a user account from the specified Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

deleteUserHierarchyGroup(params: DeleteUserHierarchyGroupRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

deleteVocabulary(params: DeleteVocabularyRequest, opts?: client.RequestOptions): Promise<DeleteVocabularyResponse>

[src]

Deletes the vocabulary that has the given identifier.

describeAgentStatus(params: DescribeAgentStatusRequest, opts?: client.RequestOptions): Promise<DescribeAgentStatusResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Describes an agent status.

describeContact(params: DescribeContactRequest, opts?: client.RequestOptions): Promise<DescribeContactResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified contact.

! IMPORTANT: ! Contact information remains available in Amazon Connect for 24 months, and then it is deleted. ! Only data from November 12, 2021, and later is returned by this API.

describeContactFlow(params: DescribeContactFlowRequest, opts?: client.RequestOptions): Promise<DescribeContactFlowResponse>

[src]

Describes the specified flow.

You can also create and update flows using the Amazon Connect Flow language.

describeContactFlowModule(params: DescribeContactFlowModuleRequest, opts?: client.RequestOptions): Promise<DescribeContactFlowModuleResponse>

[src]

Describes the specified flow module.

describeHoursOfOperation(params: DescribeHoursOfOperationRequest, opts?: client.RequestOptions): Promise<DescribeHoursOfOperationResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Describes the hours of operation.

describeInstance(params: DescribeInstanceRequest, opts?: client.RequestOptions): Promise<DescribeInstanceResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

describeInstanceAttribute(params: DescribeInstanceAttributeRequest, opts?: client.RequestOptions): Promise<DescribeInstanceAttributeResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified instance attribute.

describeInstanceStorageConfig(params: DescribeInstanceStorageConfigRequest, opts?: client.RequestOptions): Promise<DescribeInstanceStorageConfigResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

describePhoneNumber(params: DescribePhoneNumberRequest, opts?: client.RequestOptions): Promise<DescribePhoneNumberResponse>

[src]

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.

! IMPORTANT: ! If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. ! However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. ! If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

describeQueue(params: DescribeQueueRequest, opts?: client.RequestOptions): Promise<DescribeQueueResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified queue.

describeQuickConnect(params: DescribeQuickConnectRequest, opts?: client.RequestOptions): Promise<DescribeQuickConnectResponse>

[src]

Describes the quick connect.

describeRoutingProfile(params: DescribeRoutingProfileRequest, opts?: client.RequestOptions): Promise<DescribeRoutingProfileResponse>

[src]

Describes the specified routing profile.

describeRule(params: DescribeRuleRequest, opts?: client.RequestOptions): Promise<DescribeRuleResponse>

[src]

Describes a rule for the specified Amazon Connect instance.

describeSecurityProfile(params: DescribeSecurityProfileRequest, opts?: client.RequestOptions): Promise<DescribeSecurityProfileResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Gets basic information about the security profle.

describeTrafficDistributionGroup(params: DescribeTrafficDistributionGroupRequest, opts?: client.RequestOptions): Promise<DescribeTrafficDistributionGroupResponse>

[src]

Gets details and status of a traffic distribution group.

describeUser(params: DescribeUserRequest, opts?: client.RequestOptions): Promise<DescribeUserResponse>

[src]

Describes the specified user account. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

describeUserHierarchyGroup(params: DescribeUserHierarchyGroupRequest, opts?: client.RequestOptions): Promise<DescribeUserHierarchyGroupResponse>

[src]

Describes the specified hierarchy group.

describeUserHierarchyStructure(params: DescribeUserHierarchyStructureRequest, opts?: client.RequestOptions): Promise<DescribeUserHierarchyStructureResponse>

[src]

Describes the hierarchy structure of the specified Amazon Connect instance.

describeVocabulary(params: DescribeVocabularyRequest, opts?: client.RequestOptions): Promise<DescribeVocabularyResponse>

[src]

Describes the specified vocabulary.

disassociateApprovedOrigin(params: DisassociateApprovedOriginRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Revokes access to integrated applications from Amazon Connect.

disassociateBot(params: DisassociateBotRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

disassociateInstanceStorageConfig(params: DisassociateInstanceStorageConfigRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Removes the storage type configurations for the specified resource type and association ID.

disassociateLambdaFunction(params: DisassociateLambdaFunctionRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Remove the Lambda function from the dropdown options available in the relevant flow blocks.

disassociateLexBot(params: DisassociateLexBotRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

disassociatePhoneNumberContactFlow(params: DisassociatePhoneNumberContactFlowRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes the flow association from a phone number claimed to your Amazon Connect instance.

disassociateQueueQuickConnects(params: DisassociateQueueQuickConnectsRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Disassociates a set of quick connects from a queue.

disassociateRoutingProfileQueues(params: DisassociateRoutingProfileQueuesRequest, opts?: client.RequestOptions): Promise<void>

[src]

Disassociates a set of queues from a routing profile.

disassociateSecurityKey(params: DisassociateSecurityKeyRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Deletes the specified security key.

dismissUserContact(params: DismissUserContactRequest, opts?: client.RequestOptions): Promise<void>

[src]

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.

getContactAttributes(params: GetContactAttributesRequest, opts?: client.RequestOptions): Promise<GetContactAttributesResponse>

[src]

Retrieves the contact attributes for the specified contact.

getCurrentMetricData(params: GetCurrentMetricDataRequest, opts?: client.RequestOptions): Promise<GetCurrentMetricDataResponse>

[src]

Gets the real-time metric data from the specified Amazon Connect instance.

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

getCurrentUserData(params: GetCurrentUserDataRequest, opts?: client.RequestOptions): Promise<GetCurrentUserDataResponse>

[src]

Gets the real-time active user data from the specified Amazon Connect instance.

getFederationToken(params: GetFederationTokenRequest, opts?: client.RequestOptions): Promise<GetFederationTokenResponse>

[src]

Retrieves a token for federation.

Note: This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

getMetricData(params: GetMetricDataRequest, opts?: client.RequestOptions): Promise<GetMetricDataResponse>

[src]

Gets historical metric data from the specified Amazon Connect instance.

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

getTaskTemplate(params: GetTaskTemplateRequest, opts?: client.RequestOptions): Promise<GetTaskTemplateResponse>

[src]

Gets details about a specific task template in the specified Amazon Connect instance.

getTrafficDistribution(params: GetTrafficDistributionRequest, opts?: client.RequestOptions): Promise<GetTrafficDistributionResponse>

[src]

Retrieves the current traffic distribution for a given traffic distribution group.

listAgentStatuses(params: ListAgentStatusRequest, opts?: client.RequestOptions): Promise<ListAgentStatusResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Lists agent statuses.

listApprovedOrigins(params: ListApprovedOriginsRequest, opts?: client.RequestOptions): Promise<ListApprovedOriginsResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all approved origins associated with the instance.

listBots(params: ListBotsRequest, opts?: client.RequestOptions): Promise<ListBotsResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.

listContactFlowModules(params: ListContactFlowModulesRequest, opts?: client.RequestOptions): Promise<ListContactFlowModulesResponse>

[src]

Provides information about the flow modules for the specified Amazon Connect instance.

listContactFlows(params: ListContactFlowsRequest, opts?: client.RequestOptions): Promise<ListContactFlowsResponse>

[src]

Provides information about the flows for the specified Amazon Connect instance.

You can also create and update flows using the Amazon Connect Flow language.

For more information about flows, see Flows in the Amazon Connect Administrator Guide.

listContactReferences(params: ListContactReferencesRequest, opts?: client.RequestOptions): Promise<ListContactReferencesResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

For the specified referenceTypes, returns a list of references associated with the contact.

listDefaultVocabularies(params: ListDefaultVocabulariesRequest, opts?: client.RequestOptions): Promise<ListDefaultVocabulariesResponse>

[src]

Lists the default vocabularies for the specified Amazon Connect instance.

listHoursOfOperations(params: ListHoursOfOperationsRequest, opts?: client.RequestOptions): Promise<ListHoursOfOperationsResponse>

[src]

Provides information about the hours of operation for the specified Amazon Connect instance.

For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

listInstanceAttributes(params: ListInstanceAttributesRequest, opts?: client.RequestOptions): Promise<ListInstanceAttributesResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all attribute types for the given instance.

listInstances(params?: ListInstancesRequest, opts?: client.RequestOptions): Promise<ListInstancesResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

listInstanceStorageConfigs(params: ListInstanceStorageConfigsRequest, opts?: client.RequestOptions): Promise<ListInstanceStorageConfigsResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of storage configs for the identified instance and resource type.

listIntegrationAssociations(params: ListIntegrationAssociationsRequest, opts?: client.RequestOptions): Promise<ListIntegrationAssociationsResponse>

[src]

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

listLambdaFunctions(params: ListLambdaFunctionsRequest, opts?: client.RequestOptions): Promise<ListLambdaFunctionsResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.

listLexBots(params: ListLexBotsRequest, opts?: client.RequestOptions): Promise<ListLexBotsResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.

listPhoneNumbers(params: ListPhoneNumbersRequest, opts?: client.RequestOptions): Promise<ListPhoneNumbersResponse>

[src]

Provides information about the phone numbers for the specified Amazon Connect instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

! IMPORTANT: ! The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. ! It will fail with a ResourceNotFoundException. ! Instead, use the ListPhoneNumbersV2 API. ! It returns the new phone number ARN that can be used to tag phone number resources.

listPhoneNumbersV2(params?: ListPhoneNumbersV2Request, opts?: client.RequestOptions): Promise<ListPhoneNumbersV2Response>

[src]

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

listPrompts(params: ListPromptsRequest, opts?: client.RequestOptions): Promise<ListPromptsResponse>

[src]

Provides information about the prompts for the specified Amazon Connect instance.

listQueueQuickConnects(params: ListQueueQuickConnectsRequest, opts?: client.RequestOptions): Promise<ListQueueQuickConnectsResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Lists the quick connects associated with a queue.

listQueues(params: ListQueuesRequest, opts?: client.RequestOptions): Promise<ListQueuesResponse>

[src]

Provides information about the queues for the specified Amazon Connect instance.

If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

listQuickConnects(params: ListQuickConnectsRequest, opts?: client.RequestOptions): Promise<ListQuickConnectsResponse>

[src]

Provides information about the quick connects for the specified Amazon Connect instance.

listRoutingProfileQueues(params: ListRoutingProfileQueuesRequest, opts?: client.RequestOptions): Promise<ListRoutingProfileQueuesResponse>

[src]

Lists the queues associated with a routing profile.

listRoutingProfiles(params: ListRoutingProfilesRequest, opts?: client.RequestOptions): Promise<ListRoutingProfilesResponse>

[src]

Provides summary information about the routing profiles for the specified Amazon Connect instance.

For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

listRules(params: ListRulesRequest, opts?: client.RequestOptions): Promise<ListRulesResponse>

[src]

List all rules for the specified Amazon Connect instance.

listSecurityKeys(params: ListSecurityKeysRequest, opts?: client.RequestOptions): Promise<ListSecurityKeysResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all security keys associated with the instance.

listSecurityProfilePermissions(params: ListSecurityProfilePermissionsRequest, opts?: client.RequestOptions): Promise<ListSecurityProfilePermissionsResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Lists the permissions granted to a security profile.

listSecurityProfiles(params: ListSecurityProfilesRequest, opts?: client.RequestOptions): Promise<ListSecurityProfilesResponse>

[src]

Provides summary information about the security profiles for the specified Amazon Connect instance.

For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags for the specified resource.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

listTaskTemplates(params: ListTaskTemplatesRequest, opts?: client.RequestOptions): Promise<ListTaskTemplatesResponse>

[src]

Lists task templates for the specified Amazon Connect instance.

listTrafficDistributionGroups(params?: ListTrafficDistributionGroupsRequest, opts?: client.RequestOptions): Promise<ListTrafficDistributionGroupsResponse>

[src]

Lists traffic distribution groups.

listUseCases(params: ListUseCasesRequest, opts?: client.RequestOptions): Promise<ListUseCasesResponse>

[src]

Lists the use cases for the integration association.

listUserHierarchyGroups(params: ListUserHierarchyGroupsRequest, opts?: client.RequestOptions): Promise<ListUserHierarchyGroupsResponse>

[src]

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

listUsers(params: ListUsersRequest, opts?: client.RequestOptions): Promise<ListUsersResponse>

[src]

Provides summary information about the users for the specified Amazon Connect instance.

monitorContact(params: MonitorContactRequest, opts?: client.RequestOptions): Promise<MonitorContactResponse>

[src]

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.

putUserStatus(params: PutUserStatusRequest, opts?: client.RequestOptions): Promise<void>

[src]

Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.

For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.

releasePhoneNumber(params: ReleasePhoneNumberRequest, opts?: client.RequestOptions): Promise<void>

[src]

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.

! IMPORTANT: ! To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect console. ! After releasing a phone number, the phone number enters into a cooldown period of 30 days. ! It cannot be searched for or claimed again until the period has ended. ! If you accidentally release a phone number, contact Amazon Web Services Support.

replicateInstance(params: ReplicateInstanceRequest, opts?: client.RequestOptions): Promise<ReplicateInstanceResponse>

[src]

Replicates an Amazon Connect instance in the specified Amazon Web Services Region.

For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.

resumeContactRecording(params: ResumeContactRecordingRequest, opts?: client.RequestOptions): Promise<void>

[src]

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.

Only voice recordings are supported at this time.

searchAvailablePhoneNumbers(params: SearchAvailablePhoneNumbersRequest, opts?: client.RequestOptions): Promise<SearchAvailablePhoneNumbersResponse>

[src]

Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

searchQueues(params: SearchQueuesRequest, opts?: client.RequestOptions): Promise<SearchQueuesResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Searches queues in an Amazon Connect instance, with optional filtering.

searchRoutingProfiles(params: SearchRoutingProfilesRequest, opts?: client.RequestOptions): Promise<SearchRoutingProfilesResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Searches routing profiles in an Amazon Connect instance, with optional filtering.

searchSecurityProfiles(params: SearchSecurityProfilesRequest, opts?: client.RequestOptions): Promise<SearchSecurityProfilesResponse>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Searches security profiles in an Amazon Connect instance, with optional filtering.

searchUsers(params?: SearchUsersRequest, opts?: client.RequestOptions): Promise<SearchUsersResponse>

[src]

Searches users in an Amazon Connect instance, with optional filtering.

Note: AfterContactWorkTimeLimit is returned in milliseconds.

searchVocabularies(params: SearchVocabulariesRequest, opts?: client.RequestOptions): Promise<SearchVocabulariesResponse>

[src]

Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

startChatContact(params: StartChatContactRequest, opts?: client.RequestOptions): Promise<StartChatContactResponse>

[src]

Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

A 429 error occurs in the following situations:

API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.

For more information about chat, see Chat in the Amazon Connect Administrator Guide.

startContactRecording(params: StartContactRecordingRequest, opts?: client.RequestOptions): Promise<void>

[src]

Starts recording the contact:

If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API call.

StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

Only voice recordings are supported at this time.

startContactStreaming(params: StartContactStreamingRequest, opts?: client.RequestOptions): Promise<StartContactStreamingResponse>

[src]

Initiates real-time message streaming for a new chat contact.

For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

startOutboundVoiceContact(params: StartOutboundVoiceContactRequest, opts?: client.RequestOptions): Promise<StartOutboundVoiceContactResponse>

[src]

Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId).

Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

Note: UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

Note: Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.

startTaskContact(params: StartTaskContactRequest, opts?: client.RequestOptions): Promise<StartTaskContactResponse>

[src]

Initiates a flow to start a new task.

stopContact(params: StopContactRequest, opts?: client.RequestOptions): Promise<void>

[src]

Ends the specified contact. This call does not work for the following initiation methods:

DISCONNECT
TRANSFER
QUEUE_TRANSFER

stopContactRecording(params: StopContactRecordingRequest, opts?: client.RequestOptions): Promise<void>

[src]

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

Only voice recordings are supported at this time.

stopContactStreaming(params: StopContactStreamingRequest, opts?: client.RequestOptions): Promise<void>

[src]

Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.

suspendContactRecording(params: SuspendContactRecordingRequest, opts?: client.RequestOptions): Promise<void>

[src]

When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.

The period of time that the recording is suspended is filled with silence in the final recording.

Only voice recordings are supported at this time.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds the specified tags to the specified resource.

Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

transferContact(params: TransferContactRequest, opts?: client.RequestOptions): Promise<TransferContactResponse>

[src]

Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

Note the following requirements:

Transfer is supported for only TASK contacts.
Do not use both QueueId and UserId in the same call.
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The TransferContact API can be called only on active contacts.
A contact cannot be transferred more than 11 times.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes the specified tags from the specified resource.

updateAgentStatus(params: UpdateAgentStatusRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Updates agent status.

updateContact(params: UpdateContactRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

! IMPORTANT: ! You can add or update user-defined contact information for both ongoing and completed contacts.

updateContactAttributes(params: UpdateContactAttributesRequest, opts?: client.RequestOptions): Promise<void>

[src]

Creates or updates user-defined contact attributes associated with the specified contact.

You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.

updateContactFlowContent(params: UpdateContactFlowContentRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the specified flow.

You can also create and update flows using the Amazon Connect Flow language.

updateContactFlowMetadata(params: UpdateContactFlowMetadataRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates metadata about specified flow.

updateContactFlowModuleContent(params: UpdateContactFlowModuleContentRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates specified flow module for the specified Amazon Connect instance.

updateContactFlowModuleMetadata(params: UpdateContactFlowModuleMetadataRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates metadata about specified flow module.

updateContactFlowName(params: UpdateContactFlowNameRequest, opts?: client.RequestOptions): Promise<void>

[src]

The name of the flow.

You can also create and update flows using the Amazon Connect Flow language.

updateContactSchedule(params: UpdateContactScheduleRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the scheduled time of a task contact that is already scheduled.

updateHoursOfOperation(params: UpdateHoursOfOperationRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Updates the hours of operation.

updateInstanceAttribute(params: UpdateInstanceAttributeRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Updates the value for the specified attribute type.

updateInstanceStorageConfig(params: UpdateInstanceStorageConfigRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Updates an existing configuration for a resource type. This API is idempotent.

updateParticipantRoleConfig(params: UpdateParticipantRoleConfigRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:

Customer idle timeout
Customer auto-disconnect timeout
Agent idle timeout
Agent auto-disconnect timeout

For more information about how chat timeouts work, see Set up chat timeouts for human participants.

updatePhoneNumber(params: UpdatePhoneNumberRequest, opts?: client.RequestOptions): Promise<UpdatePhoneNumberResponse>

[src]

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

! IMPORTANT: ! You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

updateQueueHoursOfOperation(params: UpdateQueueHoursOfOperationRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Updates the hours of operation for the specified queue.

updateQueueMaxContacts(params: UpdateQueueMaxContactsRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Updates the maximum number of contacts allowed in a queue before it is considered full.

updateQueueName(params: UpdateQueueNameRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Updates the name and description of a queue. At least Name or Description must be provided.

updateQueueOutboundCallerConfig(params: UpdateQueueOutboundCallerConfigRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

updateQueueStatus(params: UpdateQueueStatusRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Updates the status of the queue.

updateQuickConnectConfig(params: UpdateQuickConnectConfigRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the configuration settings for the specified quick connect.

updateQuickConnectName(params: UpdateQuickConnectNameRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

updateRoutingProfileConcurrency(params: UpdateRoutingProfileConcurrencyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

updateRoutingProfileDefaultOutboundQueue(params: UpdateRoutingProfileDefaultOutboundQueueRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the default outbound queue of a routing profile.

updateRoutingProfileName(params: UpdateRoutingProfileNameRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

updateRoutingProfileQueues(params: UpdateRoutingProfileQueuesRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the properties associated with a set of queues for a routing profile.

updateRule(params: UpdateRuleRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a rule for the specified Amazon Connect instance.

Use the Rules Function language to code conditions for the rule.

updateSecurityProfile(params: UpdateSecurityProfileRequest, opts?: client.RequestOptions): Promise<void>

[src]

This API is in preview release for Amazon Connect and is subject to change.

Updates a security profile.

updateTaskTemplate(params: UpdateTaskTemplateRequest, opts?: client.RequestOptions): Promise<UpdateTaskTemplateResponse>

[src]

Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

updateTrafficDistribution(params: UpdateTrafficDistributionRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the traffic distribution for a given traffic distribution group.

For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.

updateUserHierarchy(params: UpdateUserHierarchyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Assigns the specified hierarchy group to the specified user.

updateUserHierarchyGroupName(params: UpdateUserHierarchyGroupNameRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the name of the user hierarchy group.

updateUserHierarchyStructure(params: UpdateUserHierarchyStructureRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

updateUserIdentityInfo(params: UpdateUserIdentityInfoRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the identity information for the specified user.

! IMPORTANT: ! We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. ! Someone with that ability can change the login credentials of other users by changing their email address. ! This poses a security risk to your organization. ! They can change the email address of a user to the attacker's email address, and then reset the password through email. ! For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

updateUserPhoneConfig(params: UpdateUserPhoneConfigRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the phone configuration settings for the specified user.

updateUserRoutingProfile(params: UpdateUserRoutingProfileRequest, opts?: client.RequestOptions): Promise<void>

[src]

Assigns the specified routing profile to the specified user.

updateUserSecurityProfiles(params: UpdateUserSecurityProfilesRequest, opts?: client.RequestOptions): Promise<void>

[src]

Assigns the specified security profiles to the specified user.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]