@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonConnect extends Object implements AmazonConnect
AmazonConnect
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateApprovedOriginResult |
associateApprovedOrigin(AssociateApprovedOriginRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateInstanceStorageConfigResult |
associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateLambdaFunctionResult |
associateLambdaFunction(AssociateLambdaFunctionRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateLexBotResult |
associateLexBot(AssociateLexBotRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateRoutingProfileQueuesResult |
associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest request)
Associates a set of queues with a routing profile.
|
AssociateSecurityKeyResult |
associateSecurityKey(AssociateSecurityKeyRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateContactFlowResult |
createContactFlow(CreateContactFlowRequest request)
Creates a contact flow for the specified Amazon Connect instance.
|
CreateInstanceResult |
createInstance(CreateInstanceRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateIntegrationAssociationResult |
createIntegrationAssociation(CreateIntegrationAssociationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateQuickConnectResult |
createQuickConnect(CreateQuickConnectRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateRoutingProfileResult |
createRoutingProfile(CreateRoutingProfileRequest request)
Creates a new routing profile.
|
CreateUseCaseResult |
createUseCase(CreateUseCaseRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user account for the specified Amazon Connect instance.
|
CreateUserHierarchyGroupResult |
createUserHierarchyGroup(CreateUserHierarchyGroupRequest request)
Creates a new user hierarchy group.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DeleteIntegrationAssociationResult |
deleteIntegrationAssociation(DeleteIntegrationAssociationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DeleteQuickConnectResult |
deleteQuickConnect(DeleteQuickConnectRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DeleteUseCaseResult |
deleteUseCase(DeleteUseCaseRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user account from the specified Amazon Connect instance.
|
DeleteUserHierarchyGroupResult |
deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest request)
Deletes an existing user hierarchy group.
|
DescribeContactFlowResult |
describeContactFlow(DescribeContactFlowRequest request)
Describes the specified contact flow.
|
DescribeInstanceResult |
describeInstance(DescribeInstanceRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeInstanceAttributeResult |
describeInstanceAttribute(DescribeInstanceAttributeRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeInstanceStorageConfigResult |
describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeQuickConnectResult |
describeQuickConnect(DescribeQuickConnectRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeRoutingProfileResult |
describeRoutingProfile(DescribeRoutingProfileRequest request)
Describes the specified routing profile.
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Describes the specified user account.
|
DescribeUserHierarchyGroupResult |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
Describes the specified hierarchy group.
|
DescribeUserHierarchyStructureResult |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
Describes the hierarchy structure of the specified Amazon Connect instance.
|
DisassociateApprovedOriginResult |
disassociateApprovedOrigin(DisassociateApprovedOriginRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateInstanceStorageConfigResult |
disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateLambdaFunctionResult |
disassociateLambdaFunction(DisassociateLambdaFunctionRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateLexBotResult |
disassociateLexBot(DisassociateLexBotRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateRoutingProfileQueuesResult |
disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest request)
Disassociates a set of queues from a routing profile.
|
DisassociateSecurityKeyResult |
disassociateSecurityKey(DisassociateSecurityKeyRequest request)
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 request)
Retrieves the contact attributes for the specified contact.
|
GetCurrentMetricDataResult |
getCurrentMetricData(GetCurrentMetricDataRequest request)
Gets the real-time metric data from the specified Amazon Connect instance.
|
GetFederationTokenResult |
getFederationToken(GetFederationTokenRequest request)
Retrieves a token for federation.
|
GetMetricDataResult |
getMetricData(GetMetricDataRequest request)
Gets historical metric data from the specified Amazon Connect instance.
|
ListApprovedOriginsResult |
listApprovedOrigins(ListApprovedOriginsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListContactFlowsResult |
listContactFlows(ListContactFlowsRequest request)
Provides information about the contact flows for the specified Amazon Connect instance.
|
ListHoursOfOperationsResult |
listHoursOfOperations(ListHoursOfOperationsRequest request)
Provides information about the hours of operation for the specified Amazon Connect instance.
|
ListInstanceAttributesResult |
listInstanceAttributes(ListInstanceAttributesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListInstancesResult |
listInstances(ListInstancesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListInstanceStorageConfigsResult |
listInstanceStorageConfigs(ListInstanceStorageConfigsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListIntegrationAssociationsResult |
listIntegrationAssociations(ListIntegrationAssociationsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListLambdaFunctionsResult |
listLambdaFunctions(ListLambdaFunctionsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListLexBotsResult |
listLexBots(ListLexBotsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListPhoneNumbersResult |
listPhoneNumbers(ListPhoneNumbersRequest request)
Provides information about the phone numbers for the specified Amazon Connect instance.
|
ListPromptsResult |
listPrompts(ListPromptsRequest request)
Provides information about the prompts for the specified Amazon Connect instance.
|
ListQueuesResult |
listQueues(ListQueuesRequest request)
Provides information about the queues for the specified Amazon Connect instance.
|
ListQuickConnectsResult |
listQuickConnects(ListQuickConnectsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListRoutingProfileQueuesResult |
listRoutingProfileQueues(ListRoutingProfileQueuesRequest request)
List the queues associated with a routing profile.
|
ListRoutingProfilesResult |
listRoutingProfiles(ListRoutingProfilesRequest request)
Provides summary information about the routing profiles for the specified Amazon Connect instance.
|
ListSecurityKeysResult |
listSecurityKeys(ListSecurityKeysRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListSecurityProfilesResult |
listSecurityProfiles(ListSecurityProfilesRequest request)
Provides summary information about the security profiles for the specified Amazon Connect instance.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for the specified resource.
|
ListUseCasesResult |
listUseCases(ListUseCasesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListUserHierarchyGroupsResult |
listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Provides summary information about the users for the specified Amazon Connect instance.
|
ResumeContactRecordingResult |
resumeContactRecording(ResumeContactRecordingRequest request)
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 request)
Initiates a contact flow to start a new chat for the customer.
|
StartContactRecordingResult |
startContactRecording(StartContactRecordingRequest request)
This API starts recording the contact when the agent joins the call.
|
StartOutboundVoiceContactResult |
startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
This API places an outbound call to a contact, and then initiates the contact flow.
|
StartTaskContactResult |
startTaskContact(StartTaskContactRequest request)
Initiates a contact flow to start a new task.
|
StopContactResult |
stopContact(StopContactRequest request)
Ends the specified contact.
|
StopContactRecordingResult |
stopContactRecording(StopContactRecordingRequest request)
When a contact is being recorded, this API stops recording the call.
|
SuspendContactRecordingResult |
suspendContactRecording(SuspendContactRecordingRequest request)
When a contact is being recorded, this API suspends recording the call.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resource.
|
UpdateContactAttributesResult |
updateContactAttributes(UpdateContactAttributesRequest request)
Creates or updates the contact attributes associated with the specified contact.
|
UpdateContactFlowContentResult |
updateContactFlowContent(UpdateContactFlowContentRequest request)
Updates the specified contact flow.
|
UpdateContactFlowNameResult |
updateContactFlowName(UpdateContactFlowNameRequest request)
The name of the contact flow.
|
UpdateInstanceAttributeResult |
updateInstanceAttribute(UpdateInstanceAttributeRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateInstanceStorageConfigResult |
updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQuickConnectConfigResult |
updateQuickConnectConfig(UpdateQuickConnectConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQuickConnectNameResult |
updateQuickConnectName(UpdateQuickConnectNameRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateRoutingProfileConcurrencyResult |
updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest request)
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
|
UpdateRoutingProfileDefaultOutboundQueueResult |
updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest request)
Updates the default outbound queue of a routing profile.
|
UpdateRoutingProfileNameResult |
updateRoutingProfileName(UpdateRoutingProfileNameRequest request)
Updates the name and description of a routing profile.
|
UpdateRoutingProfileQueuesResult |
updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest request)
Updates the properties associated with a set of queues for a routing profile.
|
UpdateUserHierarchyResult |
updateUserHierarchy(UpdateUserHierarchyRequest request)
Assigns the specified hierarchy group to the specified user.
|
UpdateUserHierarchyGroupNameResult |
updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest request)
Updates the name of the user hierarchy group.
|
UpdateUserHierarchyStructureResult |
updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest request)
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
|
UpdateUserIdentityInfoResult |
updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
Updates the identity information for the specified user.
|
UpdateUserPhoneConfigResult |
updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
Updates the phone configuration settings for the specified user.
|
UpdateUserRoutingProfileResult |
updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
Assigns the specified routing profile to the specified user.
|
UpdateUserSecurityProfilesResult |
updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
Assigns the specified security profiles to the specified user.
|
public AssociateApprovedOriginResult associateApprovedOrigin(AssociateApprovedOriginRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
associateApprovedOrigin
in interface AmazonConnect
public AssociateInstanceStorageConfigResult associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest request)
AmazonConnect
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 Amazon S3 bucket, exists when being used for association.
associateInstanceStorageConfig
in interface AmazonConnect
public AssociateLambdaFunctionResult associateLambdaFunction(AssociateLambdaFunctionRequest request)
AmazonConnect
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.
associateLambdaFunction
in interface AmazonConnect
public AssociateLexBotResult associateLexBot(AssociateLexBotRequest request)
AmazonConnect
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.
associateLexBot
in interface AmazonConnect
public AssociateRoutingProfileQueuesResult associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest request)
AmazonConnect
Associates a set of queues with a routing profile.
associateRoutingProfileQueues
in interface AmazonConnect
public AssociateSecurityKeyResult associateSecurityKey(AssociateSecurityKeyRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKey
in interface AmazonConnect
public CreateContactFlowResult createContactFlow(CreateContactFlowRequest request)
AmazonConnect
Creates a contact flow for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
createContactFlow
in interface AmazonConnect
public CreateInstanceResult createInstance(CreateInstanceRequest request)
AmazonConnect
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 S3, or Kinesis) or allow for any configurations on features such as Contact Lens for Amazon Connect.
createInstance
in interface AmazonConnect
public CreateIntegrationAssociationResult createIntegrationAssociation(CreateIntegrationAssociationRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Create an AppIntegration association with an Amazon Connect instance.
createIntegrationAssociation
in interface AmazonConnect
public CreateQuickConnectResult createQuickConnect(CreateQuickConnectRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Creates a quick connect for the specified Amazon Connect instance.
createQuickConnect
in interface AmazonConnect
public CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest request)
AmazonConnect
Creates a new routing profile.
createRoutingProfile
in interface AmazonConnect
public CreateUseCaseResult createUseCase(CreateUseCaseRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Creates a use case for an AppIntegration association.
createUseCase
in interface AmazonConnect
public CreateUserResult createUser(CreateUserRequest request)
AmazonConnect
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.
createUser
in interface AmazonConnect
public CreateUserHierarchyGroupResult createUserHierarchyGroup(CreateUserHierarchyGroupRequest request)
AmazonConnect
Creates a new user hierarchy group.
createUserHierarchyGroup
in interface AmazonConnect
public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
deleteInstance
in interface AmazonConnect
public DeleteIntegrationAssociationResult deleteIntegrationAssociation(DeleteIntegrationAssociationRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Deletes an AppIntegration association from an Amazon Connect instance. The association must not have any use cases associated with it.
deleteIntegrationAssociation
in interface AmazonConnect
public DeleteQuickConnectResult deleteQuickConnect(DeleteQuickConnectRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Deletes a quick connect.
deleteQuickConnect
in interface AmazonConnect
public DeleteUseCaseResult deleteUseCase(DeleteUseCaseRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Deletes a use case from an AppIntegration association.
deleteUseCase
in interface AmazonConnect
public DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonConnect
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.
deleteUser
in interface AmazonConnect
public DeleteUserHierarchyGroupResult deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest request)
AmazonConnect
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroup
in interface AmazonConnect
public DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest request)
AmazonConnect
Describes the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
describeContactFlow
in interface AmazonConnect
public DescribeInstanceResult describeInstance(DescribeInstanceRequest request)
AmazonConnect
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.
describeInstance
in interface AmazonConnect
public DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttribute
in interface AmazonConnect
public DescribeInstanceStorageConfigResult describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest request)
AmazonConnect
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.
describeInstanceStorageConfig
in interface AmazonConnect
public DescribeQuickConnectResult describeQuickConnect(DescribeQuickConnectRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Describes the quick connect.
describeQuickConnect
in interface AmazonConnect
public DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest request)
AmazonConnect
Describes the specified routing profile.
describeRoutingProfile
in interface AmazonConnect
public DescribeUserResult describeUser(DescribeUserRequest request)
AmazonConnect
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.
describeUser
in interface AmazonConnect
public DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
AmazonConnect
Describes the specified hierarchy group.
describeUserHierarchyGroup
in interface AmazonConnect
public DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
AmazonConnect
Describes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructure
in interface AmazonConnect
public DisassociateApprovedOriginResult disassociateApprovedOrigin(DisassociateApprovedOriginRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOrigin
in interface AmazonConnect
public DisassociateInstanceStorageConfigResult disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest request)
AmazonConnect
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.
disassociateInstanceStorageConfig
in interface AmazonConnect
public DisassociateLambdaFunctionResult disassociateLambdaFunction(DisassociateLambdaFunctionRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the drop-down options available in the relevant contact flow blocks.
disassociateLambdaFunction
in interface AmazonConnect
public DisassociateLexBotResult disassociateLexBot(DisassociateLexBotRequest request)
AmazonConnect
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.
disassociateLexBot
in interface AmazonConnect
public DisassociateRoutingProfileQueuesResult disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest request)
AmazonConnect
Disassociates a set of queues from a routing profile.
disassociateRoutingProfileQueues
in interface AmazonConnect
public DisassociateSecurityKeyResult disassociateSecurityKey(DisassociateSecurityKeyRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKey
in interface AmazonConnect
public GetContactAttributesResult getContactAttributes(GetContactAttributesRequest request)
AmazonConnect
Retrieves the contact attributes for the specified contact.
getContactAttributes
in interface AmazonConnect
public GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest request)
AmazonConnect
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.
getCurrentMetricData
in interface AmazonConnect
public GetFederationTokenResult getFederationToken(GetFederationTokenRequest request)
AmazonConnect
Retrieves a token for federation.
getFederationToken
in interface AmazonConnect
public GetMetricDataResult getMetricData(GetMetricDataRequest request)
AmazonConnect
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.
getMetricData
in interface AmazonConnect
public ListApprovedOriginsResult listApprovedOrigins(ListApprovedOriginsRequest request)
AmazonConnect
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.
listApprovedOrigins
in interface AmazonConnect
public ListContactFlowsResult listContactFlows(ListContactFlowsRequest request)
AmazonConnect
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.
listContactFlows
in interface AmazonConnect
public ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest request)
AmazonConnect
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.
listHoursOfOperations
in interface AmazonConnect
public ListInstanceAttributesResult listInstanceAttributes(ListInstanceAttributesRequest request)
AmazonConnect
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.
listInstanceAttributes
in interface AmazonConnect
public ListInstanceStorageConfigsResult listInstanceStorageConfigs(ListInstanceStorageConfigsRequest request)
AmazonConnect
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.
listInstanceStorageConfigs
in interface AmazonConnect
public ListInstancesResult listInstances(ListInstancesRequest request)
AmazonConnect
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.
listInstances
in interface AmazonConnect
public ListIntegrationAssociationsResult listIntegrationAssociations(ListIntegrationAssociationsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Provides summary information about the AppIntegration associations for the specified Amazon Connect instance.
listIntegrationAssociations
in interface AmazonConnect
public ListLambdaFunctionsResult listLambdaFunctions(ListLambdaFunctionsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Lambda functions that show up in the drop-down options in the relevant contact flow blocks.
listLambdaFunctions
in interface AmazonConnect
public ListLexBotsResult listLexBots(ListLexBotsRequest request)
AmazonConnect
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.
listLexBots
in interface AmazonConnect
public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
AmazonConnect
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.
listPhoneNumbers
in interface AmazonConnect
public ListPromptsResult listPrompts(ListPromptsRequest request)
AmazonConnect
Provides information about the prompts for the specified Amazon Connect instance.
listPrompts
in interface AmazonConnect
public ListQueuesResult listQueues(ListQueuesRequest request)
AmazonConnect
Provides information about the queues for the specified Amazon Connect instance.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
listQueues
in interface AmazonConnect
public ListQuickConnectsResult listQuickConnects(ListQuickConnectsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Provides information about the quick connects for the specified Amazon Connect instance.
listQuickConnects
in interface AmazonConnect
public ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest request)
AmazonConnect
List the queues associated with a routing profile.
listRoutingProfileQueues
in interface AmazonConnect
public ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest request)
AmazonConnect
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.
listRoutingProfiles
in interface AmazonConnect
public ListSecurityKeysResult listSecurityKeys(ListSecurityKeysRequest request)
AmazonConnect
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.
listSecurityKeys
in interface AmazonConnect
public ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest request)
AmazonConnect
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.
listSecurityProfiles
in interface AmazonConnect
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonConnect
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.
listTagsForResource
in interface AmazonConnect
public ListUseCasesResult listUseCases(ListUseCasesRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
List the use cases.
listUseCases
in interface AmazonConnect
request
- Provides summary information about the use cases for the specified Amazon Connect AppIntegration
association.public ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
AmazonConnect
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.
listUserHierarchyGroups
in interface AmazonConnect
public ListUsersResult listUsers(ListUsersRequest request)
AmazonConnect
Provides summary information about the users for the specified Amazon Connect instance.
listUsers
in interface AmazonConnect
public ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest request)
AmazonConnect
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.
resumeContactRecording
in interface AmazonConnect
public StartChatContactResult startChatContact(StartChatContactRequest request)
AmazonConnect
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 need to 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 from the API
Gateway.
The quota for
concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException
.
For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.
startChatContact
in interface AmazonConnect
public StartContactRecordingResult startContactRecording(StartContactRecordingRequest request)
AmazonConnect
This API starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
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.
startContactRecording
in interface AmazonConnect
public StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
AmazonConnect
This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in
the contact flow that's specified (in ContactFlowId
).
Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is 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.
startOutboundVoiceContact
in interface AmazonConnect
public StartTaskContactResult startTaskContact(StartTaskContactRequest request)
AmazonConnect
Initiates a contact flow to start a new task.
startTaskContact
in interface AmazonConnect
public StopContactResult stopContact(StopContactRequest request)
AmazonConnect
Ends the specified contact.
stopContact
in interface AmazonConnect
public StopContactRecordingResult stopContactRecording(StopContactRecordingRequest request)
AmazonConnect
When a contact is being recorded, this API stops recording the call. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
stopContactRecording
in interface AmazonConnect
public SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest request)
AmazonConnect
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.
suspendContactRecording
in interface AmazonConnect
public TagResourceResult tagResource(TagResourceRequest request)
AmazonConnect
Adds the specified tags to the specified resource.
The supported resource types are users, routing profiles, quick connects, and contact flows.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
tagResource
in interface AmazonConnect
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonConnect
Removes the specified tags from the specified resource.
untagResource
in interface AmazonConnect
public UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest request)
AmazonConnect
Creates or updates the contact attributes associated with the specified contact.
You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed 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 identifying abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted.
Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, 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.
updateContactAttributes
in interface AmazonConnect
public UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest request)
AmazonConnect
Updates the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
updateContactFlowContent
in interface AmazonConnect
public UpdateContactFlowNameResult updateContactFlowName(UpdateContactFlowNameRequest request)
AmazonConnect
The name of the contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
updateContactFlowName
in interface AmazonConnect
public UpdateInstanceAttributeResult updateInstanceAttribute(UpdateInstanceAttributeRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttribute
in interface AmazonConnect
public UpdateInstanceStorageConfigResult updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest request)
AmazonConnect
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.
updateInstanceStorageConfig
in interface AmazonConnect
public UpdateQuickConnectConfigResult updateQuickConnectConfig(UpdateQuickConnectConfigRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Updates the configuration settings for the specified quick connect.
updateQuickConnectConfig
in interface AmazonConnect
public UpdateQuickConnectNameResult updateQuickConnectName(UpdateQuickConnectNameRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
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.
updateQuickConnectName
in interface AmazonConnect
public UpdateRoutingProfileConcurrencyResult updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest request)
AmazonConnect
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrency
in interface AmazonConnect
public UpdateRoutingProfileDefaultOutboundQueueResult updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest request)
AmazonConnect
Updates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueue
in interface AmazonConnect
public UpdateRoutingProfileNameResult updateRoutingProfileName(UpdateRoutingProfileNameRequest request)
AmazonConnect
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.
updateRoutingProfileName
in interface AmazonConnect
public UpdateRoutingProfileQueuesResult updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest request)
AmazonConnect
Updates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueues
in interface AmazonConnect
public UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest request)
AmazonConnect
Assigns the specified hierarchy group to the specified user.
updateUserHierarchy
in interface AmazonConnect
public UpdateUserHierarchyGroupNameResult updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest request)
AmazonConnect
Updates the name of the user hierarchy group.
updateUserHierarchyGroupName
in interface AmazonConnect
public UpdateUserHierarchyStructureResult updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest request)
AmazonConnect
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructure
in interface AmazonConnect
public UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
AmazonConnect
Updates the identity information for the specified user.
Someone with the ability to invoke UpdateUserIndentityInfo
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. We strongly
recommend limiting who has the ability to invoke UpdateUserIndentityInfo
. For more information, see
Best
Practices for Security Profiles in the Amazon Connect Administrator Guide.
updateUserIdentityInfo
in interface AmazonConnect
public UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
AmazonConnect
Updates the phone configuration settings for the specified user.
updateUserPhoneConfig
in interface AmazonConnect
public UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
AmazonConnect
Assigns the specified routing profile to the specified user.
updateUserRoutingProfile
in interface AmazonConnect
public UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
AmazonConnect
Assigns the specified security profiles to the specified user.
updateUserSecurityProfiles
in interface AmazonConnect
public void shutdown()
AmazonConnect
shutdown
in interface AmazonConnect
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonConnect
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.
getCachedResponseMetadata
in interface AmazonConnect
request
- The originally executed request.