Connect class
Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.
There are limits to the number of Amazon Connect resources that you can create and 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.
To connect programmatically to an AWS service, you use an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
Constructors
- Connect({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
associateApprovedOrigin(
{required String instanceId, required String origin}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
associateInstanceStorageConfig(
{required String instanceId, required InstanceStorageResourceType resourceType, required InstanceStorageConfig storageConfig}) → Future< AssociateInstanceStorageConfigResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
associateLambdaFunction(
{required String functionArn, required String instanceId}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
associateLexBot(
{required String instanceId, required LexBot lexBot}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
associateRoutingProfileQueues(
{required String instanceId, required List< RoutingProfileQueueConfig> queueConfigs, required String routingProfileId}) → Future<void> - Associates a set of queues with a routing profile.
-
associateSecurityKey(
{required String instanceId, required String key}) → Future< AssociateSecurityKeyResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createContactFlow(
{required String content, required String instanceId, required String name, required ContactFlowType type, String? description, Map< String, String> ? tags}) → Future<CreateContactFlowResponse> - Creates a contact flow for the specified Amazon Connect instance.
-
createInstance(
{required DirectoryType identityManagementType, required bool inboundCallsEnabled, required bool outboundCallsEnabled, String? clientToken, String? directoryId, String? instanceAlias}) → Future< CreateInstanceResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
createIntegrationAssociation(
{required String instanceId, required String integrationArn, required IntegrationType integrationType, required String sourceApplicationName, required String sourceApplicationUrl, required SourceType sourceType}) → Future< CreateIntegrationAssociationResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
createQuickConnect(
{required String instanceId, required String name, required QuickConnectConfig quickConnectConfig, String? description, Map< String, String> ? tags}) → Future<CreateQuickConnectResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
createRoutingProfile(
{required String defaultOutboundQueueId, required String description, required String instanceId, required List< MediaConcurrency> mediaConcurrencies, required String name, List<RoutingProfileQueueConfig> ? queueConfigs, Map<String, String> ? tags}) → Future<CreateRoutingProfileResponse> - Creates a new routing profile.
-
createUseCase(
{required String instanceId, required String integrationAssociationId, required UseCaseType useCaseType}) → Future< CreateUseCaseResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
createUser(
{required String instanceId, required UserPhoneConfig phoneConfig, required String routingProfileId, required List< String> securityProfileIds, required String username, String? directoryUserId, String? hierarchyGroupId, UserIdentityInfo? identityInfo, String? password, Map<String, String> ? tags}) → Future<CreateUserResponse> - Creates a user account for the specified Amazon Connect instance.
-
createUserHierarchyGroup(
{required String instanceId, required String name, String? parentGroupId}) → Future< CreateUserHierarchyGroupResponse> - Creates a new user hierarchy group.
-
deleteInstance(
{required String instanceId}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
deleteIntegrationAssociation(
{required String instanceId, required String integrationAssociationId}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
deleteQuickConnect(
{required String instanceId, required String quickConnectId}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
deleteUseCase(
{required String instanceId, required String integrationAssociationId, required String useCaseId}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
deleteUser(
{required String instanceId, required String userId}) → Future< void> - Deletes a user account from the specified Amazon Connect instance.
-
deleteUserHierarchyGroup(
{required String hierarchyGroupId, required String instanceId}) → Future< void> - Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
-
describeContactFlow(
{required String contactFlowId, required String instanceId}) → Future< DescribeContactFlowResponse> - Describes the specified contact flow.
-
describeInstance(
{required String instanceId}) → Future< DescribeInstanceResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
describeInstanceAttribute(
{required InstanceAttributeType attributeType, required String instanceId}) → Future< DescribeInstanceAttributeResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
describeInstanceStorageConfig(
{required String associationId, required String instanceId, required InstanceStorageResourceType resourceType}) → Future< DescribeInstanceStorageConfigResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
describeQuickConnect(
{required String instanceId, required String quickConnectId}) → Future< DescribeQuickConnectResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
describeRoutingProfile(
{required String instanceId, required String routingProfileId}) → Future< DescribeRoutingProfileResponse> - Describes the specified routing profile.
-
describeUser(
{required String instanceId, required String userId}) → Future< DescribeUserResponse> - Describes the specified user account. You can find the instance ID in the 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(
{required String hierarchyGroupId, required String instanceId}) → Future< DescribeUserHierarchyGroupResponse> - Describes the specified hierarchy group.
-
describeUserHierarchyStructure(
{required String instanceId}) → Future< DescribeUserHierarchyStructureResponse> - Describes the hierarchy structure of the specified Amazon Connect instance.
-
disassociateApprovedOrigin(
{required String instanceId, required String origin}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
disassociateInstanceStorageConfig(
{required String associationId, required String instanceId, required InstanceStorageResourceType resourceType}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
disassociateLambdaFunction(
{required String functionArn, required String instanceId}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
disassociateLexBot(
{required String botName, required String instanceId, required String lexRegion}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
disassociateRoutingProfileQueues(
{required String instanceId, required List< RoutingProfileQueueReference> queueReferences, required String routingProfileId}) → Future<void> - Disassociates a set of queues from a routing profile.
-
disassociateSecurityKey(
{required String associationId, required String instanceId}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
getContactAttributes(
{required String initialContactId, required String instanceId}) → Future< GetContactAttributesResponse> - Retrieves the contact attributes for the specified contact.
-
getCurrentMetricData(
{required List< CurrentMetric> currentMetrics, required Filters filters, required String instanceId, List<Grouping> ? groupings, int? maxResults, String? nextToken}) → Future<GetCurrentMetricDataResponse> - Gets the real-time metric data from the specified Amazon Connect instance.
-
getFederationToken(
{required String instanceId}) → Future< GetFederationTokenResponse> - Retrieves a token for federation.
-
getMetricData(
{required DateTime endTime, required Filters filters, required List< HistoricalMetric> historicalMetrics, required String instanceId, required DateTime startTime, List<Grouping> ? groupings, int? maxResults, String? nextToken}) → Future<GetMetricDataResponse> - Gets historical metric data from the specified Amazon Connect instance.
-
listApprovedOrigins(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListApprovedOriginsResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
listContactFlows(
{required String instanceId, List< ContactFlowType> ? contactFlowTypes, int? maxResults, String? nextToken}) → Future<ListContactFlowsResponse> - Provides information about the contact flows for the specified Amazon Connect instance.
-
listHoursOfOperations(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListHoursOfOperationsResponse> - Provides information about the hours of operation for the specified Amazon Connect instance.
-
listInstanceAttributes(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListInstanceAttributesResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
listInstances(
{int? maxResults, String? nextToken}) → Future< ListInstancesResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
listInstanceStorageConfigs(
{required String instanceId, required InstanceStorageResourceType resourceType, int? maxResults, String? nextToken}) → Future< ListInstanceStorageConfigsResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
listIntegrationAssociations(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListIntegrationAssociationsResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
listLambdaFunctions(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListLambdaFunctionsResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
listLexBots(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListLexBotsResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
listPhoneNumbers(
{required String instanceId, int? maxResults, String? nextToken, List< PhoneNumberCountryCode> ? phoneNumberCountryCodes, List<PhoneNumberType> ? phoneNumberTypes}) → Future<ListPhoneNumbersResponse> - Provides information about the phone numbers for the specified Amazon Connect instance.
-
listPrompts(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListPromptsResponse> - Provides information about the prompts for the specified Amazon Connect instance.
-
listQueues(
{required String instanceId, int? maxResults, String? nextToken, List< QueueType> ? queueTypes}) → Future<ListQueuesResponse> - Provides information about the queues for the specified Amazon Connect instance.
-
listQuickConnects(
{required String instanceId, int? maxResults, String? nextToken, List< QuickConnectType> ? quickConnectTypes}) → Future<ListQuickConnectsResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
listRoutingProfileQueues(
{required String instanceId, required String routingProfileId, int? maxResults, String? nextToken}) → Future< ListRoutingProfileQueuesResponse> - List the queues associated with a routing profile.
-
listRoutingProfiles(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListRoutingProfilesResponse> - Provides summary information about the routing profiles for the specified Amazon Connect instance.
-
listSecurityKeys(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListSecurityKeysResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
listSecurityProfiles(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListSecurityProfilesResponse> - Provides summary information about the security profiles for the specified Amazon Connect instance.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Lists the tags for the specified resource.
-
listUseCases(
{required String instanceId, required String integrationAssociationId, int? maxResults, String? nextToken}) → Future< ListUseCasesResponse> - This API is in preview release for Amazon Connect and is subject to change.
-
listUserHierarchyGroups(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListUserHierarchyGroupsResponse> - Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
-
listUsers(
{required String instanceId, int? maxResults, String? nextToken}) → Future< ListUsersResponse> - Provides summary information about the users for the specified Amazon Connect instance.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resumeContactRecording(
{required String contactId, required String initialContactId, required String instanceId}) → Future< void> - When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
-
startChatContact(
{required String contactFlowId, required String instanceId, required ParticipantDetails participantDetails, Map< String, String> ? attributes, String? clientToken, ChatMessage? initialMessage}) → Future<StartChatContactResponse> - Initiates a contact 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.
-
startContactRecording(
{required String contactId, required String initialContactId, required String instanceId, required VoiceRecordingConfiguration voiceRecordingConfiguration}) → Future< void> - This API starts recording the contact when the agent joins the 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.
-
startOutboundVoiceContact(
{required String contactFlowId, required String destinationPhoneNumber, required String instanceId, Map< String, String> ? attributes, String? clientToken, String? queueId, String? sourcePhoneNumber}) → Future<StartOutboundVoiceContactResponse> -
This API places an outbound call to a contact, and then initiates the
contact flow. It performs the actions in the contact flow that's specified
(in
ContactFlowId). -
startTaskContact(
{required String contactFlowId, required String instanceId, required String name, Map< String, String> ? attributes, String? clientToken, String? description, String? previousContactId, Map<String, Reference> ? references}) → Future<StartTaskContactResponse> - Initiates a contact flow to start a new task.
-
stopContact(
{required String contactId, required String instanceId}) → Future< void> - Ends the specified contact.
-
stopContactRecording(
{required String contactId, required String initialContactId, required String instanceId}) → Future< void> - When a contact is being recorded, this API stops recording the call. 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.
-
suspendContactRecording(
{required String contactId, required String initialContactId, required String instanceId}) → Future< void> - 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.
-
tagResource(
{required String resourceArn, required Map< String, String> tags}) → Future<void> - Adds the specified tags to the specified resource.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Removes the specified tags from the specified resource.
-
updateContactAttributes(
{required Map< String, String> attributes, required String initialContactId, required String instanceId}) → Future<void> - Creates or updates the contact attributes associated with the specified contact.
-
updateContactFlowContent(
{required String contactFlowId, required String content, required String instanceId}) → Future< void> - Updates the specified contact flow.
-
updateContactFlowName(
{required String contactFlowId, required String instanceId, String? description, String? name}) → Future< void> - The name of the contact flow.
-
updateInstanceAttribute(
{required InstanceAttributeType attributeType, required String instanceId, required String value}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
updateInstanceStorageConfig(
{required String associationId, required String instanceId, required InstanceStorageResourceType resourceType, required InstanceStorageConfig storageConfig}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
updateQuickConnectConfig(
{required String instanceId, required QuickConnectConfig quickConnectConfig, required String quickConnectId}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
updateQuickConnectName(
{required String instanceId, required String quickConnectId, String? description, String? name}) → Future< void> - This API is in preview release for Amazon Connect and is subject to change.
-
updateRoutingProfileConcurrency(
{required String instanceId, required List< MediaConcurrency> mediaConcurrencies, required String routingProfileId}) → Future<void> - Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
-
updateRoutingProfileDefaultOutboundQueue(
{required String defaultOutboundQueueId, required String instanceId, required String routingProfileId}) → Future< void> - Updates the default outbound queue of a routing profile.
-
updateRoutingProfileName(
{required String instanceId, required String routingProfileId, String? description, String? name}) → Future< void> -
Updates the name and description of a routing profile. The request accepts
the following data in JSON format. At least
NameorDescriptionmust be provided. -
updateRoutingProfileQueues(
{required String instanceId, required List< RoutingProfileQueueConfig> queueConfigs, required String routingProfileId}) → Future<void> - Updates the properties associated with a set of queues for a routing profile.
-
updateUserHierarchy(
{required String instanceId, required String userId, String? hierarchyGroupId}) → Future< void> - Assigns the specified hierarchy group to the specified user.
-
updateUserHierarchyGroupName(
{required String hierarchyGroupId, required String instanceId, required String name}) → Future< void> - Updates the name of the user hierarchy group.
-
updateUserHierarchyStructure(
{required HierarchyStructureUpdate hierarchyStructure, required String instanceId}) → Future< void> - Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
-
updateUserIdentityInfo(
{required UserIdentityInfo identityInfo, required String instanceId, required String userId}) → Future< void> - Updates the identity information for the specified user.
-
updateUserPhoneConfig(
{required String instanceId, required UserPhoneConfig phoneConfig, required String userId}) → Future< void> - Updates the phone configuration settings for the specified user.
-
updateUserRoutingProfile(
{required String instanceId, required String routingProfileId, required String userId}) → Future< void> - Assigns the specified routing profile to the specified user.
-
updateUserSecurityProfiles(
{required String instanceId, required List< String> securityProfileIds, required String userId}) → Future<void> - Assigns the specified security profiles to the specified user.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited