@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonConnect
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonConnect instead.
Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
ActivateEvaluationFormResult |
activateEvaluationForm(ActivateEvaluationFormRequest activateEvaluationFormRequest)
Activates an evaluation form in the specified Amazon Connect instance.
|
AssociateAnalyticsDataSetResult |
associateAnalyticsDataSet(AssociateAnalyticsDataSetRequest associateAnalyticsDataSetRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateApprovedOriginResult |
associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateBotResult |
associateBot(AssociateBotRequest associateBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateDefaultVocabularyResult |
associateDefaultVocabulary(AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest)
Associates an existing vocabulary as the default.
|
AssociateFlowResult |
associateFlow(AssociateFlowRequest associateFlowRequest)
Associates a connect resource to a flow.
|
AssociateInstanceStorageConfigResult |
associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateLambdaFunctionResult |
associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateLexBotResult |
associateLexBot(AssociateLexBotRequest associateLexBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociatePhoneNumberContactFlowResult |
associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest associatePhoneNumberContactFlowRequest)
Associates a flow with a phone number claimed to your Amazon Connect instance.
|
AssociateQueueQuickConnectsResult |
associateQueueQuickConnects(AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateRoutingProfileQueuesResult |
associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest)
Associates a set of queues with a routing profile.
|
AssociateSecurityKeyResult |
associateSecurityKey(AssociateSecurityKeyRequest associateSecurityKeyRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateTrafficDistributionGroupUserResult |
associateTrafficDistributionGroupUser(AssociateTrafficDistributionGroupUserRequest associateTrafficDistributionGroupUserRequest)
Associates an agent with a traffic distribution group.
|
AssociateUserProficienciesResult |
associateUserProficiencies(AssociateUserProficienciesRequest associateUserProficienciesRequest)
>Associates a set of proficiencies with a user.
|
BatchAssociateAnalyticsDataSetResult |
batchAssociateAnalyticsDataSet(BatchAssociateAnalyticsDataSetRequest batchAssociateAnalyticsDataSetRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
BatchDisassociateAnalyticsDataSetResult |
batchDisassociateAnalyticsDataSet(BatchDisassociateAnalyticsDataSetRequest batchDisassociateAnalyticsDataSetRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
BatchGetAttachedFileMetadataResult |
batchGetAttachedFileMetadata(BatchGetAttachedFileMetadataRequest batchGetAttachedFileMetadataRequest)
Allows you to retrieve metadata about multiple attached files on an associated resource.
|
BatchGetFlowAssociationResult |
batchGetFlowAssociation(BatchGetFlowAssociationRequest batchGetFlowAssociationRequest)
Retrieve the flow associations for the given resources.
|
BatchPutContactResult |
batchPutContact(BatchPutContactRequest batchPutContactRequest)
|
ClaimPhoneNumberResult |
claimPhoneNumber(ClaimPhoneNumberRequest claimPhoneNumberRequest)
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
|
CompleteAttachedFileUploadResult |
completeAttachedFileUpload(CompleteAttachedFileUploadRequest completeAttachedFileUploadRequest)
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the
StartAttachedFileUpload API.
|
CreateAgentStatusResult |
createAgentStatus(CreateAgentStatusRequest createAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateContactFlowResult |
createContactFlow(CreateContactFlowRequest createContactFlowRequest)
Creates a flow for the specified Amazon Connect instance.
|
CreateContactFlowModuleResult |
createContactFlowModule(CreateContactFlowModuleRequest createContactFlowModuleRequest)
Creates a flow module for the specified Amazon Connect instance.
|
CreateEvaluationFormResult |
createEvaluationForm(CreateEvaluationFormRequest createEvaluationFormRequest)
Creates an evaluation form in the specified Amazon Connect instance.
|
CreateHoursOfOperationResult |
createHoursOfOperation(CreateHoursOfOperationRequest createHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateInstanceResult |
createInstance(CreateInstanceRequest createInstanceRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateIntegrationAssociationResult |
createIntegrationAssociation(CreateIntegrationAssociationRequest createIntegrationAssociationRequest)
Creates an Amazon Web Services resource association with an Amazon Connect instance.
|
CreateParticipantResult |
createParticipant(CreateParticipantRequest createParticipantRequest)
Adds a new participant into an on-going chat contact.
|
CreatePersistentContactAssociationResult |
createPersistentContactAssociation(CreatePersistentContactAssociationRequest createPersistentContactAssociationRequest)
Enables rehydration of chats for the lifespan of a contact.
|
CreatePredefinedAttributeResult |
createPredefinedAttribute(CreatePredefinedAttributeRequest createPredefinedAttributeRequest)
Creates a new predefined attribute for the specified Amazon Connect instance.
|
CreatePromptResult |
createPrompt(CreatePromptRequest createPromptRequest)
Creates a prompt.
|
CreateQueueResult |
createQueue(CreateQueueRequest createQueueRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateQuickConnectResult |
createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest)
Creates a quick connect for the specified Amazon Connect instance.
|
CreateRoutingProfileResult |
createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest)
Creates a new routing profile.
|
CreateRuleResult |
createRule(CreateRuleRequest createRuleRequest)
Creates a rule for the specified Amazon Connect instance.
|
CreateSecurityProfileResult |
createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest)
Creates a security profile.
|
CreateTaskTemplateResult |
createTaskTemplate(CreateTaskTemplateRequest createTaskTemplateRequest)
Creates a new task template in the specified Amazon Connect instance.
|
CreateTrafficDistributionGroupResult |
createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest createTrafficDistributionGroupRequest)
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
|
CreateUseCaseResult |
createUseCase(CreateUseCaseRequest createUseCaseRequest)
Creates a use case for an integration association.
|
CreateUserResult |
createUser(CreateUserRequest createUserRequest)
Creates a user account for the specified Amazon Connect instance.
|
CreateUserHierarchyGroupResult |
createUserHierarchyGroup(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest)
Creates a new user hierarchy group.
|
CreateViewResult |
createView(CreateViewRequest createViewRequest)
Creates a new view with the possible status of
SAVED or PUBLISHED. |
CreateViewVersionResult |
createViewVersion(CreateViewVersionRequest createViewVersionRequest)
Publishes a new version of the view identifier.
|
CreateVocabularyResult |
createVocabulary(CreateVocabularyRequest createVocabularyRequest)
Creates a custom vocabulary associated with your Amazon Connect instance.
|
DeactivateEvaluationFormResult |
deactivateEvaluationForm(DeactivateEvaluationFormRequest deactivateEvaluationFormRequest)
Deactivates an evaluation form in the specified Amazon Connect instance.
|
DeleteAttachedFileResult |
deleteAttachedFile(DeleteAttachedFileRequest deleteAttachedFileRequest)
Deletes an attached file along with the underlying S3 Object.
|
DeleteContactEvaluationResult |
deleteContactEvaluation(DeleteContactEvaluationRequest deleteContactEvaluationRequest)
Deletes a contact evaluation in the specified Amazon Connect instance.
|
DeleteContactFlowResult |
deleteContactFlow(DeleteContactFlowRequest deleteContactFlowRequest)
Deletes a flow for the specified Amazon Connect instance.
|
DeleteContactFlowModuleResult |
deleteContactFlowModule(DeleteContactFlowModuleRequest deleteContactFlowModuleRequest)
Deletes the specified flow module.
|
DeleteEvaluationFormResult |
deleteEvaluationForm(DeleteEvaluationFormRequest deleteEvaluationFormRequest)
Deletes an evaluation form in the specified Amazon Connect instance.
|
DeleteHoursOfOperationResult |
deleteHoursOfOperation(DeleteHoursOfOperationRequest deleteHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DeleteIntegrationAssociationResult |
deleteIntegrationAssociation(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest)
Deletes an Amazon Web Services resource association from an Amazon Connect instance.
|
DeletePredefinedAttributeResult |
deletePredefinedAttribute(DeletePredefinedAttributeRequest deletePredefinedAttributeRequest)
Deletes a predefined attribute from the specified Amazon Connect instance.
|
DeletePromptResult |
deletePrompt(DeletePromptRequest deletePromptRequest)
Deletes a prompt.
|
DeleteQueueResult |
deleteQueue(DeleteQueueRequest deleteQueueRequest)
Deletes a queue.
|
DeleteQuickConnectResult |
deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest)
Deletes a quick connect.
|
DeleteRoutingProfileResult |
deleteRoutingProfile(DeleteRoutingProfileRequest deleteRoutingProfileRequest)
Deletes a routing profile.
|
DeleteRuleResult |
deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes a rule for the specified Amazon Connect instance.
|
DeleteSecurityProfileResult |
deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
Deletes a security profile.
|
DeleteTaskTemplateResult |
deleteTaskTemplate(DeleteTaskTemplateRequest deleteTaskTemplateRequest)
Deletes the task template.
|
DeleteTrafficDistributionGroupResult |
deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest deleteTrafficDistributionGroupRequest)
Deletes a traffic distribution group.
|
DeleteUseCaseResult |
deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest)
Deletes a use case from an integration association.
|
DeleteUserResult |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user account from the specified Amazon Connect instance.
|
DeleteUserHierarchyGroupResult |
deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest)
Deletes an existing user hierarchy group.
|
DeleteViewResult |
deleteView(DeleteViewRequest deleteViewRequest)
Deletes the view entirely.
|
DeleteViewVersionResult |
deleteViewVersion(DeleteViewVersionRequest deleteViewVersionRequest)
Deletes the particular version specified in
ViewVersion identifier. |
DeleteVocabularyResult |
deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)
Deletes the vocabulary that has the given identifier.
|
DescribeAgentStatusResult |
describeAgentStatus(DescribeAgentStatusRequest describeAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeAuthenticationProfileResult |
describeAuthenticationProfile(DescribeAuthenticationProfileRequest describeAuthenticationProfileRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeContactResult |
describeContact(DescribeContactRequest describeContactRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeContactEvaluationResult |
describeContactEvaluation(DescribeContactEvaluationRequest describeContactEvaluationRequest)
Describes a contact evaluation in the specified Amazon Connect instance.
|
DescribeContactFlowResult |
describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest)
Describes the specified flow.
|
DescribeContactFlowModuleResult |
describeContactFlowModule(DescribeContactFlowModuleRequest describeContactFlowModuleRequest)
Describes the specified flow module.
|
DescribeEvaluationFormResult |
describeEvaluationForm(DescribeEvaluationFormRequest describeEvaluationFormRequest)
Describes an evaluation form in the specified Amazon Connect instance.
|
DescribeHoursOfOperationResult |
describeHoursOfOperation(DescribeHoursOfOperationRequest describeHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeInstanceResult |
describeInstance(DescribeInstanceRequest describeInstanceRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeInstanceAttributeResult |
describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeInstanceStorageConfigResult |
describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribePhoneNumberResult |
describePhoneNumber(DescribePhoneNumberRequest describePhoneNumberRequest)
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution
group.
|
DescribePredefinedAttributeResult |
describePredefinedAttribute(DescribePredefinedAttributeRequest describePredefinedAttributeRequest)
Describes a predefined attribute for the specified Amazon Connect instance.
|
DescribePromptResult |
describePrompt(DescribePromptRequest describePromptRequest)
Describes the prompt.
|
DescribeQueueResult |
describeQueue(DescribeQueueRequest describeQueueRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeQuickConnectResult |
describeQuickConnect(DescribeQuickConnectRequest describeQuickConnectRequest)
Describes the quick connect.
|
DescribeRoutingProfileResult |
describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest)
Describes the specified routing profile.
|
DescribeRuleResult |
describeRule(DescribeRuleRequest describeRuleRequest)
Describes a rule for the specified Amazon Connect instance.
|
DescribeSecurityProfileResult |
describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest)
Gets basic information about the security profle.
|
DescribeTrafficDistributionGroupResult |
describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest)
Gets details and status of a traffic distribution group.
|
DescribeUserResult |
describeUser(DescribeUserRequest describeUserRequest)
Describes the specified user.
|
DescribeUserHierarchyGroupResult |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Describes the specified hierarchy group.
|
DescribeUserHierarchyStructureResult |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Describes the hierarchy structure of the specified Amazon Connect instance.
|
DescribeViewResult |
describeView(DescribeViewRequest describeViewRequest)
Retrieves the view for the specified Amazon Connect instance and view identifier.
|
DescribeVocabularyResult |
describeVocabulary(DescribeVocabularyRequest describeVocabularyRequest)
Describes the specified vocabulary.
|
DisassociateAnalyticsDataSetResult |
disassociateAnalyticsDataSet(DisassociateAnalyticsDataSetRequest disassociateAnalyticsDataSetRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateApprovedOriginResult |
disassociateApprovedOrigin(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateBotResult |
disassociateBot(DisassociateBotRequest disassociateBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateFlowResult |
disassociateFlow(DisassociateFlowRequest disassociateFlowRequest)
Disassociates a connect resource from a flow.
|
DisassociateInstanceStorageConfigResult |
disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateLambdaFunctionResult |
disassociateLambdaFunction(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateLexBotResult |
disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociatePhoneNumberContactFlowResult |
disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest disassociatePhoneNumberContactFlowRequest)
Removes the flow association from a phone number claimed to your Amazon Connect instance.
|
DisassociateQueueQuickConnectsResult |
disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateRoutingProfileQueuesResult |
disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest)
Disassociates a set of queues from a routing profile.
|
DisassociateSecurityKeyResult |
disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateTrafficDistributionGroupUserResult |
disassociateTrafficDistributionGroupUser(DisassociateTrafficDistributionGroupUserRequest disassociateTrafficDistributionGroupUserRequest)
Disassociates an agent from a traffic distribution group.
|
DisassociateUserProficienciesResult |
disassociateUserProficiencies(DisassociateUserProficienciesRequest disassociateUserProficienciesRequest)
Disassociates a set of proficiencies from a user.
|
DismissUserContactResult |
dismissUserContact(DismissUserContactRequest dismissUserContactRequest)
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.
|
GetAttachedFileResult |
getAttachedFile(GetAttachedFileRequest getAttachedFileRequest)
Provides a pre-signed URL for download of an approved attached file.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetContactAttributesResult |
getContactAttributes(GetContactAttributesRequest getContactAttributesRequest)
Retrieves the contact attributes for the specified contact.
|
GetCurrentMetricDataResult |
getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
Gets the real-time metric data from the specified Amazon Connect instance.
|
GetCurrentUserDataResult |
getCurrentUserData(GetCurrentUserDataRequest getCurrentUserDataRequest)
Gets the real-time active user data from the specified Amazon Connect instance.
|
GetFederationTokenResult |
getFederationToken(GetFederationTokenRequest getFederationTokenRequest)
Supports SAML sign-in for Amazon Connect.
|
GetFlowAssociationResult |
getFlowAssociation(GetFlowAssociationRequest getFlowAssociationRequest)
Retrieves the flow associated for a given resource.
|
GetMetricDataResult |
getMetricData(GetMetricDataRequest getMetricDataRequest)
Gets historical metric data from the specified Amazon Connect instance.
|
GetMetricDataV2Result |
getMetricDataV2(GetMetricDataV2Request getMetricDataV2Request)
Gets metric data from the specified Amazon Connect instance.
|
GetPromptFileResult |
getPromptFile(GetPromptFileRequest getPromptFileRequest)
Gets the prompt file.
|
GetTaskTemplateResult |
getTaskTemplate(GetTaskTemplateRequest getTaskTemplateRequest)
Gets details about a specific task template in the specified Amazon Connect instance.
|
GetTrafficDistributionResult |
getTrafficDistribution(GetTrafficDistributionRequest getTrafficDistributionRequest)
Retrieves the current traffic distribution for a given traffic distribution group.
|
ImportPhoneNumberResult |
importPhoneNumber(ImportPhoneNumberRequest importPhoneNumberRequest)
Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect
instance.
|
ListAgentStatusesResult |
listAgentStatuses(ListAgentStatusesRequest listAgentStatusesRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListAnalyticsDataAssociationsResult |
listAnalyticsDataAssociations(ListAnalyticsDataAssociationsRequest listAnalyticsDataAssociationsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListApprovedOriginsResult |
listApprovedOrigins(ListApprovedOriginsRequest listApprovedOriginsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListAuthenticationProfilesResult |
listAuthenticationProfiles(ListAuthenticationProfilesRequest listAuthenticationProfilesRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListBotsResult |
listBots(ListBotsRequest listBotsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListContactEvaluationsResult |
listContactEvaluations(ListContactEvaluationsRequest listContactEvaluationsRequest)
Lists contact evaluations in the specified Amazon Connect instance.
|
ListContactFlowModulesResult |
listContactFlowModules(ListContactFlowModulesRequest listContactFlowModulesRequest)
Provides information about the flow modules for the specified Amazon Connect instance.
|
ListContactFlowsResult |
listContactFlows(ListContactFlowsRequest listContactFlowsRequest)
Provides information about the flows for the specified Amazon Connect instance.
|
ListContactReferencesResult |
listContactReferences(ListContactReferencesRequest listContactReferencesRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListDefaultVocabulariesResult |
listDefaultVocabularies(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest)
Lists the default vocabularies for the specified Amazon Connect instance.
|
ListEvaluationFormsResult |
listEvaluationForms(ListEvaluationFormsRequest listEvaluationFormsRequest)
Lists evaluation forms in the specified Amazon Connect instance.
|
ListEvaluationFormVersionsResult |
listEvaluationFormVersions(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest)
Lists versions of an evaluation form in the specified Amazon Connect instance.
|
ListFlowAssociationsResult |
listFlowAssociations(ListFlowAssociationsRequest listFlowAssociationsRequest)
List the flow association based on the filters.
|
ListHoursOfOperationsResult |
listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest)
Provides information about the hours of operation for the specified Amazon Connect instance.
|
ListInstanceAttributesResult |
listInstanceAttributes(ListInstanceAttributesRequest listInstanceAttributesRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListInstancesResult |
listInstances(ListInstancesRequest listInstancesRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListInstanceStorageConfigsResult |
listInstanceStorageConfigs(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListIntegrationAssociationsResult |
listIntegrationAssociations(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest)
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect
instance.
|
ListLambdaFunctionsResult |
listLambdaFunctions(ListLambdaFunctionsRequest listLambdaFunctionsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListLexBotsResult |
listLexBots(ListLexBotsRequest listLexBotsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListPhoneNumbersResult |
listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)
Provides information about the phone numbers for the specified Amazon Connect instance.
|
ListPhoneNumbersV2Result |
listPhoneNumbersV2(ListPhoneNumbersV2Request listPhoneNumbersV2Request)
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
|
ListPredefinedAttributesResult |
listPredefinedAttributes(ListPredefinedAttributesRequest listPredefinedAttributesRequest)
Lists predefined attributes for the specified Amazon Connect instance.
|
ListPromptsResult |
listPrompts(ListPromptsRequest listPromptsRequest)
Provides information about the prompts for the specified Amazon Connect instance.
|
ListQueueQuickConnectsResult |
listQueueQuickConnects(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListQueuesResult |
listQueues(ListQueuesRequest listQueuesRequest)
Provides information about the queues for the specified Amazon Connect instance.
|
ListQuickConnectsResult |
listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest)
Provides information about the quick connects for the specified Amazon Connect instance.
|
ListRealtimeContactAnalysisSegmentsV2Result |
listRealtimeContactAnalysisSegmentsV2(ListRealtimeContactAnalysisSegmentsV2Request listRealtimeContactAnalysisSegmentsV2Request)
Provides a list of analysis segments for a real-time analysis session.
|
ListRoutingProfileQueuesResult |
listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest)
Lists the queues associated with a routing profile.
|
ListRoutingProfilesResult |
listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)
Provides summary information about the routing profiles for the specified Amazon Connect instance.
|
ListRulesResult |
listRules(ListRulesRequest listRulesRequest)
List all rules for the specified Amazon Connect instance.
|
ListSecurityKeysResult |
listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListSecurityProfileApplicationsResult |
listSecurityProfileApplications(ListSecurityProfileApplicationsRequest listSecurityProfileApplicationsRequest)
Returns a list of third-party applications in a specific security profile.
|
ListSecurityProfilePermissionsResult |
listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest)
Lists the permissions granted to a security profile.
|
ListSecurityProfilesResult |
listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest)
Provides summary information about the security profiles for the specified Amazon Connect instance.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
|
ListTaskTemplatesResult |
listTaskTemplates(ListTaskTemplatesRequest listTaskTemplatesRequest)
Lists task templates for the specified Amazon Connect instance.
|
ListTrafficDistributionGroupsResult |
listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest)
Lists traffic distribution groups.
|
ListTrafficDistributionGroupUsersResult |
listTrafficDistributionGroupUsers(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest)
Lists traffic distribution group users.
|
ListUseCasesResult |
listUseCases(ListUseCasesRequest listUseCasesRequest)
Lists the use cases for the integration association.
|
ListUserHierarchyGroupsResult |
listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
|
ListUserProficienciesResult |
listUserProficiencies(ListUserProficienciesRequest listUserProficienciesRequest)
Lists proficiencies associated with a user.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Provides summary information about the users for the specified Amazon Connect instance.
|
ListViewsResult |
listViews(ListViewsRequest listViewsRequest)
Returns views in the given instance.
|
ListViewVersionsResult |
listViewVersions(ListViewVersionsRequest listViewVersionsRequest)
Returns all the available versions for the specified Amazon Connect instance and view identifier.
|
MonitorContactResult |
monitorContact(MonitorContactRequest monitorContactRequest)
Initiates silent monitoring of a contact.
|
PauseContactResult |
pauseContact(PauseContactRequest pauseContactRequest)
Allows pausing an ongoing task contact.
|
PutUserStatusResult |
putUserStatus(PutUserStatusRequest putUserStatusRequest)
Changes the current status of a user or agent in Amazon Connect.
|
ReleasePhoneNumberResult |
releasePhoneNumber(ReleasePhoneNumberRequest releasePhoneNumberRequest)
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
|
ReplicateInstanceResult |
replicateInstance(ReplicateInstanceRequest replicateInstanceRequest)
Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration
information for Amazon Connect resources across Amazon Web Services Regions.
|
ResumeContactResult |
resumeContact(ResumeContactRequest resumeContactRequest)
Allows resuming a task contact in a paused state.
|
ResumeContactRecordingResult |
resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest)
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.
|
SearchAgentStatusesResult |
searchAgentStatuses(SearchAgentStatusesRequest searchAgentStatusesRequest)
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
|
SearchAvailablePhoneNumbersResult |
searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
group.
|
SearchContactFlowModulesResult |
searchContactFlowModules(SearchContactFlowModulesRequest searchContactFlowModulesRequest)
Searches the flow modules in an Amazon Connect instance, with optional filtering.
|
SearchContactFlowsResult |
searchContactFlows(SearchContactFlowsRequest searchContactFlowsRequest)
Searches the contact flows in an Amazon Connect instance, with optional filtering.
|
SearchContactsResult |
searchContacts(SearchContactsRequest searchContactsRequest)
Searches contacts in an Amazon Connect instance.
|
SearchHoursOfOperationsResult |
searchHoursOfOperations(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest)
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
|
SearchPredefinedAttributesResult |
searchPredefinedAttributes(SearchPredefinedAttributesRequest searchPredefinedAttributesRequest)
Predefined attributes that meet certain criteria.
|
SearchPromptsResult |
searchPrompts(SearchPromptsRequest searchPromptsRequest)
Searches prompts in an Amazon Connect instance, with optional filtering.
|
SearchQueuesResult |
searchQueues(SearchQueuesRequest searchQueuesRequest)
Searches queues in an Amazon Connect instance, with optional filtering.
|
SearchQuickConnectsResult |
searchQuickConnects(SearchQuickConnectsRequest searchQuickConnectsRequest)
Searches quick connects in an Amazon Connect instance, with optional filtering.
|
SearchResourceTagsResult |
searchResourceTags(SearchResourceTagsRequest searchResourceTagsRequest)
Searches tags used in an Amazon Connect instance using optional search criteria.
|
SearchRoutingProfilesResult |
searchRoutingProfiles(SearchRoutingProfilesRequest searchRoutingProfilesRequest)
Searches routing profiles in an Amazon Connect instance, with optional filtering.
|
SearchSecurityProfilesResult |
searchSecurityProfiles(SearchSecurityProfilesRequest searchSecurityProfilesRequest)
Searches security profiles in an Amazon Connect instance, with optional filtering.
|
SearchUserHierarchyGroupsResult |
searchUserHierarchyGroups(SearchUserHierarchyGroupsRequest searchUserHierarchyGroupsRequest)
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
|
SearchUsersResult |
searchUsers(SearchUsersRequest searchUsersRequest)
Searches users in an Amazon Connect instance, with optional filtering.
|
SearchVocabulariesResult |
searchVocabularies(SearchVocabulariesRequest searchVocabulariesRequest)
Searches for vocabularies within a specific Amazon Connect instance using
State,
NameStartsWith, and LanguageCode. |
SendChatIntegrationEventResult |
sendChatIntegrationEvent(SendChatIntegrationEventRequest sendChatIntegrationEventRequest)
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartAttachedFileUploadResult |
startAttachedFileUpload(StartAttachedFileUploadRequest startAttachedFileUploadRequest)
Provides a pre-signed Amazon S3 URL in response for uploading your content.
|
StartChatContactResult |
startChatContact(StartChatContactRequest startChatContactRequest)
Initiates a flow to start a new chat for the customer.
|
StartContactEvaluationResult |
startContactEvaluation(StartContactEvaluationRequest startContactEvaluationRequest)
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the
particular contact.
|
StartContactRecordingResult |
startContactRecording(StartContactRecordingRequest startContactRecordingRequest)
Starts recording the contact:
|
StartContactStreamingResult |
startContactStreaming(StartContactStreamingRequest startContactStreamingRequest)
Initiates real-time message streaming for a new chat contact.
|
StartOutboundVoiceContactResult |
startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)
Places an outbound call to a contact, and then initiates the flow.
|
StartTaskContactResult |
startTaskContact(StartTaskContactRequest startTaskContactRequest)
Initiates a flow to start a new task contact.
|
StartWebRTCContactResult |
startWebRTCContact(StartWebRTCContactRequest startWebRTCContactRequest)
Places an inbound in-app, web, or video call to a contact, and then initiates the flow.
|
StopContactResult |
stopContact(StopContactRequest stopContactRequest)
Ends the specified contact.
|
StopContactRecordingResult |
stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest)
Stops recording a call when a contact is being recorded.
|
StopContactStreamingResult |
stopContactStreaming(StopContactStreamingRequest stopContactStreamingRequest)
Ends message streaming on a specified contact.
|
SubmitContactEvaluationResult |
submitContactEvaluation(SubmitContactEvaluationRequest submitContactEvaluationRequest)
Submits a contact evaluation in the specified Amazon Connect instance.
|
SuspendContactRecordingResult |
suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest)
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration:
call, screen, or both.
|
TagContactResult |
tagContact(TagContactRequest tagContactRequest)
Adds the specified tags to the contact resource.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
|
TransferContactResult |
transferContact(TransferContactRequest transferContactRequest)
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
|
UntagContactResult |
untagContact(UntagContactRequest untagContactRequest)
Removes the specified tags from the contact resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource.
|
UpdateAgentStatusResult |
updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateAuthenticationProfileResult |
updateAuthenticationProfile(UpdateAuthenticationProfileRequest updateAuthenticationProfileRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateContactResult |
updateContact(UpdateContactRequest updateContactRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateContactAttributesResult |
updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest)
Creates or updates user-defined contact attributes associated with the specified contact.
|
UpdateContactEvaluationResult |
updateContactEvaluation(UpdateContactEvaluationRequest updateContactEvaluationRequest)
Updates details about a contact evaluation in the specified Amazon Connect instance.
|
UpdateContactFlowContentResult |
updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest)
Updates the specified flow.
|
UpdateContactFlowMetadataResult |
updateContactFlowMetadata(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest)
Updates metadata about specified flow.
|
UpdateContactFlowModuleContentResult |
updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest)
Updates specified flow module for the specified Amazon Connect instance.
|
UpdateContactFlowModuleMetadataResult |
updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest)
Updates metadata about specified flow module.
|
UpdateContactFlowNameResult |
updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest)
The name of the flow.
|
UpdateContactRoutingDataResult |
updateContactRoutingData(UpdateContactRoutingDataRequest updateContactRoutingDataRequest)
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds).
|
UpdateContactScheduleResult |
updateContactSchedule(UpdateContactScheduleRequest updateContactScheduleRequest)
Updates the scheduled time of a task contact that is already scheduled.
|
UpdateEvaluationFormResult |
updateEvaluationForm(UpdateEvaluationFormRequest updateEvaluationFormRequest)
Updates details about a specific evaluation form version in the specified Amazon Connect instance.
|
UpdateHoursOfOperationResult |
updateHoursOfOperation(UpdateHoursOfOperationRequest updateHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateInstanceAttributeResult |
updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateInstanceStorageConfigResult |
updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateParticipantRoleConfigResult |
updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest updateParticipantRoleConfigRequest)
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically
disconnected from a chat due to idleness.
|
UpdatePhoneNumberResult |
updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to
another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
|
UpdatePhoneNumberMetadataResult |
updatePhoneNumberMetadata(UpdatePhoneNumberMetadataRequest updatePhoneNumberMetadataRequest)
Updates a phone number’s metadata.
|
UpdatePredefinedAttributeResult |
updatePredefinedAttribute(UpdatePredefinedAttributeRequest updatePredefinedAttributeRequest)
Updates a predefined attribute for the specified Amazon Connect instance.
|
UpdatePromptResult |
updatePrompt(UpdatePromptRequest updatePromptRequest)
Updates a prompt.
|
UpdateQueueHoursOfOperationResult |
updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest updateQueueHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueMaxContactsResult |
updateQueueMaxContacts(UpdateQueueMaxContactsRequest updateQueueMaxContactsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueNameResult |
updateQueueName(UpdateQueueNameRequest updateQueueNameRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueOutboundCallerConfigResult |
updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest updateQueueOutboundCallerConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueStatusResult |
updateQueueStatus(UpdateQueueStatusRequest updateQueueStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQuickConnectConfigResult |
updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest)
Updates the configuration settings for the specified quick connect.
|
UpdateQuickConnectNameResult |
updateQuickConnectName(UpdateQuickConnectNameRequest updateQuickConnectNameRequest)
Updates the name and description of a quick connect.
|
UpdateRoutingProfileAgentAvailabilityTimerResult |
updateRoutingProfileAgentAvailabilityTimer(UpdateRoutingProfileAgentAvailabilityTimerRequest updateRoutingProfileAgentAvailabilityTimerRequest)
Whether agents with this routing profile will have their routing order calculated based on time since their
last inbound contact or longest idle time.
|
UpdateRoutingProfileConcurrencyResult |
updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest)
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
|
UpdateRoutingProfileDefaultOutboundQueueResult |
updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest)
Updates the default outbound queue of a routing profile.
|
UpdateRoutingProfileNameResult |
updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest)
Updates the name and description of a routing profile.
|
UpdateRoutingProfileQueuesResult |
updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest)
Updates the properties associated with a set of queues for a routing profile.
|
UpdateRuleResult |
updateRule(UpdateRuleRequest updateRuleRequest)
Updates a rule for the specified Amazon Connect instance.
|
UpdateSecurityProfileResult |
updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest)
Updates a security profile.
|
UpdateTaskTemplateResult |
updateTaskTemplate(UpdateTaskTemplateRequest updateTaskTemplateRequest)
Updates details about a specific task template in the specified Amazon Connect instance.
|
UpdateTrafficDistributionResult |
updateTrafficDistribution(UpdateTrafficDistributionRequest updateTrafficDistributionRequest)
Updates the traffic distribution for a given traffic distribution group.
|
UpdateUserHierarchyResult |
updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the specified user.
|
UpdateUserHierarchyGroupNameResult |
updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest)
Updates the name of the user hierarchy group.
|
UpdateUserHierarchyStructureResult |
updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest)
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
|
UpdateUserIdentityInfoResult |
updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user.
|
UpdateUserPhoneConfigResult |
updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings for the specified user.
|
UpdateUserProficienciesResult |
updateUserProficiencies(UpdateUserProficienciesRequest updateUserProficienciesRequest)
Updates the properties associated with the proficiencies of a user.
|
UpdateUserRoutingProfileResult |
updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to the specified user.
|
UpdateUserSecurityProfilesResult |
updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Assigns the specified security profiles to the specified user.
|
UpdateViewContentResult |
updateViewContent(UpdateViewContentRequest updateViewContentRequest)
Updates the view content of the given view identifier in the specified Amazon Connect instance.
|
UpdateViewMetadataResult |
updateViewMetadata(UpdateViewMetadataRequest updateViewMetadataRequest)
Updates the view metadata.
|
static final String ENDPOINT_PREFIX
ActivateEvaluationFormResult activateEvaluationForm(ActivateEvaluationFormRequest activateEvaluationFormRequest)
Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
activateEvaluationFormRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceConflictException - A resource already has that name.AssociateAnalyticsDataSetResult associateAnalyticsDataSet(AssociateAnalyticsDataSetRequest associateAnalyticsDataSetRequest)
This API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
associateAnalyticsDataSetRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.AssociateApprovedOriginResult associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest)
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
associateApprovedOriginRequest - ResourceNotFoundException - The specified resource was not found.ResourceConflictException - A resource already has that name.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ServiceQuotaExceededException - The service quota has been exceeded.ThrottlingException - The throttling limit has been exceeded.AssociateBotResult associateBot(AssociateBotRequest associateBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
associateBotRequest - ResourceNotFoundException - The specified resource was not found.ResourceConflictException - A resource already has that name.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.LimitExceededException - The allowed limit for the resource has been exceeded.ServiceQuotaExceededException - The service quota has been exceeded.ThrottlingException - The throttling limit has been exceeded.AssociateDefaultVocabularyResult associateDefaultVocabulary(AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest)
Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
associateDefaultVocabularyRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.AssociateFlowResult associateFlow(AssociateFlowRequest associateFlowRequest)
Associates a connect resource to a flow.
associateFlowRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.AssociateInstanceStorageConfigResult associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
associateInstanceStorageConfigRequest - ResourceNotFoundException - The specified resource was not found.ResourceConflictException - A resource already has that name.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.AssociateLambdaFunctionResult associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest)
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
associateLambdaFunctionRequest - ResourceNotFoundException - The specified resource was not found.ResourceConflictException - A resource already has that name.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ServiceQuotaExceededException - The service quota has been exceeded.ThrottlingException - The throttling limit has been exceeded.AssociateLexBotResult associateLexBot(AssociateLexBotRequest associateLexBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
associateLexBotRequest - ResourceNotFoundException - The specified resource was not found.ResourceConflictException - A resource already has that name.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ServiceQuotaExceededException - The service quota has been exceeded.ThrottlingException - The throttling limit has been exceeded.AssociatePhoneNumberContactFlowResult associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest associatePhoneNumberContactFlowRequest)
Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the
Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone
number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is
claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon
Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If
a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
associatePhoneNumberContactFlowRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.AccessDeniedException - You do not have sufficient permissions to perform this action.AssociateQueueQuickConnectsResult associateQueueQuickConnects(AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
associateQueueQuickConnectsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The allowed limit for the resource has been exceeded.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.AssociateRoutingProfileQueuesResult associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest)
Associates a set of queues with a routing profile.
associateRoutingProfileQueuesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.AssociateSecurityKeyResult associateSecurityKey(AssociateSecurityKeyRequest associateSecurityKeyRequest)
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKeyRequest - ResourceNotFoundException - The specified resource was not found.ResourceConflictException - A resource already has that name.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ServiceQuotaExceededException - The service quota has been exceeded.ThrottlingException - The throttling limit has been exceeded.AssociateTrafficDistributionGroupUserResult associateTrafficDistributionGroupUser(AssociateTrafficDistributionGroupUserRequest associateTrafficDistributionGroupUserRequest)
Associates an agent with a traffic distribution group.
associateTrafficDistributionGroupUserRequest - InvalidRequestException - The request is not valid.AccessDeniedException - You do not have sufficient permissions to perform this action.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.ResourceConflictException - A resource already has that name.InternalServiceException - Request processing failed because of an error or failure with the service.AssociateUserProficienciesResult associateUserProficiencies(AssociateUserProficienciesRequest associateUserProficienciesRequest)
>Associates a set of proficiencies with a user.
associateUserProficienciesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.BatchAssociateAnalyticsDataSetResult batchAssociateAnalyticsDataSet(BatchAssociateAnalyticsDataSetRequest batchAssociateAnalyticsDataSetRequest)
This API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
batchAssociateAnalyticsDataSetRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.BatchDisassociateAnalyticsDataSetResult batchDisassociateAnalyticsDataSet(BatchDisassociateAnalyticsDataSetRequest batchDisassociateAnalyticsDataSetRequest)
This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
batchDisassociateAnalyticsDataSetRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.BatchGetAttachedFileMetadataResult batchGetAttachedFileMetadata(BatchGetAttachedFileMetadataRequest batchGetAttachedFileMetadataRequest)
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.
batchGetAttachedFileMetadataRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.BatchGetFlowAssociationResult batchGetFlowAssociation(BatchGetFlowAssociationRequest batchGetFlowAssociationRequest)
Retrieve the flow associations for the given resources.
batchGetFlowAssociationRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.BatchPutContactResult batchPutContact(BatchPutContactRequest batchPutContactRequest)
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
batchPutContactRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The allowed limit for the resource has been exceeded.IdempotencyException - An entity with the same name already exists.ClaimPhoneNumberResult claimPhoneNumber(ClaimPhoneNumberRequest claimPhoneNumberRequest)
Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
claimPhoneNumberRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.IdempotencyException - An entity with the same name already exists.AccessDeniedException - You do not have sufficient permissions to perform this action.CompleteAttachedFileUploadResult completeAttachedFileUpload(CompleteAttachedFileUploadRequest completeAttachedFileUploadRequest)
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
completeAttachedFileUploadRequest - Request to CompleteAttachedFileUpload APIAccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.CreateAgentStatusResult createAgentStatus(CreateAgentStatusRequest createAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
createAgentStatusRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The allowed limit for the resource has been exceeded.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreateContactFlowResult createContactFlow(CreateContactFlowRequest createContactFlowRequest)
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
createContactFlowRequest - InvalidRequestException - The request is not valid.InvalidContactFlowException - The flow is not valid.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.LimitExceededException - The allowed limit for the resource has been exceeded.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreateContactFlowModuleResult createContactFlowModule(CreateContactFlowModuleRequest createContactFlowModuleRequest)
Creates a flow module for the specified Amazon Connect instance.
createContactFlowModuleRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidContactFlowModuleException - The problems with the module. Please fix before trying again.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.LimitExceededException - The allowed limit for the resource has been exceeded.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.IdempotencyException - An entity with the same name already exists.InternalServiceException - Request processing failed because of an error or failure with the service.CreateEvaluationFormResult createEvaluationForm(CreateEvaluationFormRequest createEvaluationFormRequest)
Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
createEvaluationFormRequest - InternalServiceException - Request processing failed because of an error or failure with the service.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.ServiceQuotaExceededException - The service quota has been exceeded.ResourceConflictException - A resource already has that name.CreateHoursOfOperationResult createHoursOfOperation(CreateHoursOfOperationRequest createHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
createHoursOfOperationRequest - DuplicateResourceException - A resource with the specified name already exists.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The allowed limit for the resource has been exceeded.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest)
This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
createInstanceRequest - InvalidRequestException - The request is not valid.ServiceQuotaExceededException - The service quota has been exceeded.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.CreateIntegrationAssociationResult createIntegrationAssociation(CreateIntegrationAssociationRequest createIntegrationAssociationRequest)
Creates an Amazon Web Services resource association with an Amazon Connect instance.
createIntegrationAssociationRequest - DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.ThrottlingException - The throttling limit has been exceeded.CreateParticipantResult createParticipant(CreateParticipantRequest createParticipantRequest)
Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
createParticipantRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ServiceQuotaExceededException - The service quota has been exceeded.ThrottlingException - The throttling limit has been exceeded.CreatePersistentContactAssociationResult createPersistentContactAssociation(CreatePersistentContactAssociationRequest createPersistentContactAssociationRequest)
Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
createPersistentContactAssociationRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.AccessDeniedException - You do not have sufficient permissions to perform this action.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreatePredefinedAttributeResult createPredefinedAttribute(CreatePredefinedAttributeRequest createPredefinedAttributeRequest)
Creates a new predefined attribute for the specified Amazon Connect instance.
createPredefinedAttributeRequest - DuplicateResourceException - A resource with the specified name already exists.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.LimitExceededException - The allowed limit for the resource has been exceeded.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreatePromptResult createPrompt(CreatePromptRequest createPromptRequest)
Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
createPromptRequest - DuplicateResourceException - A resource with the specified name already exists.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.LimitExceededException - The allowed limit for the resource has been exceeded.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreateQueueResult createQueue(CreateQueueRequest createQueueRequest)
This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon
Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group
that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that
is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is
provided in this scenario, you will receive a ResourceNotFoundException.
Only use the phone number ARN format that doesn't contain instance in the path, for example,
arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned
when you call the ListPhoneNumbersV2
API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
createQueueRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The allowed limit for the resource has been exceeded.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreateQuickConnectResult createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest)
Creates a quick connect for the specified Amazon Connect instance.
createQuickConnectRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The allowed limit for the resource has been exceeded.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest)
Creates a new routing profile.
createRoutingProfileRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The allowed limit for the resource has been exceeded.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreateRuleResult createRule(CreateRuleRequest createRuleRequest)
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
createRuleRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceConflictException - A resource already has that name.ServiceQuotaExceededException - The service quota has been exceeded.CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest)
Creates a security profile.
createSecurityProfileRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.LimitExceededException - The allowed limit for the resource has been exceeded.DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreateTaskTemplateResult createTaskTemplate(CreateTaskTemplateRequest createTaskTemplateRequest)
Creates a new task template in the specified Amazon Connect instance.
createTaskTemplateRequest - PropertyValidationException - The property is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.ServiceQuotaExceededException - The service quota has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreateTrafficDistributionGroupResult createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest createTrafficDistributionGroupRequest)
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
The SignInConfig distribution is available only on a default TrafficDistributionGroup
(see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified
SignInConfig and a non-default TrafficDistributionGroup, an
InvalidRequestException is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
createTrafficDistributionGroupRequest - InvalidRequestException - The request is not valid.AccessDeniedException - You do not have sufficient permissions to perform this action.ServiceQuotaExceededException - The service quota has been exceeded.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceConflictException - A resource already has that name.ResourceNotReadyException - The resource is not ready.CreateUseCaseResult createUseCase(CreateUseCaseRequest createUseCaseRequest)
Creates a use case for an integration association.
createUseCaseRequest - DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.ThrottlingException - The throttling limit has been exceeded.CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo
parameters are required in some situations. For example, Email is required if you are using SAML for
identity management. FirstName and LastName are required if you are using Amazon
Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
createUserRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.LimitExceededException - The allowed limit for the resource has been exceeded.DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreateUserHierarchyGroupResult createUserHierarchyGroup(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest)
Creates a new user hierarchy group.
createUserHierarchyGroupRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.LimitExceededException - The allowed limit for the resource has been exceeded.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.CreateViewResult createView(CreateViewRequest createViewRequest)
Creates a new view with the possible status of SAVED or PUBLISHED.
The views will have a unique name for each connect instance.
It performs basic content validation if the status is SAVED or full content validation if the status
is set to PUBLISHED. An error is returned if validation fails. It associates either the
$SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the
provided view content based on the status. The view is idempotent if ClientToken is provided.
createViewRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.DuplicateResourceException - A resource with the specified name already exists.ServiceQuotaExceededException - The service quota has been exceeded.TooManyRequestsException - Displayed when rate-related API limits are exceeded.ResourceInUseException - That resource is already in use. Please try another.CreateViewVersionResult createViewVersion(CreateViewVersionRequest createViewVersionRequest)
Publishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed
if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.
createViewVersionRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.TooManyRequestsException - Displayed when rate-related API limits are exceeded.ServiceQuotaExceededException - The service quota has been exceeded.ResourceInUseException - That resource is already in use. Please try another.CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest)
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
createVocabularyRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceConflictException - A resource already has that name.ServiceQuotaExceededException - The service quota has been exceeded.DeactivateEvaluationFormResult deactivateEvaluationForm(DeactivateEvaluationFormRequest deactivateEvaluationFormRequest)
Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
deactivateEvaluationFormRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceConflictException - A resource already has that name.DeleteAttachedFileResult deleteAttachedFile(DeleteAttachedFileRequest deleteAttachedFileRequest)
Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
deleteAttachedFileRequest - Request to DeleteAttachedFile APIAccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.DeleteContactEvaluationResult deleteContactEvaluation(DeleteContactEvaluationRequest deleteContactEvaluationRequest)
Deletes a contact evaluation in the specified Amazon Connect instance.
deleteContactEvaluationRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceConflictException - A resource already has that name.DeleteContactFlowResult deleteContactFlow(DeleteContactFlowRequest deleteContactFlowRequest)
Deletes a flow for the specified Amazon Connect instance.
deleteContactFlowRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.DeleteContactFlowModuleResult deleteContactFlowModule(DeleteContactFlowModuleRequest deleteContactFlowModuleRequest)
Deletes the specified flow module.
deleteContactFlowModuleRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DeleteEvaluationFormResult deleteEvaluationForm(DeleteEvaluationFormRequest deleteEvaluationFormRequest)
Deletes an evaluation form in the specified Amazon Connect instance.
If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.
deleteEvaluationFormRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceConflictException - A resource already has that name.DeleteHoursOfOperationResult deleteHoursOfOperation(DeleteHoursOfOperationRequest deleteHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
deleteHoursOfOperationRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DeleteInstanceResult deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
deleteInstanceRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.DeleteIntegrationAssociationResult deleteIntegrationAssociation(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest)
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
deleteIntegrationAssociationRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.ThrottlingException - The throttling limit has been exceeded.DeletePredefinedAttributeResult deletePredefinedAttribute(DeletePredefinedAttributeRequest deletePredefinedAttributeRequest)
Deletes a predefined attribute from the specified Amazon Connect instance.
deletePredefinedAttributeRequest - ResourceInUseException - That resource is already in use. Please try another.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DeletePromptResult deletePrompt(DeletePromptRequest deletePromptRequest)
Deletes a prompt.
deletePromptRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DeleteQueueResult deleteQueue(DeleteQueueRequest deleteQueueRequest)
Deletes a queue.
deleteQueueRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ResourceInUseException - That resource is already in use. Please try another.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DeleteQuickConnectResult deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest)
Deletes a quick connect.
After calling DeleteUser, it's important
to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
deleteQuickConnectRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DeleteRoutingProfileResult deleteRoutingProfile(DeleteRoutingProfileRequest deleteRoutingProfileRequest)
Deletes a routing profile.
deleteRoutingProfileRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ResourceInUseException - That resource is already in use. Please try another.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DeleteRuleResult deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes a rule for the specified Amazon Connect instance.
deleteRuleRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
Deletes a security profile.
deleteSecurityProfileRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceInUseException - That resource is already in use. Please try another.DeleteTaskTemplateResult deleteTaskTemplate(DeleteTaskTemplateRequest deleteTaskTemplateRequest)
Deletes the task template.
deleteTaskTemplateRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DeleteTrafficDistributionGroupResult deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest deleteTrafficDistributionGroupRequest)
Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.
deleteTrafficDistributionGroupRequest - InvalidRequestException - The request is not valid.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceInUseException - That resource is already in use. Please try another.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DeleteUseCaseResult deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest)
Deletes a use case from an integration association.
deleteUseCaseRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.ThrottlingException - The throttling limit has been exceeded.DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user account from the specified Amazon Connect instance.
For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
deleteUserRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DeleteUserHierarchyGroupResult deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest)
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroupRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ResourceInUseException - That resource is already in use. Please try another.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DeleteViewResult deleteView(DeleteViewRequest deleteViewRequest)
Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
deleteViewRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.TooManyRequestsException - Displayed when rate-related API limits are exceeded.ResourceInUseException - That resource is already in use. Please try another.DeleteViewVersionResult deleteViewVersion(DeleteViewVersionRequest deleteViewVersionRequest)
Deletes the particular version specified in ViewVersion identifier.
deleteViewVersionRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.TooManyRequestsException - Displayed when rate-related API limits are exceeded.ResourceInUseException - That resource is already in use. Please try another.DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)
Deletes the vocabulary that has the given identifier.
deleteVocabularyRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceInUseException - That resource is already in use. Please try another.DescribeAgentStatusResult describeAgentStatus(DescribeAgentStatusRequest describeAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
describeAgentStatusRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeAuthenticationProfileResult describeAuthenticationProfile(DescribeAuthenticationProfileRequest describeAuthenticationProfileRequest)
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Describes the target authentication profile.
describeAuthenticationProfileRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeContactResult describeContact(DescribeContactRequest describeContactRequest)
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
describeContactRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.DescribeContactEvaluationResult describeContactEvaluation(DescribeContactEvaluationRequest describeContactEvaluationRequest)
Describes a contact evaluation in the specified Amazon Connect instance.
describeContactEvaluationRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest)
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
In the response, Status indicates the flow status as either SAVED or PUBLISHED.
The PUBLISHED status will initiate validation on the content. SAVED does not initiate
validation of the content. SAVED | PUBLISHED
describeContactFlowRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ContactFlowNotPublishedException - The flow has not been published.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeContactFlowModuleResult describeContactFlowModule(DescribeContactFlowModuleRequest describeContactFlowModuleRequest)
Describes the specified flow module.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
describeContactFlowModuleRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeEvaluationFormResult describeEvaluationForm(DescribeEvaluationFormRequest describeEvaluationFormRequest)
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
describeEvaluationFormRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeHoursOfOperationResult describeHoursOfOperation(DescribeHoursOfOperationRequest describeHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
describeHoursOfOperationRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeInstanceResult describeInstance(DescribeInstanceRequest describeInstanceRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
describeInstanceRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest)
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttributeRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.DescribeInstanceStorageConfigResult describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
describeInstanceStorageConfigRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.DescribePhoneNumberResult describePhoneNumber(DescribePhoneNumberRequest describePhoneNumberRequest)
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region
where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the
PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution
group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic
distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will
receive a ResourceNotFoundException.
describePhoneNumberRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.AccessDeniedException - You do not have sufficient permissions to perform this action.DescribePredefinedAttributeResult describePredefinedAttribute(DescribePredefinedAttributeRequest describePredefinedAttributeRequest)
Describes a predefined attribute for the specified Amazon Connect instance.
describePredefinedAttributeRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribePromptResult describePrompt(DescribePromptRequest describePromptRequest)
Describes the prompt.
describePromptRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeQueueResult describeQueue(DescribeQueueRequest describeQueueRequest)
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
describeQueueRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeQuickConnectResult describeQuickConnect(DescribeQuickConnectRequest describeQuickConnectRequest)
Describes the quick connect.
describeQuickConnectRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest)
Describes the specified routing profile.
describeRoutingProfileRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeRuleResult describeRule(DescribeRuleRequest describeRuleRequest)
Describes a rule for the specified Amazon Connect instance.
describeRuleRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest)
Gets basic information about the security profle.
describeSecurityProfileRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeTrafficDistributionGroupResult describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest)
Gets details and status of a traffic distribution group.
describeTrafficDistributionGroupRequest - InvalidRequestException - The request is not valid.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
describeUserRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Describes the specified hierarchy group.
describeUserHierarchyGroupRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Describes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructureRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DescribeViewResult describeView(DescribeViewRequest describeViewRequest)
Retrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
$SAVED needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED, which is
either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is
not supplied, then $LATEST is assumed for customer managed views and an error is returned if there
is no published content available. Version 1 is assumed for Amazon Web Services managed views.
describeViewRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.TooManyRequestsException - Displayed when rate-related API limits are exceeded.DescribeVocabularyResult describeVocabulary(DescribeVocabularyRequest describeVocabularyRequest)
Describes the specified vocabulary.
describeVocabularyRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.DisassociateAnalyticsDataSetResult disassociateAnalyticsDataSet(DisassociateAnalyticsDataSetRequest disassociateAnalyticsDataSetRequest)
This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
disassociateAnalyticsDataSetRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DisassociateApprovedOriginResult disassociateApprovedOrigin(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest)
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOriginRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.DisassociateBotResult disassociateBot(DisassociateBotRequest disassociateBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.
disassociateBotRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.ThrottlingException - The throttling limit has been exceeded.DisassociateFlowResult disassociateFlow(DisassociateFlowRequest disassociateFlowRequest)
Disassociates a connect resource from a flow.
disassociateFlowRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.DisassociateInstanceStorageConfigResult disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
disassociateInstanceStorageConfigRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.DisassociateLambdaFunctionResult disassociateLambdaFunction(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest)
This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant flow blocks.
disassociateLambdaFunctionRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.DisassociateLexBotResult disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
disassociateLexBotRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.DisassociatePhoneNumberContactFlowResult disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest disassociatePhoneNumberContactFlowRequest)
Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the
Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone
number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is
claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon
Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If
a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
disassociatePhoneNumberContactFlowRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.AccessDeniedException - You do not have sufficient permissions to perform this action.DisassociateQueueQuickConnectsResult disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
disassociateQueueQuickConnectsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DisassociateRoutingProfileQueuesResult disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest)
Disassociates a set of queues from a routing profile.
disassociateRoutingProfileQueuesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DisassociateSecurityKeyResult disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest)
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKeyRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.DisassociateTrafficDistributionGroupUserResult disassociateTrafficDistributionGroupUser(DisassociateTrafficDistributionGroupUserRequest disassociateTrafficDistributionGroupUserRequest)
Disassociates an agent from a traffic distribution group.
disassociateTrafficDistributionGroupUserRequest - InvalidRequestException - The request is not valid.AccessDeniedException - You do not have sufficient permissions to perform this action.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.ResourceConflictException - A resource already has that name.InternalServiceException - Request processing failed because of an error or failure with the service.DisassociateUserProficienciesResult disassociateUserProficiencies(DisassociateUserProficienciesRequest disassociateUserProficienciesRequest)
Disassociates a set of proficiencies from a user.
disassociateUserProficienciesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.DismissUserContactResult dismissUserContact(DismissUserContactRequest dismissUserContactRequest)
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.
dismissUserContactRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServiceException - Request processing failed because of an error or failure with the service.GetAttachedFileResult getAttachedFile(GetAttachedFileRequest getAttachedFileRequest)
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.
getAttachedFileRequest - Request to GetAttachedFile API.AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.GetContactAttributesResult getContactAttributes(GetContactAttributesRequest getContactAttributesRequest)
Retrieves the contact attributes for the specified contact.
getContactAttributesRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
getCurrentMetricDataRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.GetCurrentUserDataResult getCurrentUserData(GetCurrentUserDataRequest getCurrentUserDataRequest)
Gets the real-time active user data from the specified Amazon Connect instance.
getCurrentUserDataRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.GetFederationTokenResult getFederationToken(GetFederationTokenRequest getFederationTokenRequest)
Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:
Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect
getFederationTokenRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.UserNotFoundException - No user with the specified credentials was found in the Amazon Connect instance.InternalServiceException - Request processing failed because of an error or failure with the service.DuplicateResourceException - A resource with the specified name already exists.GetFlowAssociationResult getFlowAssociation(GetFlowAssociationRequest getFlowAssociationRequest)
Retrieves the flow associated for a given resource.
getFlowAssociationRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.GetMetricDataResult getMetricData(GetMetricDataRequest getMetricDataRequest)
Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2 API.
It provides more flexibility, features, and the ability to query longer time ranges than
GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at
varying intervals. You can also use it to build custom dashboards to measure historical queue and agent
performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by
day, to see how contact volume changed per day of the week.
getMetricDataRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.GetMetricDataV2Result getMetricDataV2(GetMetricDataV2Request getMetricDataV2Request)
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the
previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to
filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve
historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2 and
GetMetricData, see Historical
metrics definitions in the Amazon Connect Administrator Guide.
getMetricDataV2Request - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.GetPromptFileResult getPromptFile(GetPromptFileRequest getPromptFileRequest)
Gets the prompt file.
getPromptFileRequest - InvalidParameterException - One or more of the specified parameters are not valid.InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.GetTaskTemplateResult getTaskTemplate(GetTaskTemplateRequest getTaskTemplateRequest)
Gets details about a specific task template in the specified Amazon Connect instance.
getTaskTemplateRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.GetTrafficDistributionResult getTrafficDistribution(GetTrafficDistributionRequest getTrafficDistributionRequest)
Retrieves the current traffic distribution for a given traffic distribution group.
getTrafficDistributionRequest - InvalidRequestException - The request is not valid.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ImportPhoneNumberResult importPhoneNumber(ImportPhoneNumberRequest importPhoneNumberRequest)
Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
Call the DescribePhoneNumber
API to verify the status of a previous ImportPhoneNumber operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
importPhoneNumberRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.IdempotencyException - An entity with the same name already exists.AccessDeniedException - You do not have sufficient permissions to perform this action.ListAgentStatusesResult listAgentStatuses(ListAgentStatusesRequest listAgentStatusesRequest)
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
listAgentStatusesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListAnalyticsDataAssociationsResult listAnalyticsDataAssociations(ListAnalyticsDataAssociationsRequest listAnalyticsDataAssociationsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
listAnalyticsDataAssociationsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListApprovedOriginsResult listApprovedOrigins(ListApprovedOriginsRequest listApprovedOriginsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
listApprovedOriginsRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.ListAuthenticationProfilesResult listAuthenticationProfiles(ListAuthenticationProfilesRequest listAuthenticationProfilesRequest)
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Provides summary information about the authentication profiles in a specified Amazon Connect instance.
listAuthenticationProfilesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListBotsResult listBots(ListBotsRequest listBotsRequest)
This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
listBotsRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.ThrottlingException - The throttling limit has been exceeded.ListContactEvaluationsResult listContactEvaluations(ListContactEvaluationsRequest listContactEvaluationsRequest)
Lists contact evaluations in the specified Amazon Connect instance.
listContactEvaluationsRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListContactFlowModulesResult listContactFlowModules(ListContactFlowModulesRequest listContactFlowModulesRequest)
Provides information about the flow modules for the specified Amazon Connect instance.
listContactFlowModulesRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListContactFlowsResult listContactFlows(ListContactFlowsRequest listContactFlowsRequest)
Provides information about the flows for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
For more information about flows, see Flows in the Amazon Connect Administrator Guide.
listContactFlowsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListContactReferencesResult listContactReferences(ListContactReferencesRequest listContactReferencesRequest)
This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes, returns a list of references associated with the contact.
References are links to documents that are related to a contact, such as emails, attachments, or URLs.
listContactReferencesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ListDefaultVocabulariesResult listDefaultVocabularies(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest)
Lists the default vocabularies for the specified Amazon Connect instance.
listDefaultVocabulariesRequest - InvalidRequestException - The request is not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.ListEvaluationFormVersionsResult listEvaluationFormVersions(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest)
Lists versions of an evaluation form in the specified Amazon Connect instance.
listEvaluationFormVersionsRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListEvaluationFormsResult listEvaluationForms(ListEvaluationFormsRequest listEvaluationFormsRequest)
Lists evaluation forms in the specified Amazon Connect instance.
listEvaluationFormsRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListFlowAssociationsResult listFlowAssociations(ListFlowAssociationsRequest listFlowAssociationsRequest)
List the flow association based on the filters.
listFlowAssociationsRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest)
Provides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
listHoursOfOperationsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListInstanceAttributesResult listInstanceAttributes(ListInstanceAttributesRequest listInstanceAttributesRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
listInstanceAttributesRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.ListInstanceStorageConfigsResult listInstanceStorageConfigs(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
listInstanceStorageConfigsRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest)
This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
listInstancesRequest - InvalidRequestException - The request is not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ListIntegrationAssociationsResult listIntegrationAssociations(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest)
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
listIntegrationAssociationsRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.ThrottlingException - The throttling limit has been exceeded.ListLambdaFunctionsResult listLambdaFunctions(ListLambdaFunctionsRequest listLambdaFunctionsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.
listLambdaFunctionsRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.ListLexBotsResult listLexBots(ListLexBotsRequest listLexBotsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
listLexBotsRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)
Provides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
We recommend using ListPhoneNumbersV2
to return phone number types. ListPhoneNumbers doesn't support number types UIFN,
SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of
those types, it incorrectly lists them as TOLL_FREE or DID.
The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a
ResourceNotFoundException. Instead, use the ListPhoneNumbersV2
API. It returns the new phone number ARN that can be used to tag phone number resources.
listPhoneNumbersRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListPhoneNumbersV2Result listPhoneNumbersV2(ListPhoneNumbersV2Request listPhoneNumbersV2Request)
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided
TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions
associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the
instance.
When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers
claimed to the traffic distribution group.
listPhoneNumbersV2Request - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.AccessDeniedException - You do not have sufficient permissions to perform this action.ListPredefinedAttributesResult listPredefinedAttributes(ListPredefinedAttributesRequest listPredefinedAttributesRequest)
Lists predefined attributes for the specified Amazon Connect instance.
listPredefinedAttributesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListPromptsResult listPrompts(ListPromptsRequest listPromptsRequest)
Provides information about the prompts for the specified Amazon Connect instance.
listPromptsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListQueueQuickConnectsResult listQueueQuickConnects(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
listQueueQuickConnectsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest)
Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This
might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of
results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
listQueuesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListQuickConnectsResult listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest)
Provides information about the quick connects for the specified Amazon Connect instance.
listQuickConnectsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListRealtimeContactAnalysisSegmentsV2Result listRealtimeContactAnalysisSegmentsV2(ListRealtimeContactAnalysisSegmentsV2Request listRealtimeContactAnalysisSegmentsV2Request)
Provides a list of analysis segments for a real-time analysis session.
listRealtimeContactAnalysisSegmentsV2Request - OutputTypeNotFoundException - Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example,
if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in Contact
flow.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.InvalidRequestException - The request is not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest)
Lists the queues associated with a routing profile.
listRoutingProfileQueuesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)
Provides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
listRoutingProfilesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListRulesResult listRules(ListRulesRequest listRulesRequest)
List all rules for the specified Amazon Connect instance.
listRulesRequest - InvalidRequestException - The request is not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.ListSecurityKeysResult listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
listSecurityKeysRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.ListSecurityProfileApplicationsResult listSecurityProfileApplications(ListSecurityProfileApplicationsRequest listSecurityProfileApplicationsRequest)
Returns a list of third-party applications in a specific security profile.
listSecurityProfileApplicationsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListSecurityProfilePermissionsResult listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest)
Lists the permissions granted to a security profile.
listSecurityProfilePermissionsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest)
Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
listSecurityProfilesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
listTagsForResourceRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.ListTaskTemplatesResult listTaskTemplates(ListTaskTemplatesRequest listTaskTemplatesRequest)
Lists task templates for the specified Amazon Connect instance.
listTaskTemplatesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListTrafficDistributionGroupUsersResult listTrafficDistributionGroupUsers(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest)
Lists traffic distribution group users.
listTrafficDistributionGroupUsersRequest - ResourceNotFoundException - The specified resource was not found.InvalidRequestException - The request is not valid.AccessDeniedException - You do not have sufficient permissions to perform this action.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListTrafficDistributionGroupsResult listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest)
Lists traffic distribution groups.
listTrafficDistributionGroupsRequest - InvalidRequestException - The request is not valid.AccessDeniedException - You do not have sufficient permissions to perform this action.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListUseCasesResult listUseCases(ListUseCasesRequest listUseCasesRequest)
Lists the use cases for the integration association.
listUseCasesRequest - Provides summary information about the use cases for the specified integration association.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.ThrottlingException - The throttling limit has been exceeded.ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
listUserHierarchyGroupsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListUserProficienciesResult listUserProficiencies(ListUserProficienciesRequest listUserProficienciesRequest)
Lists proficiencies associated with a user.
listUserProficienciesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Provides summary information about the users for the specified Amazon Connect instance.
listUsersRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ListViewVersionsResult listViewVersions(ListViewVersionsRequest listViewVersionsRequest)
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
listViewVersionsRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.TooManyRequestsException - Displayed when rate-related API limits are exceeded.ListViewsResult listViews(ListViewsRequest listViewsRequest)
Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
listViewsRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.TooManyRequestsException - Displayed when rate-related API limits are exceeded.MonitorContactResult monitorContact(MonitorContactRequest monitorContactRequest)
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.
monitorContactRequest - InvalidRequestException - The request is not valid.IdempotencyException - An entity with the same name already exists.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.ServiceQuotaExceededException - The service quota has been exceeded.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.PauseContactResult pauseContact(PauseContactRequest pauseContactRequest)
Allows pausing an ongoing task contact.
pauseContactRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.LimitExceededException - The allowed limit for the resource has been exceeded.ConflictException - Operation cannot be performed at this time as there is a conflict with another operation or contact
state.PutUserStatusResult putUserStatus(PutUserStatusRequest putUserStatusRequest)
Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.
For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
putUserStatusRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServiceException - Request processing failed because of an error or failure with the service.ReleasePhoneNumberResult releasePhoneNumber(ReleasePhoneNumberRequest releasePhoneNumberRequest)
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the
Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
releasePhoneNumberRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceInUseException - That resource is already in use. Please try another.IdempotencyException - An entity with the same name already exists.AccessDeniedException - You do not have sufficient permissions to perform this action.ReplicateInstanceResult replicateInstance(ReplicateInstanceRequest replicateInstanceRequest)
Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
replicateInstanceRequest - InvalidRequestException - The request is not valid.AccessDeniedException - You do not have sufficient permissions to perform this action.ServiceQuotaExceededException - The service quota has been exceeded.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceNotReadyException - The resource is not ready.ResourceConflictException - A resource already has that name.ResumeContactResult resumeContact(ResumeContactRequest resumeContactRequest)
Allows resuming a task contact in a paused state.
resumeContactRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.ConflictException - Operation cannot be performed at this time as there is a conflict with another operation or contact
state.ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest)
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
resumeContactRecordingRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.SearchAgentStatusesResult searchAgentStatuses(SearchAgentStatusesRequest searchAgentStatusesRequest)
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
searchAgentStatusesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
group. If the provided TargetArn is a traffic distribution group, you can call this API in both
Amazon Web Services Regions associated with the traffic distribution group.
searchAvailablePhoneNumbersRequest - InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.AccessDeniedException - You do not have sufficient permissions to perform this action.SearchContactFlowModulesResult searchContactFlowModules(SearchContactFlowModulesRequest searchContactFlowModulesRequest)
Searches the flow modules in an Amazon Connect instance, with optional filtering.
searchContactFlowModulesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchContactFlowsResult searchContactFlows(SearchContactFlowsRequest searchContactFlowsRequest)
Searches the contact flows in an Amazon Connect instance, with optional filtering.
searchContactFlowsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchContactsResult searchContacts(SearchContactsRequest searchContactsRequest)
Searches contacts in an Amazon Connect instance.
searchContactsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.SearchHoursOfOperationsResult searchHoursOfOperations(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest)
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
searchHoursOfOperationsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchPredefinedAttributesResult searchPredefinedAttributes(SearchPredefinedAttributesRequest searchPredefinedAttributesRequest)
Predefined attributes that meet certain criteria.
searchPredefinedAttributesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchPromptsResult searchPrompts(SearchPromptsRequest searchPromptsRequest)
Searches prompts in an Amazon Connect instance, with optional filtering.
searchPromptsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchQueuesResult searchQueues(SearchQueuesRequest searchQueuesRequest)
Searches queues in an Amazon Connect instance, with optional filtering.
searchQueuesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchQuickConnectsResult searchQuickConnects(SearchQuickConnectsRequest searchQuickConnectsRequest)
Searches quick connects in an Amazon Connect instance, with optional filtering.
searchQuickConnectsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchResourceTagsResult searchResourceTags(SearchResourceTagsRequest searchResourceTagsRequest)
Searches tags used in an Amazon Connect instance using optional search criteria.
searchResourceTagsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.MaximumResultReturnedException - Maximum number (1000) of tags have been returned with current request. Consider changing request
parameters to get more tags.SearchRoutingProfilesResult searchRoutingProfiles(SearchRoutingProfilesRequest searchRoutingProfilesRequest)
Searches routing profiles in an Amazon Connect instance, with optional filtering.
searchRoutingProfilesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchSecurityProfilesResult searchSecurityProfiles(SearchSecurityProfilesRequest searchSecurityProfilesRequest)
Searches security profiles in an Amazon Connect instance, with optional filtering.
searchSecurityProfilesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchUserHierarchyGroupsResult searchUserHierarchyGroups(SearchUserHierarchyGroupsRequest searchUserHierarchyGroupsRequest)
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an
instance. It is not user-definable, nor is it visible in the UI.
searchUserHierarchyGroupsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchUsersResult searchUsers(SearchUsersRequest searchUsersRequest)
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit is returned in milliseconds.
searchUsersRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.SearchVocabulariesResult searchVocabularies(SearchVocabulariesRequest searchVocabulariesRequest)
Searches for vocabularies within a specific Amazon Connect instance using State,
NameStartsWith, and LanguageCode.
searchVocabulariesRequest - InvalidRequestException - The request is not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.SendChatIntegrationEventResult sendChatIntegrationEvent(SendChatIntegrationEventRequest sendChatIntegrationEventRequest)
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
sendChatIntegrationEventRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.StartAttachedFileUploadResult startAttachedFileUpload(StartAttachedFileUploadRequest startAttachedFileUploadRequest)
Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case.
startAttachedFileUploadRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceConflictException - A resource already has that name.ServiceQuotaExceededException - The service quota has been exceeded.StartChatContactResult startChatContact(StartChatContactRequest startChatContactRequest)
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.
The quota for
concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support
the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
startChatContactRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.LimitExceededException - The allowed limit for the resource has been exceeded.StartContactEvaluationResult startContactEvaluation(StartContactEvaluationRequest startContactEvaluationRequest)
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
Evaluations created through the public API do not contain answer values suggested from automation.
startContactEvaluationRequest - InternalServiceException - Request processing failed because of an error or failure with the service.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.ServiceQuotaExceededException - The service quota has been exceeded.ResourceConflictException - A resource already has that name.StartContactRecordingResult startContactRecording(StartContactRecordingRequest startContactRecordingRequest)
Starts recording the contact:
If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API call.
StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
startContactRecordingRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.StartContactStreamingResult startContactStreaming(StartContactStreamingRequest startContactStreamingRequest)
Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
startContactStreamingRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.LimitExceededException - The allowed limit for the resource has been exceeded.StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)
Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's
specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Campaign calls are not allowed by default. Before you can make a call with TrafficType =
CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.
startOutboundVoiceContactRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.LimitExceededException - The allowed limit for the resource has been exceeded.DestinationNotAllowedException - Outbound calls to the destination number are not allowed.OutboundContactNotPermittedException - The contact is not permitted.StartTaskContactResult startTaskContact(StartTaskContactRequest startTaskContactRequest)
Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId and RelatedContactId input parameters, note the following:
PreviousContactId
Any updates to user-defined task contact attributes on any contact linked through the same
PreviousContactId will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share
the same PreviousContactId.
RelatedContactId
Copies contact attributes from the related task contact to the new contact.
Any update on attributes in a new task contact does not update attributes on previous contact.
There’s no limit on the number of task contacts that can be created that use the same
RelatedContactId.
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID,
QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task
template has a flow configured to run it. If more than one parameter is specified, or only the
TaskTemplateID is specified but it does not have a flow configured, the request returns an error
because Amazon Connect cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota
or there are already 12 tasks referencing the same PreviousContactId. For more information about
service quotas for task contacts, see Amazon Connect
service quotas in the Amazon Connect Administrator Guide.
startTaskContactRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.ServiceQuotaExceededException - The service quota has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.StartWebRTCContactResult startWebRTCContact(StartWebRTCContactRequest startWebRTCContactRequest)
Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
startWebRTCContactRequest - InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.LimitExceededException - The allowed limit for the resource has been exceeded.ResourceNotFoundException - The specified resource was not found.StopContactResult stopContact(StopContactRequest stopContactRequest)
Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
stopContactRequest - InvalidRequestException - The request is not valid.ContactNotFoundException - The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to
Chat or Task contacts.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.StopContactRecordingResult stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest)
Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
stopContactRecordingRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.StopContactStreamingResult stopContactStreaming(StopContactStreamingRequest stopContactStreamingRequest)
Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
stopContactStreamingRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.SubmitContactEvaluationResult submitContactEvaluation(SubmitContactEvaluationRequest submitContactEvaluationRequest)
Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged
with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted
with the existing answers and notes. You can delete an answer or note by passing an empty object ({}
) to the question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
submitContactEvaluationRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceConflictException - A resource already has that name.SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest)
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice and screen recordings are supported.
suspendContactRecordingRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.TagContactResult tagContact(TagContactRequest tagContactRequest)
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 Amazon Connect usage.
tagContactRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
tagResourceRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.TransferContactResult transferContact(TransferContactRequest transferContactRequest)
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is supported for only TASK contacts.
Do not use both QueueId and UserId in the same call.
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The TransferContact API can be called only on active contacts.
A contact cannot be transferred more than 11 times.
transferContactRequest - InvalidRequestException - The request is not valid.IdempotencyException - An entity with the same name already exists.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.ServiceQuotaExceededException - The service quota has been exceeded.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UntagContactResult untagContact(UntagContactRequest untagContactRequest)
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 Amazon Connect usage.
untagContactRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource.
untagResourceRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.UpdateAgentStatusResult updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
updateAgentStatusRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The allowed limit for the resource has been exceeded.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateAuthenticationProfileResult updateAuthenticationProfile(UpdateAuthenticationProfileRequest updateAuthenticationProfileRequest)
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Updates the selected authentication profile.
updateAuthenticationProfileRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateContactResult updateContact(UpdateContactRequest updateContactRequest)
This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
updateContactRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest)
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
updateContactAttributesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateContactEvaluationResult updateContactEvaluation(UpdateContactEvaluationRequest updateContactEvaluationRequest)
Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be
in draft state. Answers included in the request are merged with existing answers for the given evaluation. An
answer or note can be deleted by passing an empty object ({}) to the question identifier.
updateContactEvaluationRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceConflictException - A resource already has that name.UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest)
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
updateContactFlowContentRequest - InvalidRequestException - The request is not valid.InvalidContactFlowException - The flow is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateContactFlowMetadataResult updateContactFlowMetadata(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest)
Updates metadata about specified flow.
updateContactFlowMetadataRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateContactFlowModuleContentResult updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest)
Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
updateContactFlowModuleContentRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidContactFlowModuleException - The problems with the module. Please fix before trying again.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateContactFlowModuleMetadataResult updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest)
Updates metadata about specified flow module.
updateContactFlowModuleMetadataRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateContactFlowNameResult updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest)
The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
updateContactFlowNameRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateContactRoutingDataResult updateContactRoutingData(UpdateContactRoutingDataRequest updateContactRoutingDataRequest)
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.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
updateContactRoutingDataRequest - ResourceConflictException - A resource already has that name.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.UpdateContactScheduleResult updateContactSchedule(UpdateContactScheduleRequest updateContactScheduleRequest)
Updates the scheduled time of a task contact that is already scheduled.
updateContactScheduleRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.LimitExceededException - The allowed limit for the resource has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateEvaluationFormResult updateEvaluationForm(UpdateEvaluationFormRequest updateEvaluationFormRequest)
Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
updateEvaluationFormRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ServiceQuotaExceededException - The service quota has been exceeded.ResourceConflictException - A resource already has that name.UpdateHoursOfOperationResult updateHoursOfOperation(UpdateHoursOfOperationRequest updateHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
updateHoursOfOperationRequest - DuplicateResourceException - A resource with the specified name already exists.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateInstanceAttributeResult updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttributeRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.UpdateInstanceStorageConfigResult updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
updateInstanceStorageConfigRequest - ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ThrottlingException - The throttling limit has been exceeded.UpdateParticipantRoleConfigResult updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest updateParticipantRoleConfigRequest)
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
Customer idle timeout
Customer auto-disconnect timeout
Agent idle timeout
Agent auto-disconnect timeout
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
updateParticipantRoleConfigRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.AccessDeniedException - You do not have sufficient permissions to perform this action.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
updatePhoneNumberRequest - InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.ResourceInUseException - That resource is already in use. Please try another.IdempotencyException - An entity with the same name already exists.AccessDeniedException - You do not have sufficient permissions to perform this action.UpdatePhoneNumberMetadataResult updatePhoneNumberMetadata(UpdatePhoneNumberMetadataRequest updatePhoneNumberMetadataRequest)
Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
updatePhoneNumberMetadataRequest - InvalidParameterException - One or more of the specified parameters are not valid.InvalidRequestException - The request is not valid.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.ResourceInUseException - That resource is already in use. Please try another.IdempotencyException - An entity with the same name already exists.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdatePredefinedAttributeResult updatePredefinedAttribute(UpdatePredefinedAttributeRequest updatePredefinedAttributeRequest)
Updates a predefined attribute for the specified Amazon Connect instance.
updatePredefinedAttributeRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdatePromptResult updatePrompt(UpdatePromptRequest updatePromptRequest)
Updates a prompt.
updatePromptRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateQueueHoursOfOperationResult updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest updateQueueHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
updateQueueHoursOfOperationRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateQueueMaxContactsResult updateQueueMaxContacts(UpdateQueueMaxContactsRequest updateQueueMaxContactsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
updateQueueMaxContactsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateQueueNameResult updateQueueName(UpdateQueueNameRequest updateQueueNameRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least Name or Description must be
provided.
updateQueueNameRequest - DuplicateResourceException - A resource with the specified name already exists.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateQueueOutboundCallerConfigResult updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest updateQueueOutboundCallerConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon
Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group
that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that
is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is
provided in this scenario, you will receive a ResourceNotFoundException.
Only use the phone number ARN format that doesn't contain instance in the path, for example,
arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned
when you call the ListPhoneNumbersV2
API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
updateQueueOutboundCallerConfigRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateQueueStatusResult updateQueueStatus(UpdateQueueStatusRequest updateQueueStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
updateQueueStatusRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateQuickConnectConfigResult updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest)
Updates the configuration settings for the specified quick connect.
updateQuickConnectConfigRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateQuickConnectNameResult updateQuickConnectName(UpdateQuickConnectNameRequest updateQuickConnectNameRequest)
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.
updateQuickConnectNameRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateRoutingProfileAgentAvailabilityTimerResult updateRoutingProfileAgentAvailabilityTimer(UpdateRoutingProfileAgentAvailabilityTimerRequest updateRoutingProfileAgentAvailabilityTimerRequest)
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
updateRoutingProfileAgentAvailabilityTimerRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateRoutingProfileConcurrencyResult updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest)
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrencyRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateRoutingProfileDefaultOutboundQueueResult updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest)
Updates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueueRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateRoutingProfileNameResult updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest)
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.
updateRoutingProfileNameRequest - DuplicateResourceException - A resource with the specified name already exists.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateRoutingProfileQueuesResult updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest)
Updates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueuesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateRuleResult updateRule(UpdateRuleRequest updateRuleRequest)
Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
updateRuleRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceConflictException - A resource already has that name.UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest)
Updates a security profile.
updateSecurityProfileRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateTaskTemplateResult updateTaskTemplate(UpdateTaskTemplateRequest updateTaskTemplateRequest)
Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
updateTaskTemplateRequest - PropertyValidationException - The property is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.ServiceQuotaExceededException - The service quota has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateTrafficDistributionResult updateTrafficDistribution(UpdateTrafficDistributionRequest updateTrafficDistributionRequest)
Updates the traffic distribution for a given traffic distribution group.
The SignInConfig distribution is available only on a default TrafficDistributionGroup
(see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified
SignInConfig and a non-default TrafficDistributionGroup, an
InvalidRequestException is returned.
For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.
updateTrafficDistributionRequest - InvalidRequestException - The request is not valid.AccessDeniedException - You do not have sufficient permissions to perform this action.ResourceNotFoundException - The specified resource was not found.ResourceConflictException - A resource already has that name.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the specified user.
updateUserHierarchyRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateUserHierarchyGroupNameResult updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest)
Updates the name of the user hierarchy group.
updateUserHierarchyGroupNameRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.DuplicateResourceException - A resource with the specified name already exists.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateUserHierarchyStructureResult updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest)
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructureRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ResourceInUseException - That resource is already in use. Please try another.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with
that ability can change the login credentials of other users by changing their email address. This poses a
security risk to your organization. They can change the email address of a user to the attacker's email address,
and then reset the password through email. For more information, see Best Practices
for Security Profiles in the Amazon Connect Administrator Guide.
updateUserIdentityInfoRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings for the specified user.
updateUserPhoneConfigRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateUserProficienciesResult updateUserProficiencies(UpdateUserProficienciesRequest updateUserProficienciesRequest)
Updates the properties associated with the proficiencies of a user.
updateUserProficienciesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to the specified user.
updateUserRoutingProfileRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Assigns the specified security profiles to the specified user.
updateUserSecurityProfilesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed because of an error or failure with the service.UpdateViewContentResult updateViewContent(UpdateViewContentRequest updateViewContentRequest)
Updates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if Status is set to SAVED and performs full content
validation if Status is PUBLISHED. Note that the $SAVED alias' content
will always be updated, but the $LATEST alias' content will only be updated if Status
is PUBLISHED.
updateViewContentRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.TooManyRequestsException - Displayed when rate-related API limits are exceeded.ResourceInUseException - That resource is already in use. Please try another.UpdateViewMetadataResult updateViewMetadata(UpdateViewMetadataRequest updateViewMetadataRequest)
Updates the view metadata. Note that either Name or Description must be provided.
updateViewMetadataRequest - AccessDeniedException - You do not have sufficient permissions to perform this action.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the specified parameters are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed because of an error or failure with the service.TooManyRequestsException - Displayed when rate-related API limits are exceeded.DuplicateResourceException - A resource with the specified name already exists.ResourceInUseException - That resource is already in use. Please try another.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.