Connect class

• Connect Customer Customer actions
• Connect Customer Customer data types

Connect Customer Customer engages customers at every touchpoint and creates deeper relationships with AI powered capabilities.

Build and manage customer communication experiences. Connect customers to agents, enable intelligent routing, and track performance in real-time.

There are limits to the number of Connect Customer resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Connect Customer Service Quotas in the Connect Customer Administrator Guide.

You can use an endpoint to connect programmatically to an Amazon Web Services service. For a list of Connect Customer endpoints, see Connect Customer Endpoints.

Constructors

Connect({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

activateEvaluationForm({required String evaluationFormId, required int evaluationFormVersion, required String instanceId}) → Future<ActivateEvaluationFormResponse>

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

associateAnalyticsDataSet({required String dataSetId, required String instanceId, String? targetAccountId}) → Future<AssociateAnalyticsDataSetResponse>

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

associateApprovedOrigin({required String instanceId, required String origin, String? clientToken}) → Future<void>

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

associateBot({required String instanceId, String? clientToken, LexBot? lexBot, LexV2Bot? lexV2Bot}) → Future<void>

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

associateContactWithUser({required String contactId, required String instanceId, required String userId}) → Future<void>

Associates a queued contact with an agent.

associateDefaultVocabulary({required String instanceId, required VocabularyLanguageCode languageCode, String? vocabularyId}) → Future<void>

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

associateEmailAddressAlias({required AliasConfiguration aliasConfiguration, required String emailAddressId, required String instanceId, String? clientToken}) → Future<void>

Associates an email address alias with an existing email address in an Connect Customer instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address.

associateFlow({required String flowId, required String instanceId, required String resourceId, required FlowAssociationResourceType resourceType}) → Future<void>

Associates a connect resource to a flow.

associateHoursOfOperations({required String hoursOfOperationId, required String instanceId, required List<ParentHoursOfOperationConfig> parentHoursOfOperationConfigs}) → Future<void>

Associates a set of hours of operations with another hours of operation. Refer to Administrator Guide here for more information on inheriting overrides from parent hours of operation(s).

associateInstanceStorageConfig({required String instanceId, required InstanceStorageResourceType resourceType, required InstanceStorageConfig storageConfig, String? clientToken}) → Future<AssociateInstanceStorageConfigResponse>

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

associateLambdaFunction({required String functionArn, required String instanceId, String? clientToken}) → Future<void>

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

associateLexBot({required String instanceId, required LexBot lexBot, String? clientToken}) → Future<void>

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

associatePhoneNumberContactFlow({required String contactFlowId, required String instanceId, required String phoneNumberId}) → Future<void>

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

associateQueueEmailAddresses({required List<EmailAddressConfig> emailAddressesConfig, required String instanceId, required String queueId, String? clientToken}) → Future<void>

Associates a set of email addresses with a queue to enable agents to select different "From" (system) email addresses when replying to inbound email contacts or initiating outbound email contacts. This allows agents to handle email contacts across different brands and business units within the same queue.

associateQueueQuickConnects({required String instanceId, required String queueId, required List<String> quickConnectIds}) → Future<void>

Associates a set of quick connects with a queue.

associateRoutingProfileQueues({required String instanceId, required String routingProfileId, List<RoutingProfileManualAssignmentQueueConfig>? manualAssignmentQueueConfigs, List<RoutingProfileQueueConfig>? queueConfigs}) → Future<void>

Associates a set of queues with a routing profile.

associateSecurityKey({required String instanceId, required String key, String? clientToken}) → Future<AssociateSecurityKeyResponse>

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

associateSecurityProfiles({required String entityArn, required EntityType entityType, required String instanceId, required List<SecurityProfileItem> securityProfiles}) → Future<void>

Associate security profiles with an Entity in an Amazon Connect instance.

associateTrafficDistributionGroupUser({required String instanceId, required String trafficDistributionGroupId, required String userId}) → Future<void>

Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

associateUserProficiencies({required String instanceId, required String userId, required List<UserProficiency> userProficiencies}) → Future<void>

Associates a set of proficiencies with a user.

associateWorkspace({required String instanceId, required List<String> resourceArns, required String workspaceId}) → Future<AssociateWorkspaceResponse>

Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.

batchAssociateAnalyticsDataSet({required List<String> dataSetIds, required String instanceId, String? targetAccountId}) → Future<BatchAssociateAnalyticsDataSetResponse>

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

batchCreateDataTableValue({required String dataTableId, required String instanceId, required List<DataTableValue> values}) → Future<BatchCreateDataTableValueResponse>

Creates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer defined validation as well as the default validation for the value type. The operation must conform to Batch Operation API Standards. Although the standard specifies that successful and failed entities are listed separately in the response, authorization fails if any primary values or attributes are unauthorized. The combination of primary values and the attribute name serve as the identifier for the individual item request.

batchDeleteDataTableValue({required String dataTableId, required String instanceId, required List<DataTableDeleteValueIdentifier> values}) → Future<BatchDeleteDataTableValueResponse>

Deletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the attribute and its values were accessed. System managed values are not deletable by customers.

batchDescribeDataTableValue({required String dataTableId, required String instanceId, required List<DataTableValueIdentifier> values}) → Future<BatchDescribeDataTableValueResponse>

Retrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

batchDisassociateAnalyticsDataSet({required List<String> dataSetIds, required String instanceId, String? targetAccountId}) → Future<BatchDisassociateAnalyticsDataSetResponse>

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

batchGetAttachedFileMetadata({required String associatedResourceArn, required List<String> fileIds, required String instanceId}) → Future<BatchGetAttachedFileMetadataResponse>

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({required String instanceId, required List<String> resourceIds, ListFlowAssociationResourceType? resourceType}) → Future<BatchGetFlowAssociationResponse>

Retrieve the flow associations for the given resources.

batchPutContact({required List<ContactDataRequest> contactDataRequestList, required String instanceId, String? clientToken}) → Future<BatchPutContactResponse>

PutDialRequestBatch

batchUpdateDataTableValue({required String dataTableId, required String instanceId, required List<DataTableValue> values}) → Future<BatchUpdateDataTableValueResponse>

Updates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation requires proper lock versions to prevent concurrent modification conflicts.

claimPhoneNumber({required String phoneNumber, String? clientToken, String? instanceId, String? phoneNumberDescription, Map<String, String>? tags, String? targetArn}) → Future<ClaimPhoneNumberResponse>

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

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.

completeAttachedFileUpload({required String associatedResourceArn, required String fileId, required String instanceId}) → Future<void>

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

createAgentStatus({required String instanceId, required String name, required AgentStatusState state, String? description, int? displayOrder, Map<String, String>? tags}) → Future<CreateAgentStatusResponse>

Creates an agent status for the specified Connect Customer instance.

createContact({required Channel channel, required ContactInitiationMethod initiationMethod, required String instanceId, Map<String, String>? attributes, String? clientToken, String? description, int? expiryDurationInMinutes, InitiateAs? initiateAs, String? name, String? previousContactId, Map<String, Reference>? references, String? relatedContactId, Map<String, SegmentAttributeValue>? segmentAttributes, UserInfo? userInfo}) → Future<CreateContactResponse>

After a contact is created, you can move it to the desired state by using the InitiateAs parameter. While you can use API to create task contacts that are in the COMPLETED state, you must contact Amazon Web Services Support before using it for bulk import use cases. Bulk import causes your requests to be throttled or fail if your CreateContact limits aren't high enough.

createContactFlow({required String content, required String instanceId, required String name, required ContactFlowType type, String? description, ContactFlowStatus? status, Map<String, String>? tags}) → Future<CreateContactFlowResponse>

Creates a flow for the specified Connect Customer instance.

createContactFlowModule({required String content, required String instanceId, required String name, String? clientToken, String? description, ExternalInvocationConfiguration? externalInvocationConfiguration, String? settings, Map<String, String>? tags}) → Future<CreateContactFlowModuleResponse>

Creates a flow module for the specified Connect Customer instance.

createContactFlowModuleAlias({required String aliasName, required String contactFlowModuleId, required int contactFlowModuleVersion, required String instanceId, String? description}) → Future<CreateContactFlowModuleAliasResponse>

Creates a named alias that points to a specific version of a contact flow module.

createContactFlowModuleVersion({required String contactFlowModuleId, required String instanceId, String? description, String? flowModuleContentSha256}) → Future<CreateContactFlowModuleVersionResponse>

Creates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.

createContactFlowVersion({required String contactFlowId, required String instanceId, int? contactFlowVersion, String? description, String? flowContentSha256, String? lastModifiedRegion, DateTime? lastModifiedTime}) → Future<CreateContactFlowVersionResponse>

Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the FlowContentSha256 provided is different from the FlowContentSha256 of the $LATEST published flow content, then an error is returned. This API only supports creating versions for flows of type Campaign.

createDataTable({required String instanceId, required String name, required DataTableStatus status, required String timeZone, required DataTableLockLevel valueLockLevel, String? description, Map<String, String>? tags}) → Future<CreateDataTableResponse>

Creates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using Amazon Web Services Service Quotas.

createDataTableAttribute({required String dataTableId, required String instanceId, required String name, required DataTableAttributeValueType valueType, String? description, bool? primary, Validation? validation}) → Future<CreateDataTableAttributeResponse>

Adds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This should not affect uniqueness of published data tables since the existing primary values will already be unique. Creating attributes does not create any values. System managed tables may not allow customers to create new attributes.

createEmailAddress({required String emailAddress, required String instanceId, String? clientToken, String? description, String? displayName, Map<String, String>? tags}) → Future<CreateEmailAddressResponse>

Create new email address in the specified Connect Customer instance. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide.

createEvaluationForm({required String instanceId, required List<EvaluationFormItem> items, required String title, bool? asDraft, EvaluationFormAutoEvaluationConfiguration? autoEvaluationConfiguration, String? clientToken, String? description, EvaluationFormLanguageConfiguration? languageConfiguration, EvaluationReviewConfiguration? reviewConfiguration, EvaluationFormScoringStrategy? scoringStrategy, Map<String, String>? tags, EvaluationFormTargetConfiguration? targetConfiguration}) → Future<CreateEvaluationFormResponse>

Creates an evaluation form in the specified Connect Customer 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({required List<HoursOfOperationConfig> config, required String instanceId, required String name, required String timeZone, String? description, List<ParentHoursOfOperationConfig>? parentHoursOfOperationConfigs, Map<String, String>? tags}) → Future<CreateHoursOfOperationResponse>

Creates hours of operation.

createHoursOfOperationOverride({required List<HoursOfOperationOverrideConfig> config, required String effectiveFrom, required String effectiveTill, required String hoursOfOperationId, required String instanceId, required String name, String? description, OverrideType? overrideType, RecurrenceConfig? recurrenceConfig}) → Future<CreateHoursOfOperationOverrideResponse>

Creates an hours of operation override in an Connect Customer hours of operation resource.

createInstance({required DirectoryType identityManagementType, required bool inboundCallsEnabled, required bool outboundCallsEnabled, String? clientToken, String? directoryId, String? instanceAlias, Map<String, String>? tags}) → Future<CreateInstanceResponse>

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

createIntegrationAssociation({required String instanceId, required String integrationArn, required IntegrationType integrationType, String? sourceApplicationName, String? sourceApplicationUrl, SourceType? sourceType, Map<String, String>? tags}) → Future<CreateIntegrationAssociationResponse>

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

createNotification({required Map<LocaleCode, String> content, required String instanceId, required List<String> recipients, String? clientToken, DateTime? expiresAt, String? predefinedNotificationId, ConfigurableNotificationPriority? priority, Map<String, String>? tags}) → Future<CreateNotificationResponse>

Creates a new notification to be delivered to specified recipients. Notifications can include localized content with links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.

createParticipant({required String contactId, required String instanceId, required ParticipantDetailsToAdd participantDetails, String? clientToken}) → Future<CreateParticipantResponse>

Adds a new participant into an on-going chat contact or webRTC call. For more information, see Customize chat flow experiences by integrating custom participants or Enable multi-user web, in-app, and video calling.

createPersistentContactAssociation({required String initialContactId, required String instanceId, required RehydrationType rehydrationType, required String sourceContactId, String? clientToken}) → Future<CreatePersistentContactAssociationResponse>

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

createPredefinedAttribute({required String instanceId, required String name, InputPredefinedAttributeConfiguration? attributeConfiguration, List<String>? purposes, PredefinedAttributeValues? values}) → Future<void>

Creates a new predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value.

createPrompt({required String instanceId, required String name, required String s3Uri, String? description, Map<String, String>? tags}) → Future<CreatePromptResponse>

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

createPushNotificationRegistration({required ContactConfiguration contactConfiguration, required String deviceToken, required DeviceType deviceType, required String instanceId, required String pinpointAppArn, String? clientToken}) → Future<CreatePushNotificationRegistrationResponse>

Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Connect Customer for mobile chat in the Connect Customer Administrator Guide.

createQueue({required String hoursOfOperationId, required String instanceId, required String name, String? description, List<EmailAddressConfig>? emailAddressesConfig, int? maxContacts, OutboundCallerConfig? outboundCallerConfig, OutboundEmailConfig? outboundEmailConfig, List<String>? quickConnectIds, Map<String, String>? tags}) → Future<CreateQueueResponse>

Creates a new queue for the specified Connect Customer instance.

createQuickConnect({required String instanceId, required String name, required QuickConnectConfig quickConnectConfig, String? description, Map<String, String>? tags}) → Future<CreateQuickConnectResponse>

Creates a quick connect for the specified Connect Customer instance.

createRoutingProfile({required String defaultOutboundQueueId, required String description, required String instanceId, required List<MediaConcurrency> mediaConcurrencies, required String name, AgentAvailabilityTimer? agentAvailabilityTimer, List<RoutingProfileManualAssignmentQueueConfig>? manualAssignmentQueueConfigs, List<RoutingProfileQueueConfig>? queueConfigs, Map<String, String>? tags}) → Future<CreateRoutingProfileResponse>

Creates a new routing profile.

createRule({required List<RuleAction> actions, required String function, required String instanceId, required String name, required RulePublishStatus publishStatus, required RuleTriggerEventSource triggerEventSource, String? clientToken}) → Future<CreateRuleResponse>

Creates a rule for the specified Connect Customer instance.

createSecurityProfile({required String instanceId, required String securityProfileName, String? allowedAccessControlHierarchyGroupId, Map<String, String>? allowedAccessControlTags, List<FlowModule>? allowedFlowModules, List<Application>? applications, String? description, GranularAccessControlConfiguration? granularAccessControlConfiguration, List<String>? hierarchyRestrictedResources, List<String>? permissions, List<String>? tagRestrictedResources, Map<String, String>? tags}) → Future<CreateSecurityProfileResponse>

Creates a security profile.

createTaskTemplate({required List<TaskTemplateField> fields, required String instanceId, required String name, String? clientToken, TaskTemplateConstraints? constraints, String? contactFlowId, TaskTemplateDefaults? defaults, String? description, String? selfAssignFlowId, TaskTemplateStatus? status}) → Future<CreateTaskTemplateResponse>

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

createTestCase({required String content, required String instanceId, required String name, String? description, TestCaseEntryPoint? entryPoint, String? initializationData, String? lastModifiedRegion, DateTime? lastModifiedTime, TestCaseStatus? status, Map<String, String>? tags, String? testCaseId}) → Future<CreateTestCaseResponse>

Creates a test case with its content and metadata for the specified Amazon Connect instance.

createTrafficDistributionGroup({required String instanceId, required String name, String? clientToken, String? description, Map<String, String>? tags}) → Future<CreateTrafficDistributionGroupResponse>

Creates a traffic distribution group given an Connect Customer instance that has been replicated. For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Connect Customer Administrator Guide.

createUseCase({required String instanceId, required String integrationAssociationId, required UseCaseType useCaseType, Map<String, String>? tags}) → Future<CreateUseCaseResponse>

Creates a use case for an integration association.

createUser({required String instanceId, required String routingProfileId, required List<String> securityProfileIds, required String username, List<AfterContactWorkConfigPerChannel>? afterContactWorkConfigs, List<AutoAcceptConfig>? autoAcceptConfigs, String? directoryUserId, String? hierarchyGroupId, UserIdentityInfo? identityInfo, String? password, List<PersistentConnectionConfig>? persistentConnectionConfigs, UserPhoneConfig? phoneConfig, List<PhoneNumberConfig>? phoneNumberConfigs, Map<String, String>? tags, List<VoiceEnhancementConfig>? voiceEnhancementConfigs}) → Future<CreateUserResponse>

Creates a user account for the specified Connect Customer instance.

createUserHierarchyGroup({required String instanceId, required String name, String? parentGroupId, Map<String, String>? tags}) → Future<CreateUserHierarchyGroupResponse>

Creates a new user hierarchy group.

createView({required ViewInputContent content, required String instanceId, required String name, required ViewStatus status, String? clientToken, String? description, Map<String, String>? tags}) → Future<CreateViewResponse>

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

createViewVersion({required String instanceId, required String viewId, String? versionDescription, String? viewContentSha256}) → Future<CreateViewVersionResponse>

Publishes a new version of the view identifier.

createVocabulary({required String content, required String instanceId, required VocabularyLanguageCode languageCode, required String vocabularyName, String? clientToken, Map<String, String>? tags}) → Future<CreateVocabularyResponse>

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

createWorkspace({required String instanceId, required String name, String? description, Map<String, String>? tags, WorkspaceTheme? theme, String? title}) → Future<CreateWorkspaceResponse>

Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.

createWorkspacePage({required String instanceId, required String page, required String resourceArn, required String workspaceId, String? inputData, String? slug}) → Future<void>

Associates a view with a page in a workspace, defining what users see when they navigate to that page.

deactivateEvaluationForm({required String evaluationFormId, required int evaluationFormVersion, required String instanceId}) → Future<DeactivateEvaluationFormResponse>

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

deleteAttachedFile({required String associatedResourceArn, required String fileId, required String instanceId}) → Future<void>

Deletes an attached file along with the underlying S3 Object.

deleteContactEvaluation({required String evaluationId, required String instanceId}) → Future<void>

Deletes a contact evaluation in the specified Connect Customer instance.

deleteContactFlow({required String contactFlowId, required String instanceId}) → Future<void>

Deletes a flow for the specified Connect Customer instance.

deleteContactFlowModule({required String contactFlowModuleId, required String instanceId}) → Future<void>

Deletes the specified flow module.

deleteContactFlowModuleAlias({required String aliasId, required String contactFlowModuleId, required String instanceId}) → Future<void>

Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.

deleteContactFlowModuleVersion({required String contactFlowModuleId, required int contactFlowModuleVersion, required String instanceId}) → Future<void>

Removes a specific version of a contact flow module.

deleteContactFlowVersion({required String contactFlowId, required int contactFlowVersion, required String instanceId}) → Future<void>

Deletes the particular version specified in flow version identifier.

deleteDataTable({required String dataTableId, required String instanceId}) → Future<void>

Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.

deleteDataTableAttribute({required String attributeName, required String dataTableId, required String instanceId}) → Future<DeleteDataTableAttributeResponse>

Deletes an attribute and all its values from a data table.

deleteEmailAddress({required String emailAddressId, required String instanceId}) → Future<void>

Deletes email address from the specified Connect Customer instance.

deleteEvaluationForm({required String evaluationFormId, required String instanceId, int? evaluationFormVersion}) → Future<void>

Deletes an evaluation form in the specified Connect Customer instance.

deleteHoursOfOperation({required String hoursOfOperationId, required String instanceId}) → Future<void>

Deletes an hours of operation.

deleteHoursOfOperationOverride({required String hoursOfOperationId, required String hoursOfOperationOverrideId, required String instanceId}) → Future<void>

Deletes an hours of operation override in an Connect Customer hours of operation resource.

deleteInstance({required String instanceId, String? clientToken}) → Future<void>

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

deleteIntegrationAssociation({required String instanceId, required String integrationAssociationId}) → Future<void>

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

deleteNotification({required String instanceId, required String notificationId}) → Future<void>

Deletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs.

deletePredefinedAttribute({required String instanceId, required String name}) → Future<void>

Deletes a predefined attribute from the specified Connect Customer instance.

deletePrompt({required String instanceId, required String promptId}) → Future<void>

Deletes a prompt.

deletePushNotificationRegistration({required String contactId, required String instanceId, required String registrationId}) → Future<void>

Deletes registration for a device token and a chat contact.

deleteQueue({required String instanceId, required String queueId}) → Future<void>

Deletes a queue.

deleteQuickConnect({required String instanceId, required String quickConnectId}) → Future<void>

Deletes a quick connect.

deleteRoutingProfile({required String instanceId, required String routingProfileId}) → Future<void>

Deletes a routing profile.

deleteRule({required String instanceId, required String ruleId}) → Future<void>

Deletes a rule for the specified Connect Customer instance.

deleteSecurityProfile({required String instanceId, required String securityProfileId}) → Future<void>

Deletes a security profile.

deleteTaskTemplate({required String instanceId, required String taskTemplateId}) → Future<void>

Deletes the task template.

deleteTestCase({required String instanceId, required String testCaseId}) → Future<void>

Deletes the test case that has already been created for the specified Amazon Connect instance.

deleteTrafficDistributionGroup({required String trafficDistributionGroupId}) → Future<void>

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

deleteUseCase({required String instanceId, required String integrationAssociationId, required String useCaseId}) → Future<void>

Deletes a use case from an integration association.

deleteUser({required String instanceId, required String userId}) → Future<void>

Deletes a user account from the specified Connect Customer 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.

deleteView({required String instanceId, required String viewId}) → Future<void>

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

deleteViewVersion({required String instanceId, required String viewId, required int viewVersion}) → Future<void>

Deletes the particular version specified in ViewVersion identifier.

deleteVocabulary({required String instanceId, required String vocabularyId}) → Future<DeleteVocabularyResponse>

Deletes the vocabulary that has the given identifier.

deleteWorkspace({required String instanceId, required String workspaceId}) → Future<void>

Deletes a workspace and removes all associated view and resource assignments.

deleteWorkspaceMedia({required String instanceId, required MediaType mediaType, required String workspaceId}) → Future<void>

Deletes a media asset (such as a logo) from a workspace.

deleteWorkspacePage({required String instanceId, required String page, required String workspaceId}) → Future<void>

Removes the association between a view and a page in a workspace. The page will display the default view after deletion.

describeAgentStatus({required String agentStatusId, required String instanceId}) → Future<DescribeAgentStatusResponse>

Describes an agent status.

describeAttachedFilesConfiguration({required AttachmentScope attachmentScope, required String instanceId}) → Future<DescribeAttachedFilesConfigurationResponse>

Describes the attached files configuration for the specified Connect Customer instance and attachment scope.

describeAuthenticationProfile({required String authenticationProfileId, required String instanceId}) → Future<DescribeAuthenticationProfileResponse>

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

describeContact({required String contactId, required String instanceId}) → Future<DescribeContactResponse>

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

describeContactEvaluation({required String evaluationId, required String instanceId}) → Future<DescribeContactEvaluationResponse>

Describes a contact evaluation in the specified Connect Customer instance.

describeContactFlow({required String contactFlowId, required String instanceId}) → Future<DescribeContactFlowResponse>

Describes the specified flow.

describeContactFlowModule({required String contactFlowModuleId, required String instanceId}) → Future<DescribeContactFlowModuleResponse>

Describes the specified flow module.

describeContactFlowModuleAlias({required String aliasId, required String contactFlowModuleId, required String instanceId}) → Future<DescribeContactFlowModuleAliasResponse>

Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.

describeDataTable({required String dataTableId, required String instanceId}) → Future<DescribeDataTableResponse>

Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

describeDataTableAttribute({required String attributeName, required String dataTableId, required String instanceId}) → Future<DescribeDataTableAttributeResponse>

Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

describeEmailAddress({required String emailAddressId, required String instanceId}) → Future<DescribeEmailAddressResponse>

Describe email address form the specified Connect Customer instance.

describeEvaluationForm({required String evaluationFormId, required String instanceId, int? evaluationFormVersion}) → Future<DescribeEvaluationFormResponse>

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

describeHoursOfOperation({required String hoursOfOperationId, required String instanceId}) → Future<DescribeHoursOfOperationResponse>

Describes the hours of operation.

describeHoursOfOperationOverride({required String hoursOfOperationId, required String hoursOfOperationOverrideId, required String instanceId}) → Future<DescribeHoursOfOperationOverrideResponse>

Describes the hours of operation override.

describeInstance({required String instanceId}) → Future<DescribeInstanceResponse>

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

describeInstanceAttribute({required InstanceAttributeType attributeType, required String instanceId}) → Future<DescribeInstanceAttributeResponse>

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

describeInstanceStorageConfig({required String associationId, required String instanceId, required InstanceStorageResourceType resourceType}) → Future<DescribeInstanceStorageConfigResponse>

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

describeNotification({required String instanceId, required String notificationId}) → Future<DescribeNotificationResponse>

Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.

describePhoneNumber({required String phoneNumberId}) → Future<DescribePhoneNumberResponse>

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

describePredefinedAttribute({required String instanceId, required String name}) → Future<DescribePredefinedAttributeResponse>

Describes a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for:

describePrompt({required String instanceId, required String promptId}) → Future<DescribePromptResponse>

Describes the prompt.

describeQueue({required String instanceId, required String queueId}) → Future<DescribeQueueResponse>

Describes the specified queue.

describeQuickConnect({required String instanceId, required String quickConnectId}) → Future<DescribeQuickConnectResponse>

Describes the quick connect.

describeRoutingProfile({required String instanceId, required String routingProfileId}) → Future<DescribeRoutingProfileResponse>

Describes the specified routing profile.

describeRule({required String instanceId, required String ruleId}) → Future<DescribeRuleResponse>

Describes a rule for the specified Connect Customer instance.

describeSecurityProfile({required String instanceId, required String securityProfileId}) → Future<DescribeSecurityProfileResponse>

Gets basic information about the security profile.

describeTestCase({required String instanceId, required String testCaseId, TestCaseStatus? status}) → Future<DescribeTestCaseResponse>

Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.

describeTrafficDistributionGroup({required String trafficDistributionGroupId}) → Future<DescribeTrafficDistributionGroupResponse>

Gets details and status of a traffic distribution group.

describeUser({required String instanceId, required String userId}) → Future<DescribeUserResponse>

Describes the specified user. You can find the instance ID in the Connect Customer 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 Connect Customer instance.

describeView({required String instanceId, required String viewId}) → Future<DescribeViewResponse>

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

describeVocabulary({required String instanceId, required String vocabularyId}) → Future<DescribeVocabularyResponse>

Describes the specified vocabulary.

describeWorkspace({required String instanceId, required String workspaceId}) → Future<DescribeWorkspaceResponse>

Retrieves details about a workspace, including its configuration and metadata.

disassociateAnalyticsDataSet({required String dataSetId, required String instanceId, String? targetAccountId}) → Future<void>

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

disassociateApprovedOrigin({required String instanceId, required String origin, String? clientToken}) → Future<void>

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

disassociateBot({required String instanceId, String? clientToken, LexBot? lexBot, LexV2Bot? lexV2Bot}) → Future<void>

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

disassociateEmailAddressAlias({required AliasConfiguration aliasConfiguration, required String emailAddressId, required String instanceId, String? clientToken}) → Future<void>

Removes the alias association between two email addresses in an Connect Customer instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly.

disassociateFlow({required String instanceId, required String resourceId, required FlowAssociationResourceType resourceType}) → Future<void>

Disassociates a connect resource from a flow.

disassociateHoursOfOperations({required String hoursOfOperationId, required String instanceId, required List<String> parentHoursOfOperationIds}) → Future<void>

Disassociates a set of hours of operations with another hours of operation. Refer to Administrator Guide here for more information on inheriting overrides from parent hours of operation(s).

disassociateInstanceStorageConfig({required String associationId, required String instanceId, required InstanceStorageResourceType resourceType, String? clientToken}) → Future<void>

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

disassociateLambdaFunction({required String functionArn, required String instanceId, String? clientToken}) → Future<void>

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

disassociateLexBot({required String botName, required String instanceId, required String lexRegion, String? clientToken}) → Future<void>

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

disassociatePhoneNumberContactFlow({required String instanceId, required String phoneNumberId}) → Future<void>

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

disassociateQueueEmailAddresses({required List<String> emailAddressesId, required String instanceId, required String queueId, String? clientToken}) → Future<void>

Removes the association between a set of email addresses and a queue. After disassociation, agents will no longer be able to select these email addresses as "From" addresses when replying to inbound email contacts or initiating outbound email contacts in this queue.

disassociateQueueQuickConnects({required String instanceId, required String queueId, required List<String> quickConnectIds}) → Future<void>

Disassociates a set of quick connects from a queue.

disassociateRoutingProfileQueues({required String instanceId, required String routingProfileId, List<RoutingProfileQueueReference>? manualAssignmentQueueReferences, List<RoutingProfileQueueReference>? queueReferences}) → Future<void>

Disassociates a set of queues from a routing profile.

disassociateSecurityKey({required String associationId, required String instanceId, String? clientToken}) → Future<void>

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

disassociateSecurityProfiles({required String entityArn, required EntityType entityType, required String instanceId, required List<SecurityProfileItem> securityProfiles}) → Future<void>

Disassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance.

disassociateTrafficDistributionGroupUser({required String instanceId, required String trafficDistributionGroupId, required String userId}) → Future<void>

Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

disassociateUserProficiencies({required String instanceId, required String userId, required List<UserProficiencyDisassociate> userProficiencies}) → Future<void>

Disassociates a set of proficiencies from a user.

disassociateWorkspace({required String instanceId, required List<String> resourceArns, required String workspaceId}) → Future<DisassociateWorkspaceResponse>

Removes the association between a workspace and one or more users or routing profiles.

dismissUserContact({required String contactId, required String instanceId, required String userId}) → Future<void>

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.

evaluateDataTableValues({required String dataTableId, required String instanceId, required List<DataTableValueEvaluationSet> values, int? maxResults, String? nextToken, String? timeZone}) → Future<EvaluateDataTableValuesResponse>

Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: Amazon Web Services API Standards.

getAttachedFile({required String associatedResourceArn, required String fileId, required String instanceId, int? urlExpiryInSeconds}) → Future<GetAttachedFileResponse>

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({required String initialContactId, required String instanceId}) → Future<GetContactAttributesResponse>

Retrieves the contact attributes for the specified contact.

getContactMetrics({required String contactId, required String instanceId, required List<ContactMetricInfo> metrics}) → Future<GetContactMetricsResponse>

Retrieves contact metric data for a specified contact.

getCurrentMetricData({required List<CurrentMetric> currentMetrics, required Filters filters, required String instanceId, List<Grouping>? groupings, int? maxResults, String? nextToken, List<CurrentMetricSortCriteria>? sortCriteria}) → Future<GetCurrentMetricDataResponse>

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

getCurrentUserData({required UserDataFilters filters, required String instanceId, int? maxResults, String? nextToken}) → Future<GetCurrentUserDataResponse>

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

getEffectiveHoursOfOperations({required String fromDate, required String hoursOfOperationId, required String instanceId, required String toDate}) → Future<GetEffectiveHoursOfOperationsResponse>

Get the hours of operations with the effective override applied.

getFederationToken({required String instanceId}) → Future<GetFederationTokenResponse>

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

getFlowAssociation({required String instanceId, required String resourceId, required FlowAssociationResourceType resourceType}) → Future<GetFlowAssociationResponse>

Retrieves the flow associated for a given resource.

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 Connect Customer instance.

getMetricDataV2({required DateTime endTime, required List<FilterV2> filters, required List<MetricV2> metrics, required String resourceArn, required DateTime startTime, List<String>? groupings, IntervalDetails? interval, int? maxResults, String? nextToken}) → Future<GetMetricDataV2Response>

Gets metric data from the specified Connect Customer instance.

getPromptFile({required String instanceId, required String promptId}) → Future<GetPromptFileResponse>

Gets the prompt file.

getTaskTemplate({required String instanceId, required String taskTemplateId, String? snapshotVersion}) → Future<GetTaskTemplateResponse>

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

getTestCaseExecutionSummary({required String instanceId, required String testCaseExecutionId, required String testCaseId}) → Future<GetTestCaseExecutionSummaryResponse>

Retrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.

getTrafficDistribution({required String id}) → Future<GetTrafficDistributionResponse>

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

importPhoneNumber({required String instanceId, required String sourcePhoneNumberArn, String? clientToken, String? phoneNumberDescription, Map<String, String>? tags}) → Future<ImportPhoneNumberResponse>

Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Connect Customer instance. You can call this API only in the same Amazon Web Services Region where the Connect Customer instance was created. 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.

importWorkspaceMedia({required String instanceId, required String mediaSource, required MediaType mediaType, required String workspaceId}) → Future<void>

Imports a media asset (such as a logo) for use in a workspace.

listAgentStatuses({required String instanceId, List<AgentStatusType>? agentStatusTypes, int? maxResults, String? nextToken}) → Future<ListAgentStatusResponse>

Lists agent statuses.

listAnalyticsDataAssociations({required String instanceId, String? dataSetId, int? maxResults, String? nextToken}) → Future<ListAnalyticsDataAssociationsResponse>

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

listAnalyticsDataLakeDataSets({required String instanceId, int? maxResults, String? nextToken}) → Future<ListAnalyticsDataLakeDataSetsResponse>

Lists the data lake datasets available to associate with for a given Connect Customer instance.

listApprovedOrigins({required String instanceId, int? maxResults, String? nextToken}) → Future<ListApprovedOriginsResponse>

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

listAssociatedContacts({required String contactId, required String instanceId, int? maxResults, String? nextToken}) → Future<ListAssociatedContactsResponse>

Provides information about contact tree, a list of associated contacts with a unique identifier.

listAttachedFilesConfigurations({required String instanceId, int? maxResults, String? nextToken}) → Future<ListAttachedFilesConfigurationsResponse>

Provides summary information about the attached files configurations for the specified Connect Customer instance.

listAuthenticationProfiles({required String instanceId, int? maxResults, String? nextToken}) → Future<ListAuthenticationProfilesResponse>

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

listBots({required String instanceId, required LexVersion lexVersion, int? maxResults, String? nextToken}) → Future<ListBotsResponse>

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

listChildHoursOfOperations({required String hoursOfOperationId, required String instanceId, int? maxResults, String? nextToken}) → Future<ListChildHoursOfOperationsResponse>

Provides information about the child hours of operations for the specified parent hours of operation.

listContactEvaluations({required String contactId, required String instanceId, String? nextToken}) → Future<ListContactEvaluationsResponse>

Lists contact evaluations in the specified Connect Customer instance.

listContactFlowModuleAliases({required String contactFlowModuleId, required String instanceId, int? maxResults, String? nextToken}) → Future<ListContactFlowModuleAliasesResponse>

Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.

listContactFlowModules({required String instanceId, ContactFlowModuleState? contactFlowModuleState, int? maxResults, String? nextToken}) → Future<ListContactFlowModulesResponse>

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

listContactFlowModuleVersions({required String contactFlowModuleId, required String instanceId, int? maxResults, String? nextToken}) → Future<ListContactFlowModuleVersionsResponse>

Retrieves a paginated list of all versions for a specific contact flow module.

listContactFlows({required String instanceId, List<ContactFlowType>? contactFlowTypes, int? maxResults, String? nextToken}) → Future<ListContactFlowsResponse>

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

listContactFlowVersions({required String contactFlowId, required String instanceId, int? maxResults, String? nextToken}) → Future<ListContactFlowVersionsResponse>

Returns all the available versions for the specified Connect Customer instance and flow identifier.

listContactReferences({required String contactId, required String instanceId, required List<ReferenceType> referenceTypes, String? nextToken}) → Future<ListContactReferencesResponse>

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

listDataTableAttributes({required String dataTableId, required String instanceId, List<String>? attributeIds, int? maxResults, String? nextToken}) → Future<ListDataTableAttributesResponse>

Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.

listDataTablePrimaryValues({required String dataTableId, required String instanceId, int? maxResults, String? nextToken, List<PrimaryAttributeValueFilter>? primaryAttributeValues, List<String>? recordIds}) → Future<ListDataTablePrimaryValuesResponse>

Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.

listDataTables({required String instanceId, int? maxResults, String? nextToken}) → Future<ListDataTablesResponse>

Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.

listDataTableValues({required String dataTableId, required String instanceId, int? maxResults, String? nextToken, List<PrimaryAttributeValueFilter>? primaryAttributeValues, List<String>? recordIds}) → Future<ListDataTableValuesResponse>

Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.

listDefaultVocabularies({required String instanceId, VocabularyLanguageCode? languageCode, int? maxResults, String? nextToken}) → Future<ListDefaultVocabulariesResponse>

Lists the default vocabularies for the specified Connect Customer instance.

listEntitySecurityProfiles({required String entityArn, required EntityType entityType, required String instanceId, int? maxResults, String? nextToken}) → Future<ListEntitySecurityProfilesResponse>

Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.

listEvaluationForms({required String instanceId, int? maxResults, String? nextToken}) → Future<ListEvaluationFormsResponse>

Lists evaluation forms in the specified Connect Customer instance.

listEvaluationFormVersions({required String evaluationFormId, required String instanceId, int? maxResults, String? nextToken}) → Future<ListEvaluationFormVersionsResponse>

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

listFlowAssociations({required String instanceId, int? maxResults, String? nextToken, ListFlowAssociationResourceType? resourceType}) → Future<ListFlowAssociationsResponse>

List the flow association based on the filters.

listHoursOfOperationOverrides({required String hoursOfOperationId, required String instanceId, int? maxResults, String? nextToken}) → Future<ListHoursOfOperationOverridesResponse>

List the hours of operation overrides.

listHoursOfOperations({required String instanceId, int? maxResults, String? nextToken}) → Future<ListHoursOfOperationsResponse>

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

listInstanceAttributes({required String instanceId, int? maxResults, String? nextToken}) → Future<ListInstanceAttributesResponse>

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

listInstances({int? maxResults, String? nextToken}) → Future<ListInstancesResponse>

This API is in preview release for Connect Customer 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 Connect Customer and is subject to change.

listIntegrationAssociations({required String instanceId, String? integrationArn, IntegrationType? integrationType, int? maxResults, String? nextToken}) → Future<ListIntegrationAssociationsResponse>

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

listLambdaFunctions({required String instanceId, int? maxResults, String? nextToken}) → Future<ListLambdaFunctionsResponse>

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

listLexBots({required String instanceId, int? maxResults, String? nextToken}) → Future<ListLexBotsResponse>

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

listNotifications({required String instanceId, int? maxResults, String? nextToken}) → Future<ListNotificationsResponse>

Retrieves a paginated list of all notifications in the Amazon Connect instance.

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 Connect Customer instance.

listPhoneNumbersV2({String? instanceId, int? maxResults, String? nextToken, List<PhoneNumberCountryCode>? phoneNumberCountryCodes, String? phoneNumberPrefix, List<PhoneNumberType>? phoneNumberTypes, String? targetArn}) → Future<ListPhoneNumbersV2Response>

Lists phone numbers claimed to your Connect Customer 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.

listPredefinedAttributes({required String instanceId, int? maxResults, String? nextToken}) → Future<ListPredefinedAttributesResponse>

Lists predefined attributes for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for:

listPrompts({required String instanceId, int? maxResults, String? nextToken}) → Future<ListPromptsResponse>

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

listQueueEmailAddresses({required String instanceId, required String queueId, int? maxResults, String? nextToken}) → Future<ListQueueEmailAddressesResponse>

Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent email address options and understand the available choices for different brands and business units.

listQueueQuickConnects({required String instanceId, required String queueId, int? maxResults, String? nextToken}) → Future<ListQueueQuickConnectsResponse>

Lists the quick connects associated with a queue.

listQueues({required String instanceId, int? maxResults, String? nextToken, List<QueueType>? queueTypes}) → Future<ListQueuesResponse>

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

listQuickConnects({required String instanceId, int? maxResults, String? nextToken, List<QuickConnectType>? quickConnectTypes}) → Future<ListQuickConnectsResponse>

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

listRealtimeContactAnalysisSegmentsV2({required String contactId, required String instanceId, required RealTimeContactAnalysisOutputType outputType, required List<RealTimeContactAnalysisSegmentType> segmentTypes, int? maxResults, String? nextToken}) → Future<ListRealtimeContactAnalysisSegmentsV2Response>

Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only.

listRoutingProfileManualAssignmentQueues({required String instanceId, required String routingProfileId, int? maxResults, String? nextToken}) → Future<ListRoutingProfileManualAssignmentQueuesResponse>

Lists the manual assignment queues associated with a routing profile.

listRoutingProfileQueues({required String instanceId, required String routingProfileId, int? maxResults, String? nextToken}) → Future<ListRoutingProfileQueuesResponse>

Lists 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 Connect Customer instance.

listRules({required String instanceId, EventSourceName? eventSourceName, int? maxResults, String? nextToken, RulePublishStatus? publishStatus}) → Future<ListRulesResponse>

List all rules for the specified Connect Customer instance.

listSecurityKeys({required String instanceId, int? maxResults, String? nextToken}) → Future<ListSecurityKeysResponse>

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

listSecurityProfileApplications({required String instanceId, required String securityProfileId, int? maxResults, String? nextToken}) → Future<ListSecurityProfileApplicationsResponse>

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

listSecurityProfileFlowModules({required String instanceId, required String securityProfileId, int? maxResults, String? nextToken}) → Future<ListSecurityProfileFlowModulesResponse>

A list of Flow Modules an AI Agent can invoke as a tool

listSecurityProfilePermissions({required String instanceId, required String securityProfileId, int? maxResults, String? nextToken}) → Future<ListSecurityProfilePermissionsResponse>

Lists the permissions granted to a security profile.

listSecurityProfiles({required String instanceId, int? maxResults, String? nextToken}) → Future<ListSecurityProfilesResponse>

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

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>

Lists the tags for the specified resource.

listTaskTemplates({required String instanceId, int? maxResults, String? name, String? nextToken, TaskTemplateStatus? status}) → Future<ListTaskTemplatesResponse>

Lists task templates for the specified Connect Customer instance.

listTestCaseExecutionRecords({required String instanceId, required String testCaseExecutionId, required String testCaseId, int? maxResults, String? nextToken, TestCaseExecutionStatus? status}) → Future<ListTestCaseExecutionRecordsResponse>

Lists detailed steps of test case execution that includes all observations along with actions taken and data associated in the specified Amazon Connect instance.

listTestCaseExecutions({required String instanceId, int? endTime, int? maxResults, String? nextToken, int? startTime, TestCaseExecutionStatus? status, String? testCaseId, String? testCaseName}) → Future<ListTestCaseExecutionsResponse>

Lists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon Connect instance.

listTestCases({required String instanceId, int? maxResults, String? nextToken}) → Future<ListTestCasesResponse>

Lists the test cases present in the specific Amazon Connect instance.

listTrafficDistributionGroups({String? instanceId, int? maxResults, String? nextToken}) → Future<ListTrafficDistributionGroupsResponse>

Lists traffic distribution groups.

listTrafficDistributionGroupUsers({required String trafficDistributionGroupId, int? maxResults, String? nextToken}) → Future<ListTrafficDistributionGroupUsersResponse>

Lists traffic distribution group users.

listUseCases({required String instanceId, required String integrationAssociationId, int? maxResults, String? nextToken}) → Future<ListUseCasesResponse>

Lists the use cases for the integration association.

listUserHierarchyGroups({required String instanceId, int? maxResults, String? nextToken}) → Future<ListUserHierarchyGroupsResponse>

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

listUserNotifications({required String instanceId, required String userId, int? maxResults, String? nextToken}) → Future<ListUserNotificationsResponse>

Retrieves a paginated list of notifications for a specific user, including the notification status for that user.

listUserProficiencies({required String instanceId, required String userId, int? maxResults, String? nextToken}) → Future<ListUserProficienciesResponse>

Lists proficiencies associated with a user.

listUsers({required String instanceId, int? maxResults, String? nextToken}) → Future<ListUsersResponse>

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

listViews({required String instanceId, int? maxResults, String? nextToken, ViewType? type}) → Future<ListViewsResponse>

Returns views in the given instance.

listViewVersions({required String instanceId, required String viewId, int? maxResults, String? nextToken}) → Future<ListViewVersionsResponse>

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

listWorkspaceMedia({required String instanceId, required String workspaceId}) → Future<ListWorkspaceMediaResponse>

Lists media assets (such as logos) associated with a workspace.

listWorkspacePages({required String instanceId, required String workspaceId, int? maxResults, String? nextToken}) → Future<ListWorkspacePagesResponse>

Lists the page configurations in a workspace, including the views assigned to each page.

listWorkspaces({required String instanceId, int? maxResults, String? nextToken}) → Future<ListWorkspacesResponse>

Lists the workspaces in an Amazon Connect instance.

monitorContact({required String contactId, required String instanceId, required String userId, List<MonitorCapability>? allowedMonitorCapabilities, String? clientToken}) → Future<MonitorContactResponse>

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.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pauseContact({required String contactId, required String instanceId, String? contactFlowId}) → Future<void>

Allows pausing an ongoing task contact.

putUserStatus({required String agentStatusId, required String instanceId, required String userId}) → Future<void>

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

releasePhoneNumber({required String phoneNumberId, String? clientToken}) → Future<void>

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

replicateInstance({required String instanceId, required String replicaAlias, required String replicaRegion, String? clientToken}) → Future<ReplicateInstanceResponse>

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

resumeContact({required String contactId, required String instanceId, String? contactFlowId}) → Future<void>

Allows resuming a task contact in a paused state.

resumeContactRecording({required String contactId, required String initialContactId, required String instanceId, ContactRecordingType? contactRecordingType}) → Future<void>

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.

searchAgentStatuses({required String instanceId, int? maxResults, String? nextToken, AgentStatusSearchCriteria? searchCriteria, AgentStatusSearchFilter? searchFilter}) → Future<SearchAgentStatusesResponse>

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

searchAvailablePhoneNumbers({required PhoneNumberCountryCode phoneNumberCountryCode, required PhoneNumberType phoneNumberType, String? instanceId, int? maxResults, String? nextToken, String? phoneNumberPrefix, String? targetArn}) → Future<SearchAvailablePhoneNumbersResponse>

Searches for available phone numbers that you can claim to your Connect Customer 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.

searchContactEvaluations({required String instanceId, int? maxResults, String? nextToken, EvaluationSearchCriteria? searchCriteria, EvaluationSearchFilter? searchFilter}) → Future<SearchContactEvaluationsResponse>

Searches contact evaluations in an Connect Customer instance, with optional filtering.

searchContactFlowModules({required String instanceId, int? maxResults, String? nextToken, ContactFlowModuleSearchCriteria? searchCriteria, ContactFlowModuleSearchFilter? searchFilter}) → Future<SearchContactFlowModulesResponse>

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

searchContactFlows({required String instanceId, int? maxResults, String? nextToken, ContactFlowSearchCriteria? searchCriteria, ContactFlowSearchFilter? searchFilter}) → Future<SearchContactFlowsResponse>

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

searchContacts({required String instanceId, required SearchContactsTimeRange timeRange, int? maxResults, String? nextToken, SearchCriteria? searchCriteria, Sort? sort}) → Future<SearchContactsResponse>

Searches contacts in an Connect Customer instance.

searchDataTables({required String instanceId, int? maxResults, String? nextToken, DataTableSearchCriteria? searchCriteria, DataTableSearchFilter? searchFilter}) → Future<SearchDataTablesResponse>

Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.

searchEmailAddresses({required String instanceId, int? maxResults, String? nextToken, EmailAddressSearchCriteria? searchCriteria, EmailAddressSearchFilter? searchFilter}) → Future<SearchEmailAddressesResponse>

Searches email address in an instance, with optional filtering.

searchEvaluationForms({required String instanceId, int? maxResults, String? nextToken, EvaluationFormSearchCriteria? searchCriteria, EvaluationFormSearchFilter? searchFilter}) → Future<SearchEvaluationFormsResponse>

Searches evaluation forms in an Connect Customer instance, with optional filtering.

searchHoursOfOperationOverrides({required String instanceId, int? maxResults, String? nextToken, HoursOfOperationOverrideSearchCriteria? searchCriteria, HoursOfOperationSearchFilter? searchFilter}) → Future<SearchHoursOfOperationOverridesResponse>

Searches the hours of operation overrides.

searchHoursOfOperations({required String instanceId, int? maxResults, String? nextToken, HoursOfOperationSearchCriteria? searchCriteria, HoursOfOperationSearchFilter? searchFilter}) → Future<SearchHoursOfOperationsResponse>

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

searchNotifications({required String instanceId, int? maxResults, String? nextToken, NotificationSearchCriteria? searchCriteria, NotificationSearchFilter? searchFilter}) → Future<SearchNotificationsResponse>

Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.

searchPredefinedAttributes({required String instanceId, int? maxResults, String? nextToken, PredefinedAttributeSearchCriteria? searchCriteria}) → Future<SearchPredefinedAttributesResponse>

Searches predefined attributes that meet certain criteria. A predefined attribute is made up of a name and a value. You can use predefined attributes for:

searchPrompts({required String instanceId, int? maxResults, String? nextToken, PromptSearchCriteria? searchCriteria, PromptSearchFilter? searchFilter}) → Future<SearchPromptsResponse>

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

searchQueues({required String instanceId, int? maxResults, String? nextToken, QueueSearchCriteria? searchCriteria, QueueSearchFilter? searchFilter}) → Future<SearchQueuesResponse>

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

searchQuickConnects({required String instanceId, int? maxResults, String? nextToken, QuickConnectSearchCriteria? searchCriteria, QuickConnectSearchFilter? searchFilter}) → Future<SearchQuickConnectsResponse>

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

searchResourceTags({required String instanceId, int? maxResults, String? nextToken, List<String>? resourceTypes, ResourceTagsSearchCriteria? searchCriteria}) → Future<SearchResourceTagsResponse>

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

searchRoutingProfiles({required String instanceId, int? maxResults, String? nextToken, RoutingProfileSearchCriteria? searchCriteria, RoutingProfileSearchFilter? searchFilter}) → Future<SearchRoutingProfilesResponse>

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

searchSecurityProfiles({required String instanceId, int? maxResults, String? nextToken, SecurityProfileSearchCriteria? searchCriteria, SecurityProfilesSearchFilter? searchFilter}) → Future<SearchSecurityProfilesResponse>

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

searchTestCases({required String instanceId, int? maxResults, String? nextToken, TestCaseSearchCriteria? searchCriteria, TestCaseSearchFilter? searchFilter}) → Future<SearchTestCasesResponse>

Searches for test cases in the specified Amazon Connect instance, with optional filtering.

searchUserHierarchyGroups({required String instanceId, int? maxResults, String? nextToken, UserHierarchyGroupSearchCriteria? searchCriteria, UserHierarchyGroupSearchFilter? searchFilter}) → Future<SearchUserHierarchyGroupsResponse>

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

searchUsers({required String instanceId, int? maxResults, String? nextToken, UserSearchCriteria? searchCriteria, UserSearchFilter? searchFilter}) → Future<SearchUsersResponse>

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

searchViews({required String instanceId, int? maxResults, String? nextToken, ViewSearchCriteria? searchCriteria, ViewSearchFilter? searchFilter}) → Future<SearchViewsResponse>

Searches views based on name, description, or tags.

searchVocabularies({required String instanceId, VocabularyLanguageCode? languageCode, int? maxResults, String? nameStartsWith, String? nextToken, VocabularyState? state}) → Future<SearchVocabulariesResponse>

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

searchWorkspaceAssociations({required String instanceId, int? maxResults, String? nextToken, WorkspaceAssociationSearchCriteria? searchCriteria, WorkspaceAssociationSearchFilter? searchFilter}) → Future<SearchWorkspaceAssociationsResponse>

Searches for workspace associations with users or routing profiles based on various criteria.

searchWorkspaces({required String instanceId, int? maxResults, String? nextToken, WorkspaceSearchCriteria? searchCriteria, WorkspaceSearchFilter? searchFilter}) → Future<SearchWorkspacesResponse>

Searches workspaces based on name, description, visibility, or tags.

sendChatIntegrationEvent({required String destinationId, required ChatEvent event, required String sourceId, NewSessionDetails? newSessionDetails, String? subtype}) → Future<SendChatIntegrationEventResponse>

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

sendOutboundEmail({required EmailAddressInfo destinationEmailAddress, required OutboundEmailContent emailMessage, required EmailAddressInfo fromEmailAddress, required String instanceId, required TrafficType trafficType, OutboundAdditionalRecipients? additionalRecipients, String? clientToken, SourceCampaign? sourceCampaign}) → Future<void>

Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns.

startAttachedFileUpload({required String associatedResourceArn, required String fileName, required int fileSizeInBytes, required FileUseCaseType fileUseCaseType, required String instanceId, String? clientToken, CreatedByInfo? createdBy, Map<String, String>? tags, int? urlExpiryInSeconds}) → Future<StartAttachedFileUploadResponse>

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

startChatContact({required String contactFlowId, required String instanceId, required ParticipantDetails participantDetails, Map<String, String>? attributes, int? chatDurationInMinutes, String? clientToken, String? customerId, List<DisconnectOnCustomerExitParticipantType>? disconnectOnCustomerExit, ChatMessage? initialMessage, ParticipantConfiguration? participantConfiguration, PersistentChat? persistentChat, String? relatedContactId, Map<String, SegmentAttributeValue>? segmentAttributes, List<String>? supportedMessagingContentTypes}) → Future<StartChatContactResponse>

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 Connect Customer Participant Service.

startContactEvaluation({required String contactId, required String evaluationFormId, required String instanceId, AutoEvaluationConfiguration? autoEvaluationConfiguration, String? clientToken, Map<String, String>? tags}) → Future<StartContactEvaluationResponse>

Starts an empty evaluation in the specified Connect Customer 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.

startContactMediaProcessing({String? contactId, ContactMediaProcessingFailureMode? failureMode, String? instanceId, String? processorArn}) → Future<void>

Enables in-flight message processing for an ongoing chat session. Message processing will stay active for the rest of the chat, even if an individual contact segment ends.

startContactRecording({required String contactId, required String initialContactId, required String instanceId, required VoiceRecordingConfiguration voiceRecordingConfiguration}) → Future<void>

Starts recording the contact:

startContactStreaming({required ChatStreamingConfiguration chatStreamingConfiguration, required String contactId, required String instanceId, String? clientToken}) → Future<StartContactStreamingResponse>

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

startEmailContact({required String destinationEmailAddress, required InboundEmailContent emailMessage, required EmailAddressInfo fromEmailAddress, required String instanceId, InboundAdditionalRecipients? additionalRecipients, List<EmailAttachment>? attachments, Map<String, String>? attributes, String? clientToken, String? contactFlowId, String? description, String? name, Map<String, Reference>? references, String? relatedContactId, Map<String, SegmentAttributeValue>? segmentAttributes}) → Future<StartEmailContactResponse>

Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.

startOutboundChatContact({required String contactFlowId, required Endpoint destinationEndpoint, required String instanceId, required Map<String, SegmentAttributeValue> segmentAttributes, required Endpoint sourceEndpoint, Map<String, String>? attributes, int? chatDurationInMinutes, String? clientToken, ChatMessage? initialSystemMessage, TemplatedMessageConfig? initialTemplatedSystemMessage, ParticipantDetails? participantDetails, String? relatedContactId, List<String>? supportedMessagingContentTypes}) → Future<StartOutboundChatContactResponse>

Initiates a new outbound SMS or WhatsApp contact to a customer. Response of this API provides the ContactId of the outbound SMS or WhatsApp contact created.

startOutboundEmailContact({required String contactId, required EmailAddressInfo destinationEmailAddress, required OutboundEmailContent emailMessage, required String instanceId, OutboundAdditionalRecipients? additionalRecipients, String? clientToken, EmailAddressInfo? fromEmailAddress}) → Future<StartOutboundEmailContactResponse>

Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.

startOutboundVoiceContact({required String contactFlowId, required String destinationPhoneNumber, required String instanceId, AnswerMachineDetectionConfig? answerMachineDetectionConfig, Map<String, String>? attributes, String? campaignId, String? clientToken, String? description, String? name, OutboundStrategy? outboundStrategy, String? queueId, Map<String, Reference>? references, String? relatedContactId, int? ringTimeoutInSeconds, String? sourcePhoneNumber, TrafficType? trafficType}) → Future<StartOutboundVoiceContactResponse>

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

startScreenSharing({required String contactId, required String instanceId, String? clientToken}) → Future<void>

Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, video calling, and screen sharing capabilities in the Connect Customer Administrator Guide.

startTaskContact({required String instanceId, required String name, List<TaskAttachment>? attachments, Map<String, String>? attributes, String? clientToken, String? contactFlowId, String? description, String? previousContactId, String? quickConnectId, Map<String, Reference>? references, String? relatedContactId, DateTime? scheduledTime, Map<String, SegmentAttributeValue>? segmentAttributes, String? taskTemplateId}) → Future<StartTaskContactResponse>

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

startTestCaseExecution({required String instanceId, required String testCaseId, String? clientToken}) → Future<StartTestCaseExecutionResponse>

Starts executing a published test case.

startWebRTCContact({required String contactFlowId, required String instanceId, required ParticipantDetails participantDetails, AllowedCapabilities? allowedCapabilities, Map<String, String>? attributes, String? clientToken, String? description, Map<String, Reference>? references, String? relatedContactId}) → Future<StartWebRTCContactResponse>

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 Connect Customer instance (specified as InstanceId).

stopContact({required String contactId, required String instanceId, DisconnectReason? disconnectReason}) → Future<void>

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

stopContactMediaProcessing({String? contactId, String? instanceId}) → Future<void>

Stops in-flight message processing for an ongoing chat session.

stopContactRecording({required String contactId, required String initialContactId, required String instanceId, ContactRecordingType? contactRecordingType}) → Future<void>

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.

stopContactStreaming({required String contactId, required String instanceId, required String streamingId}) → Future<void>

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

stopTestCaseExecution({required String instanceId, required String testCaseExecutionId, required String testCaseId, String? clientToken}) → Future<void>

Stops a running test execution.

submitContactEvaluation({required String evaluationId, required String instanceId, Map<String, EvaluationAnswerInput>? answers, Map<String, EvaluationNote>? notes, EvaluatorUserUnion? submittedBy}) → Future<SubmitContactEvaluationResponse>

Submits a contact evaluation in the specified Connect Customer 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.

suspendContactRecording({required String contactId, required String initialContactId, required String instanceId, ContactRecordingType? contactRecordingType}) → Future<void>

When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call (IVR or agent), 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.

tagContact({required String contactId, required String instanceId, required Map<String, String> tags}) → Future<void>

Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Connect Customer usage.

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

transferContact({required String contactFlowId, required String contactId, required String instanceId, String? clientToken, String? queueId, String? userId}) → Future<TransferContactResponse>

Transfers TASK or EMAIL 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.

untagContact({required String contactId, required String instanceId, required List<String> tagKeys}) → Future<void>

Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Connect Customer usage.

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

Removes the specified tags from the specified resource.

updateAgentStatus({required String agentStatusId, required String instanceId, String? description, int? displayOrder, String? name, bool? resetOrderNumber, AgentStatusState? state}) → Future<void>

Updates agent status.

updateAttachedFilesConfiguration({required AttachmentScope attachmentScope, required String instanceId, ExtensionConfiguration? extensionConfiguration, int? maximumSizeLimitInBytes}) → Future<UpdateAttachedFilesConfigurationResponse>

Updates the attached files configuration for the specified Connect Customer instance and attachment scope.

updateAuthenticationProfile({required String authenticationProfileId, required String instanceId, List<String>? allowedIps, List<String>? blockedIps, String? description, String? name, int? periodicSessionDuration, int? sessionInactivityDuration, bool? sessionInactivityHandlingEnabled}) → Future<void>

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

updateContact({required String contactId, required String instanceId, Endpoint? customerEndpoint, String? description, String? name, QueueInfoInput? queueInfo, Map<String, Reference>? references, Map<String, SegmentAttributeValue>? segmentAttributes, Endpoint? systemEndpoint, UserInfo? userInfo}) → Future<void>

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

updateContactAttributes({required Map<String, String> attributes, required String initialContactId, required String instanceId}) → Future<void>

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

updateContactEvaluation({required String evaluationId, required String instanceId, Map<String, EvaluationAnswerInput>? answers, Map<String, EvaluationNote>? notes, EvaluatorUserUnion? updatedBy}) → Future<UpdateContactEvaluationResponse>

Updates details about a contact evaluation in the specified Connect Customer 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({required String contactFlowId, required String content, required String instanceId}) → Future<void>

Updates the specified flow.

updateContactFlowMetadata({required String contactFlowId, required String instanceId, ContactFlowState? contactFlowState, String? description, String? name}) → Future<void>

Updates metadata about specified flow.

updateContactFlowModuleAlias({required String aliasId, required String contactFlowModuleId, required String instanceId, int? contactFlowModuleVersion, String? description, String? name}) → Future<void>

Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.

updateContactFlowModuleContent({required String contactFlowModuleId, required String instanceId, String? content, String? settings}) → Future<void>

Updates specified flow module for the specified Connect Customer instance.

updateContactFlowModuleMetadata({required String contactFlowModuleId, required String instanceId, String? description, String? name, ContactFlowModuleState? state}) → Future<void>

Updates metadata about specified flow module.

updateContactFlowName({required String contactFlowId, required String instanceId, String? description, String? name}) → Future<void>

The name of the flow.

updateContactRoutingData({required String contactId, required String instanceId, int? queuePriority, int? queueTimeAdjustmentSeconds, RoutingCriteriaInput? routingCriteria}) → Future<void>

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.

updateContactSchedule({required String contactId, required String instanceId, required DateTime scheduledTime}) → Future<void>

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

updateDataTableAttribute({required String attributeName, required String dataTableId, required String instanceId, required String name, required DataTableAttributeValueType valueType, String? description, bool? primary, Validation? validation}) → Future<UpdateDataTableAttributeResponse>

Updates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute's validation does not invalidate existing values since validation only runs when values are created or updated.

updateDataTableMetadata({required String dataTableId, required String instanceId, required String name, required String timeZone, required DataTableLockLevel valueLockLevel, String? description}) → Future<UpdateDataTableMetadataResponse>

Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.

updateDataTablePrimaryValues({required String dataTableId, required String instanceId, required DataTableLockVersion lockVersion, required List<PrimaryValue> newPrimaryValues, required List<PrimaryValue> primaryValues}) → Future<UpdateDataTablePrimaryValuesResponse>

Updates the primary values for a record. This operation affects all existing values that are currently associated to the record and its primary values. Users that have restrictions on attributes and/or primary values are not authorized to use this endpoint. The combination of new primary values must be unique within the table.

updateEmailAddressMetadata({required String emailAddressId, required String instanceId, String? clientToken, String? description, String? displayName}) → Future<UpdateEmailAddressMetadataResponse>

Updates an email address metadata. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide.

updateEvaluationForm({required String evaluationFormId, required int evaluationFormVersion, required String instanceId, required List<EvaluationFormItem> items, required String title, bool? asDraft, EvaluationFormAutoEvaluationConfiguration? autoEvaluationConfiguration, String? clientToken, bool? createNewVersion, String? description, EvaluationFormLanguageConfiguration? languageConfiguration, EvaluationReviewConfiguration? reviewConfiguration, EvaluationFormScoringStrategy? scoringStrategy, EvaluationFormTargetConfiguration? targetConfiguration}) → Future<UpdateEvaluationFormResponse>

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

updateHoursOfOperation({required String hoursOfOperationId, required String instanceId, List<HoursOfOperationConfig>? config, String? description, String? name, String? timeZone}) → Future<void>

Updates the hours of operation.

updateHoursOfOperationOverride({required String hoursOfOperationId, required String hoursOfOperationOverrideId, required String instanceId, List<HoursOfOperationOverrideConfig>? config, String? description, String? effectiveFrom, String? effectiveTill, String? name, OverrideType? overrideType, RecurrenceConfig? recurrenceConfig}) → Future<void>

Update the hours of operation override.

updateInstanceAttribute({required InstanceAttributeType attributeType, required String instanceId, required String value, String? clientToken}) → Future<void>

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

updateInstanceStorageConfig({required String associationId, required String instanceId, required InstanceStorageResourceType resourceType, required InstanceStorageConfig storageConfig, String? clientToken}) → Future<void>

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

updateNotificationContent({required Map<LocaleCode, String> content, required String instanceId, required String notificationId}) → Future<void>

Updates the localized content of an existing notification. This operation applies to all users for whom the notification was sent.

updateParticipantAuthentication({required String instanceId, required String state, String? code, String? error, String? errorDescription}) → Future<void>

Instructs Connect Customer to resume the authentication process. The subsequent actions depend on the request body contents:

updateParticipantRoleConfig({required UpdateParticipantRoleConfigChannelInfo channelConfiguration, required String contactId, required String instanceId}) → Future<void>

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:

updatePhoneNumber({required String phoneNumberId, String? clientToken, String? instanceId, String? targetArn}) → Future<UpdatePhoneNumberResponse>

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

updatePhoneNumberMetadata({required String phoneNumberId, String? clientToken, String? phoneNumberDescription}) → Future<void>

Updates a phone number’s metadata.

updatePredefinedAttribute({required String instanceId, required String name, InputPredefinedAttributeConfiguration? attributeConfiguration, List<String>? purposes, PredefinedAttributeValues? values}) → Future<void>

Updates a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value.

updatePrompt({required String instanceId, required String promptId, String? description, String? name, String? s3Uri}) → Future<UpdatePromptResponse>

Updates a prompt.

updateQueueHoursOfOperation({required String hoursOfOperationId, required String instanceId, required String queueId}) → Future<void>

Updates the hours of operation for the specified queue.

updateQueueMaxContacts({required String instanceId, required String queueId, int? maxContacts}) → Future<void>

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

updateQueueName({required String instanceId, required String queueId, String? description, String? name}) → Future<void>

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

updateQueueOutboundCallerConfig({required String instanceId, required OutboundCallerConfig outboundCallerConfig, required String queueId}) → Future<void>

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

updateQueueOutboundEmailConfig({required String instanceId, required OutboundEmailConfig outboundEmailConfig, required String queueId}) → Future<void>

Updates the outbound email address Id for a specified queue.

updateQueueStatus({required String instanceId, required String queueId, required QueueStatus status}) → Future<void>

Updates the status of the queue.

updateQuickConnectConfig({required String instanceId, required QuickConnectConfig quickConnectConfig, required String quickConnectId}) → Future<void>

Updates the configuration settings for the specified quick connect.

updateQuickConnectName({required String instanceId, required String quickConnectId, String? description, String? name}) → Future<void>

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({required AgentAvailabilityTimer agentAvailabilityTimer, required String instanceId, required String routingProfileId}) → Future<void>

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({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 Name or Description must 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.

updateRule({required List<RuleAction> actions, required String function, required String instanceId, required String name, required RulePublishStatus publishStatus, required String ruleId}) → Future<void>

Updates a rule for the specified Connect Customer instance.

updateSecurityProfile({required String instanceId, required String securityProfileId, String? allowedAccessControlHierarchyGroupId, Map<String, String>? allowedAccessControlTags, List<FlowModule>? allowedFlowModules, List<Application>? applications, String? description, GranularAccessControlConfiguration? granularAccessControlConfiguration, List<String>? hierarchyRestrictedResources, List<String>? permissions, List<String>? tagRestrictedResources}) → Future<void>

Updates a security profile.

updateTaskTemplate({required String instanceId, required String taskTemplateId, TaskTemplateConstraints? constraints, String? contactFlowId, TaskTemplateDefaults? defaults, String? description, List<TaskTemplateField>? fields, String? name, String? selfAssignFlowId, TaskTemplateStatus? status}) → Future<UpdateTaskTemplateResponse>

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

updateTestCase({required String instanceId, required String testCaseId, String? content, String? description, TestCaseEntryPoint? entryPoint, String? initializationData, String? lastModifiedRegion, DateTime? lastModifiedTime, String? name, TestCaseStatus? status}) → Future<void>

Updates any of the metadata for a test case, such as the name, description, and status or content of an existing test case. This API doesn't allow customers to update the tags of the test case resource for the specified Amazon Connect instance.

updateTrafficDistribution({required String id, AgentConfig? agentConfig, SignInConfig? signInConfig, TelephonyConfig? telephonyConfig}) → Future<void>

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 Connect Customer Administrator Guide.

updateUserConfig({required String instanceId, required String userId, List<AfterContactWorkConfigPerChannel>? afterContactWorkConfigs, List<AutoAcceptConfig>? autoAcceptConfigs, List<PersistentConnectionConfig>? persistentConnectionConfigs, List<PhoneNumberConfig>? phoneNumberConfigs, List<VoiceEnhancementConfig>? voiceEnhancementConfigs}) → Future<void>

Updates the configuration settings for the specified user, including per-channel auto-accept and after contact work (ACW) timeout settings.

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.

updateUserNotificationStatus({required String instanceId, required String notificationId, required NotificationStatus status, required String userId, String? lastModifiedRegion, DateTime? lastModifiedTime}) → Future<void>

Updates the status of a notification for a specific user, such as marking it as read or hidden. Users can only update notification status for notifications that have been sent to them. READ status deprioritizes the notification and greys it out, while HIDDEN status removes it from the notification widget.

updateUserPhoneConfig({required String instanceId, required UserPhoneConfig phoneConfig, required String userId}) → Future<void>

Updates the phone configuration settings for the specified user.

updateUserProficiencies({required String instanceId, required String userId, required List<UserProficiency> userProficiencies}) → Future<void>

Updates the properties associated with the proficiencies of a 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.

updateViewContent({required ViewInputContent content, required String instanceId, required ViewStatus status, required String viewId}) → Future<UpdateViewContentResponse>

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

updateViewMetadata({required String instanceId, required String viewId, String? description, String? name}) → Future<void>

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

updateWorkspaceMetadata({required String instanceId, required String workspaceId, String? description, String? name, String? title}) → Future<void>

Updates the metadata of a workspace, such as its name and description.

updateWorkspacePage({required String instanceId, required String page, required String workspaceId, String? inputData, String? newPage, String? resourceArn, String? slug}) → Future<void>

Updates the configuration of a page in a workspace, including the associated view and input data.

updateWorkspaceTheme({required String instanceId, required String workspaceId, WorkspaceTheme? theme}) → Future<void>

Updates the theme configuration for a workspace, including colors and styling.

updateWorkspaceVisibility({required String instanceId, required Visibility visibility, required String workspaceId}) → Future<void>

Updates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none.

Operators

operator ==(Object other) → bool

The equality operator.

inherited