AWS.Connect — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

activateEvaluationForm(params = {}, callback) ⇒ AWS.Request

Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.

associateAnalyticsDataSet(params = {}, callback) ⇒ AWS.Request

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

Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

associateApprovedOrigin(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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.

associateFlow(params = {}, callback) ⇒ AWS.Request

Associates a connect resource to a flow.

associateInstanceStorageConfig(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

Associates a set of queues with a routing profile.

associateSecurityKey(params = {}, callback) ⇒ AWS.Request

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

Associates a security key to the instance.

associateTrafficDistributionGroupUser(params = {}, callback) ⇒ AWS.Request

Associates an agent with a traffic distribution group.

associateUserProficiencies(params = {}, callback) ⇒ AWS.Request

>Associates a set of proficiencies with a user.

batchAssociateAnalyticsDataSet(params = {}, callback) ⇒ AWS.Request

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

Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.

batchDisassociateAnalyticsDataSet(params = {}, callback) ⇒ AWS.Request

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

Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.

batchGetAttachedFileMetadata(params = {}, callback) ⇒ AWS.Request

Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.

batchGetFlowAssociation(params = {}, callback) ⇒ AWS.Request

Retrieve the flow associations for the given resources.

batchPutContact(params = {}, callback) ⇒ AWS.Request

Note: Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

claimPhoneNumber(params = {}, callback) ⇒ AWS.Request

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.

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.

If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

completeAttachedFileUpload(params = {}, callback) ⇒ AWS.Request

Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.

createAgentStatus(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

createContactFlowModule(params = {}, callback) ⇒ AWS.Request

Creates a flow module for the specified Amazon Connect instance.

createEvaluationForm(params = {}, callback) ⇒ AWS.Request

Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.

createHoursOfOperation(params = {}, callback) ⇒ AWS.Request

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

Creates hours of operation.

createInstance(params = {}, callback) ⇒ AWS.Request

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.

For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide.

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 = {}, callback) ⇒ AWS.Request

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

createParticipant(params = {}, callback) ⇒ AWS.Request

createPersistentContactAssociation(params = {}, callback) ⇒ AWS.Request

Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.

createPredefinedAttribute(params = {}, callback) ⇒ AWS.Request

Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

createPrompt(params = {}, callback) ⇒ AWS.Request

Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.

createQueue(params = {}, callback) ⇒ AWS.Request

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

Creates a new queue for the specified Amazon Connect instance.

If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is 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.
Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

createQuickConnect(params = {}, callback) ⇒ AWS.Request

Creates a quick connect for the specified Amazon Connect instance.

createRoutingProfile(params = {}, callback) ⇒ AWS.Request

Creates a new routing profile.

createRule(params = {}, callback) ⇒ AWS.Request

Creates a rule for the specified Amazon Connect instance.

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

createSecurityProfile(params = {}, callback) ⇒ AWS.Request

Creates a security profile.

For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

createTaskTemplate(params = {}, callback) ⇒ AWS.Request

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

createTrafficDistributionGroup(params = {}, callback) ⇒ AWS.Request

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

Note: The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

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

createUseCase(params = {}, callback) ⇒ AWS.Request

Creates a use case for an integration association.

createUser(params = {}, callback) ⇒ AWS.Request

Creates a user account for the specified Amazon Connect instance.

Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.

For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.

createUserHierarchyGroup(params = {}, callback) ⇒ AWS.Request

Creates a new user hierarchy group.

createView(params = {}, callback) ⇒ AWS.Request

Creates a new view with the possible status of SAVED or PUBLISHED.

The views will have a unique name for each connect instance.

It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

createViewVersion(params = {}, callback) ⇒ AWS.Request

Publishes a new version of the view identifier.

Versions are immutable and monotonically increasing.

It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.

createVocabulary(params = {}, callback) ⇒ AWS.Request

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.

deactivateEvaluationForm(params = {}, callback) ⇒ AWS.Request

Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.

deleteAttachedFile(params = {}, callback) ⇒ AWS.Request

Deletes an attached file along with the underlying S3 Object.

The attached file is permanently deleted if S3 bucket versioning is not enabled.

deleteContactEvaluation(params = {}, callback) ⇒ AWS.Request

Deletes a contact evaluation in the specified Amazon Connect instance.

deleteContactFlow(params = {}, callback) ⇒ AWS.Request

Deletes a flow for the specified Amazon Connect instance.

deleteContactFlowModule(params = {}, callback) ⇒ AWS.Request

Deletes the specified flow module.

deleteEvaluationForm(params = {}, callback) ⇒ AWS.Request

Deletes an evaluation form in the specified Amazon Connect instance.

If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.

deleteHoursOfOperation(params = {}, callback) ⇒ AWS.Request

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

Deletes an hours of operation.

deleteInstance(params = {}, callback) ⇒ AWS.Request

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

Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide.

deleteIntegrationAssociation(params = {}, callback) ⇒ AWS.Request

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

deletePredefinedAttribute(params = {}, callback) ⇒ AWS.Request

Deletes a predefined attribute from the specified Amazon Connect instance.

deleteQueue(params = {}, callback) ⇒ AWS.Request

Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.

deleteQuickConnect(params = {}, callback) ⇒ AWS.Request

Deletes a quick connect.

After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.

deleteRoutingProfile(params = {}, callback) ⇒ AWS.Request

Deletes a routing profile.

deleteRule(params = {}, callback) ⇒ AWS.Request

Deletes a rule for the specified Amazon Connect instance.

deleteSecurityProfile(params = {}, callback) ⇒ AWS.Request

Deletes a security profile.

deleteTaskTemplate(params = {}, callback) ⇒ AWS.Request

Deletes the task template.

deleteTrafficDistributionGroup(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

Deletes a use case from an integration association.

deleteUser(params = {}, callback) ⇒ AWS.Request

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.

After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.

deleteUserHierarchyGroup(params = {}, callback) ⇒ AWS.Request

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

deleteView(params = {}, callback) ⇒ AWS.Request

Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).

deleteViewVersion(params = {}, callback) ⇒ AWS.Request

Deletes the particular version specified in ViewVersion identifier.

deleteVocabulary(params = {}, callback) ⇒ AWS.Request

Deletes the vocabulary that has the given identifier.

describeAgentStatus(params = {}, callback) ⇒ AWS.Request

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

Describes an agent status.

describeAuthenticationProfile(params = {}, callback) ⇒ AWS.Request

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

Describes the target authentication profile.

describeContact(params = {}, callback) ⇒ AWS.Request

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

Describes the specified contact.

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.

describeContactEvaluation(params = {}, callback) ⇒ AWS.Request

Describes a contact evaluation in the specified Amazon Connect instance.

describeContactFlow(params = {}, callback) ⇒ AWS.Request

Describes the specified flow.

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

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

describeContactFlowModule(params = {}, callback) ⇒ AWS.Request

Describes the specified flow module.

describeEvaluationForm(params = {}, callback) ⇒ AWS.Request

Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.

describeHoursOfOperation(params = {}, callback) ⇒ AWS.Request

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

Describes the hours of operation.

describeInstance(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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

Describes the specified instance attribute.

describeInstanceStorageConfig(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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

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.

describePredefinedAttribute(params = {}, callback) ⇒ AWS.Request

Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

describePrompt(params = {}, callback) ⇒ AWS.Request

describeQueue(params = {}, callback) ⇒ AWS.Request

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

Describes the specified queue.

describeQuickConnect(params = {}, callback) ⇒ AWS.Request

Describes the quick connect.

describeRoutingProfile(params = {}, callback) ⇒ AWS.Request

Describes the specified routing profile.

describeRule(params = {}, callback) ⇒ AWS.Request

Describes a rule for the specified Amazon Connect instance.

describeSecurityProfile(params = {}, callback) ⇒ AWS.Request

Gets basic information about the security profile.

describeTrafficDistributionGroup(params = {}, callback) ⇒ AWS.Request

Gets details and status of a traffic distribution group.

describeUserHierarchyGroup(params = {}, callback) ⇒ AWS.Request

Describes the specified hierarchy group.

describeUserHierarchyStructure(params = {}, callback) ⇒ AWS.Request

Describes the hierarchy structure of the specified Amazon Connect instance.

describeView(params = {}, callback) ⇒ AWS.Request

Retrieves the view for the specified Amazon Connect instance and view identifier.

The view identifier can be supplied as a ViewId or ARN.

$SAVED needs to be supplied if a view is unpublished.

The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>L</mi><mi>A</mi><mi>T</mi><mi>E</mi><mi>S</mi><mi>T</mi><mi mathvariant="normal">‘</mi><mi mathvariant="normal">.</mi><mi>I</mi><mi>f</mi><mi>i</mi><mi>t</mi><mi>i</mi><mi>s</mi><mi>n</mi><mi>o</mi><mi>t</mi><mi>s</mi><mi>u</mi><mi>p</mi><mi>p</mi><mi>l</mi><mi>i</mi><mi>e</mi><mi>d</mi><mo separator="true">,</mo><mi>t</mi><mi>h</mi><mi>e</mi><mi>n</mi><mi mathvariant="normal">‘</mi></mrow><annotation encoding="application/x-tex">LATEST. If it is not supplied, then </annotation></semantics></math>LATEST‘.Ifitisnotsupplied,then‘LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.

describeVocabulary(params = {}, callback) ⇒ AWS.Request

Describes the specified vocabulary.

disassociateAnalyticsDataSet(params = {}, callback) ⇒ AWS.Request

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

Removes the dataset ID associated with a given Amazon Connect instance.

disassociateApprovedOrigin(params = {}, callback) ⇒ AWS.Request

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

Revokes access to integrated applications from Amazon Connect.

disassociateBot(params = {}, callback) ⇒ AWS.Request

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.

disassociateFlow(params = {}, callback) ⇒ AWS.Request

Disassociates a connect resource from a flow.

disassociateInstanceStorageConfig(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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

disassociateQueueQuickConnects(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

Disassociates a set of queues from a routing profile.

disassociateSecurityKey(params = {}, callback) ⇒ AWS.Request

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

Deletes the specified security key.

disassociateTrafficDistributionGroupUser(params = {}, callback) ⇒ AWS.Request

Disassociates an agent from a traffic distribution group.

disassociateUserProficiencies(params = {}, callback) ⇒ AWS.Request

Disassociates a set of proficiencies from a user.

dismissUserContact(params = {}, callback) ⇒ AWS.Request

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.

getAttachedFile(params = {}, callback) ⇒ AWS.Request

Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.

getContactAttributes(params = {}, callback) ⇒ AWS.Request

Retrieves the contact attributes for the specified contact.

getCurrentMetricData(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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

getFederationToken(params = {}, callback) ⇒ AWS.Request

Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.

For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.

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

getFlowAssociation(params = {}, callback) ⇒ AWS.Request

Retrieves the flow associated for a given resource.

getMetricData(params = {}, callback) ⇒ AWS.Request

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.

Note: We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

getMetricDataV2(params = {}, callback) ⇒ AWS.Request

Gets metric data from the specified Amazon Connect instance.

GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.

For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.

getPromptFile(params = {}, callback) ⇒ AWS.Request

getTaskTemplate(params = {}, callback) ⇒ AWS.Request

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

getTrafficDistribution(params = {}, callback) ⇒ AWS.Request

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

importPhoneNumber(params = {}, callback) ⇒ AWS.Request

Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.

Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation.

If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.

For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.

listAgentStatuses(params = {}, callback) ⇒ AWS.Request

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

Lists agent statuses.

listAnalyticsDataAssociations(params = {}, callback) ⇒ AWS.Request

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

Lists the association status of requested dataset ID for a given Amazon Connect instance.

listApprovedOrigins(params = {}, callback) ⇒ AWS.Request

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.

listAuthenticationProfiles(params = {}, callback) ⇒ AWS.Request

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

Provides summary information about the authentication profiles in a specified Amazon Connect instance.

listBots(params = {}, callback) ⇒ AWS.Request

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.

listContactEvaluations(params = {}, callback) ⇒ AWS.Request

Lists contact evaluations in the specified Amazon Connect instance.

listContactFlowModules(params = {}, callback) ⇒ AWS.Request

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

listContactFlows(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

listDefaultVocabularies(params = {}, callback) ⇒ AWS.Request

Lists the default vocabularies for the specified Amazon Connect instance.

listEvaluationForms(params = {}, callback) ⇒ AWS.Request

Lists evaluation forms in the specified Amazon Connect instance.

listEvaluationFormVersions(params = {}, callback) ⇒ AWS.Request

Lists versions of an evaluation form in the specified Amazon Connect instance.

listFlowAssociations(params = {}, callback) ⇒ AWS.Request

List the flow association based on the filters.

listHoursOfOperations(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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

listLambdaFunctions(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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.

We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID.
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 = {}, callback) ⇒ AWS.Request

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.

Note:

When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.
When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.

listPredefinedAttributes(params = {}, callback) ⇒ AWS.Request

Lists predefined attributes for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

listPrompts(params = {}, callback) ⇒ AWS.Request

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

listQueueQuickConnects(params = {}, callback) ⇒ AWS.Request

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

Lists the quick connects associated with a queue.

listQueues(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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

listRealtimeContactAnalysisSegmentsV2(params = {}, callback) ⇒ AWS.Request

Provides a list of analysis segments for a real-time analysis session.

listRoutingProfileQueues(params = {}, callback) ⇒ AWS.Request

Lists the queues associated with a routing profile.

listRoutingProfiles(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

List all rules for the specified Amazon Connect instance.

listSecurityKeys(params = {}, callback) ⇒ AWS.Request

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.

listSecurityProfileApplications(params = {}, callback) ⇒ AWS.Request

Returns a list of third-party applications in a specific security profile.

listSecurityProfilePermissions(params = {}, callback) ⇒ AWS.Request

Lists the permissions granted to a security profile.

listSecurityProfiles(params = {}, callback) ⇒ AWS.Request

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. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

listTaskTemplates(params = {}, callback) ⇒ AWS.Request

Lists task templates for the specified Amazon Connect instance.

listTrafficDistributionGroups(params = {}, callback) ⇒ AWS.Request

Lists traffic distribution groups.

listTrafficDistributionGroupUsers(params = {}, callback) ⇒ AWS.Request

Lists traffic distribution group users.

listUseCases(params = {}, callback) ⇒ AWS.Request

Lists the use cases for the integration association.

listUserHierarchyGroups(params = {}, callback) ⇒ AWS.Request

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.

listUserProficiencies(params = {}, callback) ⇒ AWS.Request

Lists proficiencies associated with a user.

listUsers(params = {}, callback) ⇒ AWS.Request

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

listViews(params = {}, callback) ⇒ AWS.Request

Returns views in the given instance.

Results are sorted primarily by type, and secondarily by name.

listViewVersions(params = {}, callback) ⇒ AWS.Request

Returns all the available versions for the specified Amazon Connect instance and view identifier.

Results will be sorted from highest to lowest.

monitorContact(params = {}, callback) ⇒ AWS.Request

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.

pauseContact(params = {}, callback) ⇒ AWS.Request

Allows pausing an ongoing task contact.

putUserStatus(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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.

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.

After releasing a phone number, the phone number enters into a cooldown period for up to 180 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 = {}, callback) ⇒ AWS.Request

Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.

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.

resumeContact(params = {}, callback) ⇒ AWS.Request

Allows resuming a task contact in a paused state.

resumeContactRecording(params = {}, callback) ⇒ AWS.Request

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.

Voice and screen recordings are supported.

searchAgentStatuses(params = {}, callback) ⇒ AWS.Request

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

searchAvailablePhoneNumbers(params = {}, callback) ⇒ AWS.Request

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.

searchContactFlowModules(params = {}, callback) ⇒ AWS.Request

Searches the flow modules in an Amazon Connect instance, with optional filtering.

searchContactFlows(params = {}, callback) ⇒ AWS.Request

Searches the contact flows in an Amazon Connect instance, with optional filtering.

searchContacts(params = {}, callback) ⇒ AWS.Request

Searches contacts in an Amazon Connect instance.

searchHoursOfOperations(params = {}, callback) ⇒ AWS.Request

Searches the hours of operation in an Amazon Connect instance, with optional filtering.

searchPredefinedAttributes(params = {}, callback) ⇒ AWS.Request

searchPrompts(params = {}, callback) ⇒ AWS.Request

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

searchQueues(params = {}, callback) ⇒ AWS.Request

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

searchQuickConnects(params = {}, callback) ⇒ AWS.Request

Searches quick connects in an Amazon Connect instance, with optional filtering.

searchResourceTags(params = {}, callback) ⇒ AWS.Request

Searches tags used in an Amazon Connect instance using optional search criteria.

searchRoutingProfiles(params = {}, callback) ⇒ AWS.Request

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

searchSecurityProfiles(params = {}, callback) ⇒ AWS.Request

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

searchUserHierarchyGroups(params = {}, callback) ⇒ AWS.Request

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

The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.

searchUsers(params = {}, callback) ⇒ AWS.Request

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

Note: AfterContactWorkTimeLimit is returned in milliseconds.

searchVocabularies(params = {}, callback) ⇒ AWS.Request

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

sendChatIntegrationEvent(params = {}, callback) ⇒ AWS.Request

Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:

SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.

Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.

startAttachedFileUpload(params = {}, callback) ⇒ AWS.Request

Provides a pre-signed Amazon S3 URL in response for uploading your content.

You may only use this API to upload attachments to an Amazon Connect Case.

startChatContact(params = {}, callback) ⇒ AWS.Request

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 the following topics in the Amazon Connect Administrator Guide:

startContactEvaluation(params = {}, callback) ⇒ AWS.Request

Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.

Note: Evaluations created through the public API do not contain answer values suggested from automation.

startContactRecording(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

startOutboundVoiceContact(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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

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

PreviousContactId
- Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.
- There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.
RelatedContactId
- Copies contact attributes from the related task contact to the new contact.
- Any update on attributes in a new task contact does not update attributes on previous contact.
- There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.

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

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

startWebRTCContact(params = {}, callback) ⇒ AWS.Request

Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

stopContact(params = {}, callback) ⇒ AWS.Request

Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:

DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR

Chat and task contacts can be terminated in any state, regardless of initiation method.

stopContactRecording(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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

submitContactEvaluation(params = {}, callback) ⇒ AWS.Request

Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}) to the question identifier.

If a contact evaluation is already in submitted state, this operation will trigger a resubmission.

suspendContactRecording(params = {}, callback) ⇒ AWS.Request

When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.

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

Voice and screen recordings are supported.

tagResource(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

Removes the specified tags from the specified resource.

updateAgentStatus(params = {}, callback) ⇒ AWS.Request

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

Updates agent status.

updateAuthenticationProfile(params = {}, callback) ⇒ AWS.Request

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

Updates the selected authentication profile.

updateContact(params = {}, callback) ⇒ AWS.Request

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.

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

updateContactAttributes(params = {}, callback) ⇒ AWS.Request

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.

updateContactEvaluation(params = {}, callback) ⇒ AWS.Request

Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier.

updateContactFlowContent(params = {}, callback) ⇒ AWS.Request

Updates the specified flow.

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

updateContactFlowMetadata(params = {}, callback) ⇒ AWS.Request

Updates metadata about specified flow.

updateContactFlowModuleContent(params = {}, callback) ⇒ AWS.Request

Updates specified flow module for the specified Amazon Connect instance.

updateContactFlowModuleMetadata(params = {}, callback) ⇒ AWS.Request

Updates metadata about specified flow module.

updateContactFlowName(params = {}, callback) ⇒ AWS.Request

updateContactRoutingData(params = {}, callback) ⇒ AWS.Request

Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.

Note: Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.

updateContactSchedule(params = {}, callback) ⇒ AWS.Request

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

updateEvaluationForm(params = {}, callback) ⇒ AWS.Request

Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.

This operation does not support partial updates. Instead it does a full update of evaluation form content.

updateHoursOfOperation(params = {}, callback) ⇒ AWS.Request

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

Updates the hours of operation.

updateInstanceAttribute(params = {}, callback) ⇒ AWS.Request

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

Updates the value for the specified attribute type.

updateInstanceStorageConfig(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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.

After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.

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

updatePhoneNumberMetadata(params = {}, callback) ⇒ AWS.Request

Updates a phone number’s metadata.

To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.

updatePredefinedAttribute(params = {}, callback) ⇒ AWS.Request

Updates a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

updateQueueHoursOfOperation(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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.

If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is 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.
Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

updateQueueStatus(params = {}, callback) ⇒ AWS.Request

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

Updates the status of the queue.

updateQuickConnectConfig(params = {}, callback) ⇒ AWS.Request

Updates the configuration settings for the specified quick connect.

updateQuickConnectName(params = {}, callback) ⇒ AWS.Request

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.

updateRoutingProfileAgentAvailabilityTimer(params = {}, callback) ⇒ AWS.Request

Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

updateRoutingProfileConcurrency(params = {}, callback) ⇒ AWS.Request

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

updateRoutingProfileDefaultOutboundQueue(params = {}, callback) ⇒ AWS.Request

Updates the default outbound queue of a routing profile.

updateRoutingProfileName(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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

updateRule(params = {}, callback) ⇒ AWS.Request

Updates a rule for the specified Amazon Connect instance.

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

updateSecurityProfile(params = {}, callback) ⇒ AWS.Request

Updates a security profile.

updateTaskTemplate(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

Assigns the specified hierarchy group to the specified user.

updateUserHierarchyGroupName(params = {}, callback) ⇒ AWS.Request

Updates the name of the user hierarchy group.

updateUserHierarchyStructure(params = {}, callback) ⇒ AWS.Request

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

updateUserIdentityInfo(params = {}, callback) ⇒ AWS.Request

Updates the identity information for the specified user.

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 = {}, callback) ⇒ AWS.Request

Updates the phone configuration settings for the specified user.

updateUserProficiencies(params = {}, callback) ⇒ AWS.Request

Updates the properties associated with the proficiencies of a user.

updateUserRoutingProfile(params = {}, callback) ⇒ AWS.Request

Assigns the specified routing profile to the specified user.

updateUserSecurityProfiles(params = {}, callback) ⇒ AWS.Request

Assigns the specified security profiles to the specified user.

updateViewContent(params = {}, callback) ⇒ AWS.Request

Updates the view content of the given view identifier in the specified Amazon Connect instance.

It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED.

updateViewMetadata(params = {}, callback) ⇒ AWS.Request

Updates the view metadata. Note that either Name or Description must be provided.