@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 AWS service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
Working with contact flows? Check out the Amazon Connect Flow language.
| 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 |
|---|---|
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.
|
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.
|
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.
|
CreateAgentStatusResult |
createAgentStatus(CreateAgentStatusRequest createAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateContactFlowResult |
createContactFlow(CreateContactFlowRequest createContactFlowRequest)
Creates a contact flow for the specified Amazon Connect instance.
|
CreateContactFlowModuleResult |
createContactFlowModule(CreateContactFlowModuleRequest createContactFlowModuleRequest)
Creates a contact flow module for 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 AWS resource association with an Amazon Connect instance.
|
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.
|
CreateSecurityProfileResult |
createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
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.
|
DeleteContactFlowResult |
deleteContactFlow(DeleteContactFlowRequest deleteContactFlowRequest)
Deletes a contact flow for the specified Amazon Connect instance.
|
DeleteContactFlowModuleResult |
deleteContactFlowModule(DeleteContactFlowModuleRequest deleteContactFlowModuleRequest)
Deletes the specified contact flow module.
|
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 AWS resource association from an Amazon Connect instance.
|
DeleteQuickConnectResult |
deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest)
Deletes a quick connect.
|
DeleteSecurityProfileResult |
deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
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.
|
DescribeAgentStatusResult |
describeAgentStatus(DescribeAgentStatusRequest describeAgentStatusRequest)
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.
|
DescribeContactFlowResult |
describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest)
Describes the specified contact flow.
|
DescribeContactFlowModuleResult |
describeContactFlowModule(DescribeContactFlowModuleRequest describeContactFlowModuleRequest)
Describes the specified contact flow module.
|
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.
|
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.
|
DescribeSecurityProfileResult |
describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeUserResult |
describeUser(DescribeUserRequest describeUserRequest)
Describes the specified user account.
|
DescribeUserHierarchyGroupResult |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Describes the specified hierarchy group.
|
DescribeUserHierarchyStructureResult |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Describes the hierarchy structure of the specified Amazon Connect instance.
|
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.
|
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.
|
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.
|
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.
|
GetFederationTokenResult |
getFederationToken(GetFederationTokenRequest getFederationTokenRequest)
Retrieves a token for federation.
|
GetMetricDataResult |
getMetricData(GetMetricDataRequest getMetricDataRequest)
Gets historical metric data from the specified Amazon Connect instance.
|
ListAgentStatusesResult |
listAgentStatuses(ListAgentStatusesRequest listAgentStatusesRequest)
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.
|
ListBotsResult |
listBots(ListBotsRequest listBotsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListContactFlowModulesResult |
listContactFlowModules(ListContactFlowModulesRequest listContactFlowModulesRequest)
Provides information about the contact flow modules for the specified Amazon Connect instance.
|
ListContactFlowsResult |
listContactFlows(ListContactFlowsRequest listContactFlowsRequest)
Provides information about the contact 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.
|
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 AWS 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.
|
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.
|
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.
|
ListSecurityKeysResult |
listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
ListSecurityProfilePermissionsResult |
listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
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.
|
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.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Provides summary information about the users for the specified Amazon Connect instance.
|
ResumeContactRecordingResult |
resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest)
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API
resumes recording the call.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartChatContactResult |
startChatContact(StartChatContactRequest startChatContactRequest)
Initiates a contact flow to start a new chat for the customer.
|
StartContactRecordingResult |
startContactRecording(StartContactRecordingRequest startContactRecordingRequest)
Starts recording the contact when the agent joins the call.
|
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 contact flow.
|
StartTaskContactResult |
startTaskContact(StartTaskContactRequest startTaskContactRequest)
Initiates a contact flow to start a new task.
|
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.
|
SuspendContactRecordingResult |
suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest)
When a contact is being recorded, this API suspends recording the call.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified 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.
|
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.
|
UpdateContactFlowContentResult |
updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest)
Updates the specified contact flow.
|
UpdateContactFlowMetadataResult |
updateContactFlowMetadata(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest)
Updates metadata about specified contact flow.
|
UpdateContactFlowModuleContentResult |
updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest)
Updates specified contact flow module for the specified Amazon Connect instance.
|
UpdateContactFlowModuleMetadataResult |
updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest)
Updates metadata about specified contact flow module.
|
UpdateContactFlowNameResult |
updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest)
The name of the contact flow.
|
UpdateContactScheduleResult |
updateContactSchedule(UpdateContactScheduleRequest updateContactScheduleRequest)
Updates the scheduled time of a task contact that is already scheduled.
|
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.
|
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.
|
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.
|
UpdateSecurityProfileResult |
updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to change.
|
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.
|
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.
|
static final String ENDPOINT_PREFIX
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.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 bot.
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.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.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 contact flow for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
createContactFlowRequest - InvalidRequestException - The request is not valid.InvalidContactFlowException - The contact 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 contact 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.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 AWS 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.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.
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.CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to change.
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.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.
For information about how to create user accounts using the Amazon Connect console, 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.DeleteContactFlowResult deleteContactFlow(DeleteContactFlowRequest deleteContactFlowRequest)
Deletes a contact 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 contact 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.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 AWS 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.DeleteQuickConnectResult deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest)
Deletes a quick connect.
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.DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to change.
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.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.
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.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.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.
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.DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest)
Describes the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
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 contact 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 contact flow module.
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.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.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.DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to change.
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.DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
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.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.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 contact 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.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.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.GetFederationTokenResult getFederationToken(GetFederationTokenRequest getFederationTokenRequest)
Retrieves a token for federation.
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.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.
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.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.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.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.
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.ListContactFlowModulesResult listContactFlowModules(ListContactFlowModulesRequest listContactFlowModulesRequest)
Provides information about the contact 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 contact flows for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
For more information about contact flows, see Contact 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.
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.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 AWS 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 contact 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 bots currently associated with the instance.
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.
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.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.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.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.ListSecurityProfilePermissionsResult listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest)
This API is in preview release for Amazon Connect and is subject to change.
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.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.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.ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest)
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
Only voice recordings are supported at this time.
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.StartChatContactResult startChatContact(StartChatContactRequest startChatContactRequest)
Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
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 two 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.
For more information about chat, see Chat 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.StartContactRecordingResult startContactRecording(StartContactRecordingRequest startContactRecordingRequest)
Starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
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.
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 contact flow. It performs the actions in the contact
flow that's specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the contact 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. For more information, see Amazon Connect
Service Quotas in the Amazon Connect Administrator Guide.
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 contact flow to start a new task.
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.StopContactResult stopContact(StopContactRequest stopContactRequest)
Ends the specified contact.
stopContactRequest - InvalidRequestException - The request is not valid.ContactNotFoundException - The contact with the specified ID is not active or does not exist.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.SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest)
When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.
The period of time that the recording is suspended is filled with silence in the final recording.
Only voice recordings are supported at this time.
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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
The supported resource types are users, routing profiles, queues, quick connects, contact flows, agent status, and hours of operation.
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.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.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 CTR retention and the maximum size of the CTR attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, which was September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.
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.UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest)
Updates the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
updateContactFlowContentRequest - InvalidRequestException - The request is not valid.InvalidContactFlowException - The contact 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 contact 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 contact flow module for the specified Amazon Connect instance.
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 contact 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 contact flow.
You can also create and update contact 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.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.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.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.
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.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.UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to change.
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.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.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.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.