Class: AWS.Connect
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Connect
- Identifier:
- connect
- API Version:
- 2017-08-08
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
Sending a Request Using Connect
var connect = new AWS.Connect();
connect.activateEvaluationForm(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Connect object uses this specific API, you can
construct the object by passing the apiVersion option to the constructor:
var connect = new AWS.Connect({apiVersion: '2017-08-08'});
You can also set the API version globally in AWS.config.apiVersions using
the connect service identifier:
AWS.config.apiVersions = {
connect: '2017-08-08',
// other service API versions
};
var connect = new AWS.Connect();
Constructor Summary collapse
-
new AWS.Connect(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
activateEvaluationForm(params = {}, callback) ⇒ AWS.Request
Activates an evaluation form in the specified Amazon Connect instance.
-
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.
-
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.
-
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.
-
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.
-
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
PhoneNumberIdURI request parameter. -
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.
-
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.
-
batchGetAttachedFileMetadata(params = {}, callback) ⇒ AWS.Request
Allows you to retrieve metadata about multiple attached files on an associated resource.
-
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.
- claimPhoneNumber(params = {}, callback) ⇒ AWS.Request
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
- 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
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
.- 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.
- 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.
- createIntegrationAssociation(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Web Services resource association with an Amazon Connect instance.
.
- createParticipant(params = {}, callback) ⇒ AWS.Request
Adds a new participant into an on-going chat contact.
- createPersistentContactAssociation(params = {}, callback) ⇒ AWS.Request
Enables rehydration of chats for the lifespan of a contact.
- createPredefinedAttribute(params = {}, callback) ⇒ AWS.Request
Creates a new predefined attribute for the specified Amazon Connect instance.
- createPrompt(params = {}, callback) ⇒ AWS.Request
Creates a prompt.
- 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.
- 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.
- 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.
- 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.
- 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
SAVEDorPUBLISHED.The views will have a unique name for each connect instance.
It performs basic content validation if the status is
SAVEDor full content validation if the status is set toPUBLISHED.- 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.
- createVocabulary(params = {}, callback) ⇒ AWS.Request
Creates a custom vocabulary associated with your Amazon Connect instance.
- deactivateEvaluationForm(params = {}, callback) ⇒ AWS.Request
Deactivates an evaluation form in the specified Amazon Connect instance.
- 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.
- 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.
- deleteIntegrationAssociation(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Web Services resource association from an Amazon Connect instance.
- deletePredefinedAttribute(params = {}, callback) ⇒ AWS.Request
Deletes a predefined attribute from the specified Amazon Connect instance.
.
- deletePrompt(params = {}, callback) ⇒ AWS.Request
Deletes a prompt.
.
- deleteQueue(params = {}, callback) ⇒ AWS.Request
Deletes a queue.
- deleteQuickConnect(params = {}, callback) ⇒ AWS.Request
Deletes a quick connect.
- 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
- claimPhoneNumber(params = {}, callback) ⇒ AWS.Request