@Generated(value="software.amazon.awssdk:codegen") public interface ConnectClient extends SdkClient
builder() method.
The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Throttling limits for the Amazon Connect API operations:
For the GetMetricData and GetCurrentMetricData operations, a RateLimit of 5 per second, and
a BurstLimit of 8 per second.
For all other operations, a RateLimit of 2 per second, and a BurstLimit of 5 per second.
You can request an increase to the throttling limits by submitting a Amazon Connect service limits increase form. You must be signed in to your AWS account to access the form.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static ConnectClientBuilder |
builder()
Create a builder that can be used to configure and create a
ConnectClient. |
static ConnectClient |
create()
Create a
ConnectClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateUserResponse |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a new user account in your Amazon Connect instance.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest)
Creates a new user account in your Amazon Connect instance.
|
default DeleteUserResponse |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a user account from Amazon Connect.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user account from Amazon Connect.
|
default DescribeUserResponse |
describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Returns a
User object that contains information about the user account specified by the
UserId. |
default DescribeUserResponse |
describeUser(DescribeUserRequest describeUserRequest)
Returns a
User object that contains information about the user account specified by the
UserId. |
default DescribeUserHierarchyGroupResponse |
describeUserHierarchyGroup(Consumer<DescribeUserHierarchyGroupRequest.Builder> describeUserHierarchyGroupRequest)
Returns a
HierarchyGroup object that includes information about a hierarchy group in your instance. |
default DescribeUserHierarchyGroupResponse |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Returns a
HierarchyGroup object that includes information about a hierarchy group in your instance. |
default DescribeUserHierarchyStructureResponse |
describeUserHierarchyStructure(Consumer<DescribeUserHierarchyStructureRequest.Builder> describeUserHierarchyStructureRequest)
Returns a
HiearchyGroupStructure object, which contains data about the levels in the agent
hierarchy. |
default DescribeUserHierarchyStructureResponse |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Returns a
HiearchyGroupStructure object, which contains data about the levels in the agent
hierarchy. |
default GetContactAttributesResponse |
getContactAttributes(Consumer<GetContactAttributesRequest.Builder> getContactAttributesRequest)
Retrieves the contact attributes associated with a contact.
|
default GetContactAttributesResponse |
getContactAttributes(GetContactAttributesRequest getContactAttributesRequest)
Retrieves the contact attributes associated with a contact.
|
default GetCurrentMetricDataResponse |
getCurrentMetricData(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest)
The
GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. |
default GetCurrentMetricDataResponse |
getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
The
GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. |
default GetCurrentMetricDataIterable |
getCurrentMetricDataPaginator(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest)
The
GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. |
default GetCurrentMetricDataIterable |
getCurrentMetricDataPaginator(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
The
GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. |
default GetFederationTokenResponse |
getFederationToken(Consumer<GetFederationTokenRequest.Builder> getFederationTokenRequest)
Retrieves a token for federation.
|
default GetFederationTokenResponse |
getFederationToken(GetFederationTokenRequest getFederationTokenRequest)
Retrieves a token for federation.
|
default GetMetricDataResponse |
getMetricData(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)
The
GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. |
default GetMetricDataResponse |
getMetricData(GetMetricDataRequest getMetricDataRequest)
The
GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. |
default GetMetricDataIterable |
getMetricDataPaginator(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)
The
GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. |
default GetMetricDataIterable |
getMetricDataPaginator(GetMetricDataRequest getMetricDataRequest)
The
GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. |
default ListRoutingProfilesResponse |
listRoutingProfiles(Consumer<ListRoutingProfilesRequest.Builder> listRoutingProfilesRequest)
Returns an array of
RoutingProfileSummary objects that includes information about the routing
profiles in your instance. |
default ListRoutingProfilesResponse |
listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)
Returns an array of
RoutingProfileSummary objects that includes information about the routing
profiles in your instance. |
default ListSecurityProfilesResponse |
listSecurityProfiles(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest)
Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your
instance, including the ARN, Id, and Name of the security profile.
|
default ListSecurityProfilesResponse |
listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest)
Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your
instance, including the ARN, Id, and Name of the security profile.
|
default ListUserHierarchyGroupsResponse |
listUserHierarchyGroups(Consumer<ListUserHierarchyGroupsRequest.Builder> listUserHierarchyGroupsRequest)
Returns a
UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance. |
default ListUserHierarchyGroupsResponse |
listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
Returns a
UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance. |
default ListUsersResponse |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns a
UserSummaryList, which is an array of UserSummary objects. |
default ListUsersResponse |
listUsers(ListUsersRequest listUsersRequest)
Returns a
UserSummaryList, which is an array of UserSummary objects. |
static ServiceMetadata |
serviceMetadata() |
default StartOutboundVoiceContactResponse |
startOutboundVoiceContact(Consumer<StartOutboundVoiceContactRequest.Builder> startOutboundVoiceContactRequest)
The
StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a
customer. |
default StartOutboundVoiceContactResponse |
startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)
The
StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a
customer. |
default StopContactResponse |
stopContact(Consumer<StopContactRequest.Builder> stopContactRequest)
Ends the contact initiated by the
StartOutboundVoiceContact operation. |
default StopContactResponse |
stopContact(StopContactRequest stopContactRequest)
Ends the contact initiated by the
StartOutboundVoiceContact operation. |
default UpdateContactAttributesResponse |
updateContactAttributes(Consumer<UpdateContactAttributesRequest.Builder> updateContactAttributesRequest)
The
UpdateContactAttributes operation lets you programmatically create new, or update existing,
contact attributes associated with a contact. |
default UpdateContactAttributesResponse |
updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest)
The
UpdateContactAttributes operation lets you programmatically create new, or update existing,
contact attributes associated with a contact. |
default UpdateUserHierarchyResponse |
updateUserHierarchy(Consumer<UpdateUserHierarchyRequest.Builder> updateUserHierarchyRequest)
Assigns the specified hierarchy group to the user.
|
default UpdateUserHierarchyResponse |
updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the user.
|
default UpdateUserIdentityInfoResponse |
updateUserIdentityInfo(Consumer<UpdateUserIdentityInfoRequest.Builder> updateUserIdentityInfoRequest)
Updates the identity information for the specified user in a
UserIdentityInfo object, including
email, first name, and last name. |
default UpdateUserIdentityInfoResponse |
updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user in a
UserIdentityInfo object, including
email, first name, and last name. |
default UpdateUserPhoneConfigResponse |
updateUserPhoneConfig(Consumer<UpdateUserPhoneConfigRequest.Builder> updateUserPhoneConfigRequest)
Updates the phone configuration settings in the
UserPhoneConfig object for the specified user. |
default UpdateUserPhoneConfigResponse |
updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings in the
UserPhoneConfig object for the specified user. |
default UpdateUserRoutingProfileResponse |
updateUserRoutingProfile(Consumer<UpdateUserRoutingProfileRequest.Builder> updateUserRoutingProfileRequest)
Assigns the specified routing profile to a user.
|
default UpdateUserRoutingProfileResponse |
updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to a user.
|
default UpdateUserSecurityProfilesResponse |
updateUserSecurityProfiles(Consumer<UpdateUserSecurityProfilesRequest.Builder> updateUserSecurityProfilesRequest)
Updates the security profiles assigned to the user.
|
default UpdateUserSecurityProfilesResponse |
updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Updates the security profiles assigned to the user.
|
serviceNameclosestatic final String SERVICE_NAME
static ConnectClient create()
ConnectClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ConnectClientBuilder builder()
ConnectClient.default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws InvalidRequestException, InvalidParameterException, LimitExceededException, DuplicateResourceException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Creates a new user account in your Amazon Connect instance.
createUserRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.LimitExceededException - The allowed limit for the resource has been reached.DuplicateResourceException - A resource with that name already exists.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws InvalidRequestException, InvalidParameterException, LimitExceededException, DuplicateResourceException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Creates a new user account in your Amazon Connect instance.
This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.LimitExceededException - The allowed limit for the resource has been reached.DuplicateResourceException - A resource with that name already exists.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Deletes a user account from Amazon Connect.
deleteUserRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Deletes a user account from Amazon Connect.
This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns a User object that contains information about the user account specified by the
UserId.
describeUserRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns a User object that contains information about the user account specified by the
UserId.
This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to
create one manually via DescribeUserRequest.builder()
describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserHierarchyGroupResponse describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.
describeUserHierarchyGroupRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserHierarchyGroupResponse describeUserHierarchyGroup(Consumer<DescribeUserHierarchyGroupRequest.Builder> describeUserHierarchyGroupRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.
This is a convenience which creates an instance of the DescribeUserHierarchyGroupRequest.Builder avoiding
the need to create one manually via DescribeUserHierarchyGroupRequest.builder()
describeUserHierarchyGroupRequest - A Consumer that will call methods on DescribeUserHierarchyGroupRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserHierarchyStructureResponse describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns a HiearchyGroupStructure object, which contains data about the levels in the agent
hierarchy.
describeUserHierarchyStructureRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserHierarchyStructureResponse describeUserHierarchyStructure(Consumer<DescribeUserHierarchyStructureRequest.Builder> describeUserHierarchyStructureRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns a HiearchyGroupStructure object, which contains data about the levels in the agent
hierarchy.
This is a convenience which creates an instance of the DescribeUserHierarchyStructureRequest.Builder
avoiding the need to create one manually via DescribeUserHierarchyStructureRequest.builder()
describeUserHierarchyStructureRequest - A Consumer that will call methods on DescribeUserHierarchyStructureRequest.Builder to
create a request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContactAttributesResponse getContactAttributes(GetContactAttributesRequest getContactAttributesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Retrieves the contact attributes associated with a contact.
getContactAttributesRequest - InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContactAttributesResponse getContactAttributes(Consumer<GetContactAttributesRequest.Builder> getContactAttributesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Retrieves the contact attributes associated with a contact.
This is a convenience which creates an instance of the GetContactAttributesRequest.Builder avoiding the
need to create one manually via GetContactAttributesRequest.builder()
getContactAttributesRequest - A Consumer that will call methods on GetContactAttributesRequest.Builder to create a
request.InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCurrentMetricDataResponse getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException
The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.
getCurrentMetricDataRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.InternalServiceException - Request processing failed due to an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCurrentMetricDataResponse getCurrentMetricData(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException
The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.
This is a convenience which creates an instance of the GetCurrentMetricDataRequest.Builder avoiding the
need to create one manually via GetCurrentMetricDataRequest.builder()
getCurrentMetricDataRequest - A Consumer that will call methods on GetCurrentMetricDataRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.InternalServiceException - Request processing failed due to an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCurrentMetricDataIterable getCurrentMetricDataPaginator(GetCurrentMetricDataRequest getCurrentMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException
The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.
This is a variant of
getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client.getCurrentMetricDataPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client
.getCurrentMetricDataPaginator(request);
for (software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client.getCurrentMetricDataPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest)
operation.
getCurrentMetricDataRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.InternalServiceException - Request processing failed due to an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCurrentMetricDataIterable getCurrentMetricDataPaginator(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException
The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.
This is a variant of
getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client.getCurrentMetricDataPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client
.getCurrentMetricDataPaginator(request);
for (software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client.getCurrentMetricDataPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest)
operation.
This is a convenience which creates an instance of the GetCurrentMetricDataRequest.Builder avoiding the
need to create one manually via GetCurrentMetricDataRequest.builder()
getCurrentMetricDataRequest - A Consumer that will call methods on GetCurrentMetricDataRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.InternalServiceException - Request processing failed due to an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetFederationTokenResponse getFederationToken(GetFederationTokenRequest getFederationTokenRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, UserNotFoundException, InternalServiceException, DuplicateResourceException, AwsServiceException, SdkClientException, ConnectException
Retrieves a token for federation.
getFederationTokenRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation 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 due to an error or failure with the service.DuplicateResourceException - A resource with that name already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetFederationTokenResponse getFederationToken(Consumer<GetFederationTokenRequest.Builder> getFederationTokenRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, UserNotFoundException, InternalServiceException, DuplicateResourceException, AwsServiceException, SdkClientException, ConnectException
Retrieves a token for federation.
This is a convenience which creates an instance of the GetFederationTokenRequest.Builder avoiding the
need to create one manually via GetFederationTokenRequest.builder()
getFederationTokenRequest - A Consumer that will call methods on GetFederationTokenRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation 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 due to an error or failure with the service.DuplicateResourceException - A resource with that name already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMetricDataResponse getMetricData(GetMetricDataRequest getMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException
The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetMetricData action.
getMetricDataRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.InternalServiceException - Request processing failed due to an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMetricDataResponse getMetricData(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException
The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetMetricData action.
This is a convenience which creates an instance of the GetMetricDataRequest.Builder avoiding the need to
create one manually via GetMetricDataRequest.builder()
getMetricDataRequest - A Consumer that will call methods on GetMetricDataRequest.Builder to create a request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.InternalServiceException - Request processing failed due to an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMetricDataIterable getMetricDataPaginator(GetMetricDataRequest getMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException
The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetMetricData action.
This is a variant of getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
for (software.amazon.awssdk.services.connect.model.GetMetricDataResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest) operation.
getMetricDataRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.InternalServiceException - Request processing failed due to an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMetricDataIterable getMetricDataPaginator(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException
The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetMetricData action.
This is a variant of getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
for (software.amazon.awssdk.services.connect.model.GetMetricDataResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest) operation.
This is a convenience which creates an instance of the GetMetricDataRequest.Builder avoiding the need to
create one manually via GetMetricDataRequest.builder()
getMetricDataRequest - A Consumer that will call methods on GetMetricDataRequest.Builder to create a request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.InternalServiceException - Request processing failed due to an error or failure with the service.ThrottlingException - The throttling limit has been exceeded.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoutingProfilesResponse listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns an array of RoutingProfileSummary objects that includes information about the routing
profiles in your instance.
listRoutingProfilesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoutingProfilesResponse listRoutingProfiles(Consumer<ListRoutingProfilesRequest.Builder> listRoutingProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns an array of RoutingProfileSummary objects that includes information about the routing
profiles in your instance.
This is a convenience which creates an instance of the ListRoutingProfilesRequest.Builder avoiding the
need to create one manually via ListRoutingProfilesRequest.builder()
listRoutingProfilesRequest - A Consumer that will call methods on ListRoutingProfilesRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSecurityProfilesResponse listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.
listSecurityProfilesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSecurityProfilesResponse listSecurityProfiles(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.
This is a convenience which creates an instance of the ListSecurityProfilesRequest.Builder avoiding the
need to create one manually via ListSecurityProfilesRequest.builder()
listSecurityProfilesRequest - A Consumer that will call methods on ListSecurityProfilesRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUserHierarchyGroupsResponse listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance.
listUserHierarchyGroupsRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUserHierarchyGroupsResponse listUserHierarchyGroups(Consumer<ListUserHierarchyGroupsRequest.Builder> listUserHierarchyGroupsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance.
This is a convenience which creates an instance of the ListUserHierarchyGroupsRequest.Builder avoiding
the need to create one manually via ListUserHierarchyGroupsRequest.builder()
listUserHierarchyGroupsRequest - A Consumer that will call methods on ListUserHierarchyGroupsRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns a UserSummaryList, which is an array of UserSummary objects.
listUsersRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Returns a UserSummaryList, which is an array of UserSummary objects.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartOutboundVoiceContactResponse startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, LimitExceededException, DestinationNotAllowedException, OutboundContactNotPermittedException, AwsServiceException, SdkClientException, ConnectException
The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a
customer.
If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact
action.
There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails.
startOutboundVoiceContactRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed due to an error or failure with the service.LimitExceededException - The allowed limit for the resource has been reached.DestinationNotAllowedException - Outbound calls to the destination number are not allowed.OutboundContactNotPermittedException - The contact is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartOutboundVoiceContactResponse startOutboundVoiceContact(Consumer<StartOutboundVoiceContactRequest.Builder> startOutboundVoiceContactRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, LimitExceededException, DestinationNotAllowedException, OutboundContactNotPermittedException, AwsServiceException, SdkClientException, ConnectException
The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a
customer.
If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact
action.
There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails.
This is a convenience which creates an instance of the StartOutboundVoiceContactRequest.Builder avoiding
the need to create one manually via StartOutboundVoiceContactRequest.builder()
startOutboundVoiceContactRequest - A Consumer that will call methods on StartOutboundVoiceContactRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed due to an error or failure with the service.LimitExceededException - The allowed limit for the resource has been reached.DestinationNotAllowedException - Outbound calls to the destination number are not allowed.OutboundContactNotPermittedException - The contact is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopContactResponse stopContact(StopContactRequest stopContactRequest) throws InvalidRequestException, ContactNotFoundException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Ends the contact initiated by the StartOutboundVoiceContact operation.
If you are using an IAM account, it must have permission to the connect:StopContact action.
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 parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopContactResponse stopContact(Consumer<StopContactRequest.Builder> stopContactRequest) throws InvalidRequestException, ContactNotFoundException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Ends the contact initiated by the StartOutboundVoiceContact operation.
If you are using an IAM account, it must have permission to the connect:StopContact action.
This is a convenience which creates an instance of the StopContactRequest.Builder avoiding the need to
create one manually via StopContactRequest.builder()
stopContactRequest - A Consumer that will call methods on StopContactRequest.Builder to create a request.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 parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateContactAttributesResponse updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
The UpdateContactAttributes operation lets you programmatically create new, or update existing,
contact attributes associated with a contact. You can use the operation to 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 use the UpdateContactAttributes operation to 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.
updateContactAttributesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateContactAttributesResponse updateContactAttributes(Consumer<UpdateContactAttributesRequest.Builder> updateContactAttributesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
The UpdateContactAttributes operation lets you programmatically create new, or update existing,
contact attributes associated with a contact. You can use the operation to 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 use the UpdateContactAttributes operation to 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.
This is a convenience which creates an instance of the UpdateContactAttributesRequest.Builder avoiding
the need to create one manually via UpdateContactAttributesRequest.builder()
updateContactAttributesRequest - A Consumer that will call methods on UpdateContactAttributesRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserHierarchyResponse updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Assigns the specified hierarchy group to the user.
updateUserHierarchyRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserHierarchyResponse updateUserHierarchy(Consumer<UpdateUserHierarchyRequest.Builder> updateUserHierarchyRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Assigns the specified hierarchy group to the user.
This is a convenience which creates an instance of the UpdateUserHierarchyRequest.Builder avoiding the
need to create one manually via UpdateUserHierarchyRequest.builder()
updateUserHierarchyRequest - A Consumer that will call methods on UpdateUserHierarchyRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserIdentityInfoResponse updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Updates the identity information for the specified user in a UserIdentityInfo object, including
email, first name, and last name.
updateUserIdentityInfoRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserIdentityInfoResponse updateUserIdentityInfo(Consumer<UpdateUserIdentityInfoRequest.Builder> updateUserIdentityInfoRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Updates the identity information for the specified user in a UserIdentityInfo object, including
email, first name, and last name.
This is a convenience which creates an instance of the UpdateUserIdentityInfoRequest.Builder avoiding the
need to create one manually via UpdateUserIdentityInfoRequest.builder()
updateUserIdentityInfoRequest - A Consumer that will call methods on UpdateUserIdentityInfoRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserPhoneConfigResponse updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Updates the phone configuration settings in the UserPhoneConfig object for the specified user.
updateUserPhoneConfigRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserPhoneConfigResponse updateUserPhoneConfig(Consumer<UpdateUserPhoneConfigRequest.Builder> updateUserPhoneConfigRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Updates the phone configuration settings in the UserPhoneConfig object for the specified user.
This is a convenience which creates an instance of the UpdateUserPhoneConfigRequest.Builder avoiding the
need to create one manually via UpdateUserPhoneConfigRequest.builder()
updateUserPhoneConfigRequest - A Consumer that will call methods on UpdateUserPhoneConfigRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserRoutingProfileResponse updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Assigns the specified routing profile to a user.
updateUserRoutingProfileRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserRoutingProfileResponse updateUserRoutingProfile(Consumer<UpdateUserRoutingProfileRequest.Builder> updateUserRoutingProfileRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Assigns the specified routing profile to a user.
This is a convenience which creates an instance of the UpdateUserRoutingProfileRequest.Builder avoiding
the need to create one manually via UpdateUserRoutingProfileRequest.builder()
updateUserRoutingProfileRequest - A Consumer that will call methods on UpdateUserRoutingProfileRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserSecurityProfilesResponse updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Updates the security profiles assigned to the user.
updateUserSecurityProfilesRequest - InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserSecurityProfilesResponse updateUserSecurityProfiles(Consumer<UpdateUserSecurityProfilesRequest.Builder> updateUserSecurityProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException
Updates the security profiles assigned to the user.
This is a convenience which creates an instance of the UpdateUserSecurityProfilesRequest.Builder avoiding
the need to create one manually via UpdateUserSecurityProfilesRequest.builder()
updateUserSecurityProfilesRequest - A Consumer that will call methods on UpdateUserSecurityProfilesRequest.Builder to create a
request.InvalidRequestException - The request is not valid.InvalidParameterException - One or more of the parameters provided to the operation are not valid.ResourceNotFoundException - The specified resource was not found.ThrottlingException - The throttling limit has been exceeded.InternalServiceException - Request processing failed due to an error or failure with the service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2019. All rights reserved.