Serialized Form (AWS Java SDK for Amazon Connect 1.11.420 API)

Package com.amazonaws.services.connect.model
- Class com.amazonaws.services.connect.model.AmazonConnectException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.ContactNotFoundException extends AmazonConnectException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - username
```
String username
```
      The user name in Amazon Connect for the account to create.
    - password
```
String password
```
      The password for the user account to create. This is required if you are using Amazon Connect for identity management. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.
    - identityInfo
```
UserIdentityInfo identityInfo
```
      Information about the user, including email address, first name, and last name.
    - phoneConfig
```
UserPhoneConfig phoneConfig
```
      Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.
    - directoryUserId
```
String directoryUserId
```
      The unique identifier for the user account in the directory service directory used for identity management. If Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId to authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory. If the parameter is not included, the UserIdentityInfo is used to authenticate users from your existing directory.
      
      This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.
    - securityProfileIds
```
List<E> securityProfileIds
```
      The unique identifier of the security profile to assign to the user created.
    - routingProfileId
```
String routingProfileId
```
      The unique identifier for the routing profile to assign to the user created.
    - hierarchyGroupId
```
String hierarchyGroupId
```
      The unique identifier for the hierarchy group to assign to the user created.
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
- Class com.amazonaws.services.connect.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userId
```
String userId
```
      The unique identifier for the user account in Amazon Connect
    - userArn
```
String userArn
```
      The Amazon Resource Name (ARN) of the user account created.
- Class com.amazonaws.services.connect.model.Credentials extends Object implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      An access token generated for a federated user to access Amazon Connect
    - accessTokenExpiration
```
Date accessTokenExpiration
```
      A token generated with an expiration time for the session a user is logged in to Amazon Connect
    - refreshToken
```
String refreshToken
```
      Renews a token generated for a user to access the Amazon Connect instance.
    - refreshTokenExpiration
```
Date refreshTokenExpiration
```
      Renews the expiration timer for a generated token.
- Class com.amazonaws.services.connect.model.CurrentMetric extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the metric.
    - unit
```
String unit
```
      The unit for the metric.
- Class com.amazonaws.services.connect.model.CurrentMetricData extends Object implements Serializable
  - Serialized Fields
    - metric
```
CurrentMetric metric
```
      The metric in a CurrentMetricData object.
    - value
```
Double value
```
      The value of the metric in the CurrentMetricData object.
- Class com.amazonaws.services.connect.model.CurrentMetricResult extends Object implements Serializable
  - Serialized Fields
    - dimensions
```
Dimensions dimensions
```
      The Dimensions for the CurrentMetricResult object.
    - collections
```
List<E> collections
```
      The Collections for the CurrentMetricResult object.
- Class com.amazonaws.services.connect.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
    - userId
```
String userId
```
      The unique identifier of the user to delete.
- Class com.amazonaws.services.connect.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.connect.model.DescribeUserHierarchyGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - hierarchyGroupId
```
String hierarchyGroupId
```
      The identifier for the hierarchy group to return.
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
- Class com.amazonaws.services.connect.model.DescribeUserHierarchyGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - hierarchyGroup
```
HierarchyGroup hierarchyGroup
```
      Returns a HierarchyGroup object.
- Class com.amazonaws.services.connect.model.DescribeUserHierarchyStructureRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
- Class com.amazonaws.services.connect.model.DescribeUserHierarchyStructureResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - hierarchyStructure
```
HierarchyStructure hierarchyStructure
```
      A HierarchyStructure object.
- Class com.amazonaws.services.connect.model.DescribeUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userId
```
String userId
```
      Unique identifier for the user account to return.
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
- Class com.amazonaws.services.connect.model.DescribeUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - user
```
User user
```
      A User object that contains information about the user account and configuration settings.
- Class com.amazonaws.services.connect.model.DestinationNotAllowedException extends AmazonConnectException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.Dimensions extends Object implements Serializable
  - Serialized Fields
    - queue
```
QueueReference queue
```
      A QueueReference object used as one part of dimension for the metrics results.
    - channel
```
String channel
```
      The channel used for grouping and filters. Only VOICE is supported.
- Class com.amazonaws.services.connect.model.DuplicateResourceException extends AmazonConnectException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.Filters extends Object implements Serializable
  - Serialized Fields
    - queues
```
List<E> queues
```
      A list of up to 100 queue IDs or queue ARNs to use to filter the metrics retrieved. You can include both IDs and ARNs in a request.
    - channels
```
List<E> channels
```
      The Channel to use as a filter for the metrics returned. Only VOICE is supported.
- Class com.amazonaws.services.connect.model.GetCurrentMetricDataRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
    - filters
```
Filters filters
```
      A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE is supported for Channels.
      
      To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61 . The queue ID is also included in the URL, and is the string after 'queue/'.
    - groupings
```
List<E> groupings
```
      The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.
      
      If no Grouping is included in the request, a summary of CurrentMetrics is returned.
    - currentMetrics
```
List<E> currentMetrics
```
      A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it.
      
      The following metrics are available:
      
      AGENTS_AVAILABLE
      
      Unit: COUNT
      
      AGENTS_ONLINE
      
      Unit: COUNT
      
      AGENTS_ON_CALL
      
      Unit: COUNT
      
      AGENTS_STAFFED
      
      Unit: COUNT
      
      AGENTS_AFTER_CONTACT_WORK
      
      Unit: COUNT
      
      AGENTS_NON_PRODUCTIVE
      
      Unit: COUNT
      
      AGENTS_ERROR
      
      Unit: COUNT
      
      CONTACTS_IN_QUEUE
      
      Unit: COUNT
      
      OLDEST_CONTACT_AGE
      
      Unit: SECONDS
      
      CONTACTS_SCHEDULED
      
      Unit: COUNT
    - nextToken
```
String nextToken
```
      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
      
      The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
    - maxResults
```
Integer maxResults
```
      MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100.
- Class com.amazonaws.services.connect.model.GetCurrentMetricDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.
      
      The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
    - metricResults
```
List<E> metricResults
```
      A list of CurrentMetricResult objects organized by Dimensions combining with CurrentMetricDataCollections.
      
      Dimensions is the resourceId specified in the Filters of the request.
      
      Collections is a list of CurrentMetricData objects with corresponding values to the CurrentMetrics specified in the request.
      
      If no Grouping is specified in the request, Collections is a summary for the CurrentMetric returned.
    - dataSnapshotTime
```
Date dataSnapshotTime
```
      The time at which CurrentMetricData was retrieved and cached for pagination.
- Class com.amazonaws.services.connect.model.GetFederationTokenRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
- Class com.amazonaws.services.connect.model.GetFederationTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - credentials
```
Credentials credentials
```
      The credentials to use for federation.
- Class com.amazonaws.services.connect.model.GetMetricDataRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
    - startTime
```
Date startTime
```
      The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
      
      StartTime cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect only for 24 hours.
    - endTime
```
Date endTime
```
      The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the StartTime timestamp.
      
      The time range between StartTime and EndTime must be less than 24 hours.
    - filters
```
Filters filters
```
      A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or a list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the IDs, ARNs, or Channels included in the filter. You can use both IDs and ARNs together in a request. Only VOICE is supported for Channel.
      
      To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61 . The queue ID is also included in the URL, and is the string after 'queue/'.
    - groupings
```
List<E> groupings
```
      The grouping applied to the metrics returned. For example, when results are grouped by queueId, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
      
      The current version supports grouping by Queue
      
      If no Grouping is included in the request, a summary of HistoricalMetrics for all queues is returned.
    - historicalMetrics
```
List<E> historicalMetrics
```
      A list of HistoricalMetric objects that contain the metrics to retrieve with the request.
      
      A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold, and Unit.
      
      For each historical metric you include in the request, you must include a Unit and a Statistic.
      
      The following historical metrics are available:
      
      CONTACTS_QUEUED
      
      Unit: COUNT
      
      Statistic: SUM
      
      CONTACTS_HANDLED
      
      Unit: COUNT
      
      Statistics: SUM
      
      CONTACTS_ABANDONED
      
      Unit: COUNT
      
      Statistics: SUM
      
      CONTACTS_CONSULTED
      
      Unit: COUNT
      
      Statistics: SUM
      
      CONTACTS_AGENT_HUNG_UP_FIRST
      
      Unit: COUNT
      
      Statistics: SUM
      
      CONTACTS_HANDLED_INCOMING
      
      Unit: COUNT
      
      Statistics: SUM
      
      CONTACTS_HANDLED_OUTBOUND
      
      Unit: COUNT
      
      Statistics: SUM
      
      CONTACTS_HOLD_ABANDONS
      
      Unit: COUNT
      
      Statistics: SUM
      
      CONTACTS_TRANSFERRED_IN
      
      Unit: COUNT
      
      Statistics: SUM
      
      CONTACTS_TRANSFERRED_OUT
      
      Unit: COUNT
      
      Statistics: SUM
      
      CONTACTS_TRANSFERRED_IN_FROM_QUEUE
      
      Unit: COUNT
      
      Statistics: SUM
      
      CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
      
      Unit: COUNT
      
      Statistics: SUM
      
      CALLBACK_CONTACTS_HANDLED
      
      Unit: COUNT
      
      Statistics: SUM
      
      CALLBACK_CONTACTS_HANDLED
      
      Unit: COUNT
      
      Statistics: SUM
      
      API_CONTACTS_HANDLED
      
      Unit: COUNT
      
      Statistics: SUM
      
      CONTACTS_MISSED
      
      Unit: COUNT
      
      Statistics: SUM
      
      OCCUPANCY
      
      Unit: PERCENT
      
      Statistics: AVG
      
      HANDLE_TIME
      
      Unit: SECONDS
      
      Statistics: AVG
      
      AFTER_CONTACT_WORK_TIME
      
      Unit: SECONDS
      
      Statistics: AVG
      
      QUEUED_TIME
      
      Unit: SECONDS
      
      Statistics: MAX
      
      ABANDON_TIME
      
      Unit: COUNT
      
      Statistics: SUM
      
      QUEUE_ANSWER_TIME
      
      Unit: SECONDS
      
      Statistics: AVG
      
      HOLD_TIME
      
      Unit: SECONDS
      
      Statistics: AVG
      
      INTERACTION_TIME
      
      Unit: SECONDS
      
      Statistics: AVG
      
      INTERACTION_AND_HOLD_TIME
      
      Unit: SECONDS
      
      Statistics: AVG
      
      SERVICE_LEVEL
      
      Unit: PERCENT
      
      Statistics: AVG
      
      Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
    - nextToken
```
String nextToken
```
      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    - maxResults
```
Integer maxResults
```
      Indicates the maximum number of results to return per page in the response, between 1-100.
- Class com.amazonaws.services.connect.model.GetMetricDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.
      
      The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
    - metricResults
```
List<E> metricResults
```
      A list of HistoricalMetricResult objects, organized by Dimensions, which is the ID of the resource specified in the Filters used for the request. The metrics are combined with the metrics included in Collections, which is a list of HisotricalMetricData objects.
      
      If no Grouping is specified in the request, Collections includes summary data for the HistoricalMetrics.
- Class com.amazonaws.services.connect.model.HierarchyGroup extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the hierarchy group.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) for the hierarchy group.
    - name
```
String name
```
      The name of the hierarchy group in your instance.
    - levelId
```
String levelId
```
      The identifier for the level in the hierarchy group.
    - hierarchyPath
```
HierarchyPath hierarchyPath
```
      A HierarchyPath object that contains information about the levels in the hierarchy group.
- Class com.amazonaws.services.connect.model.HierarchyGroupSummary extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the hierarchy group.
    - arn
```
String arn
```
      The ARN for the hierarchy group.
    - name
```
String name
```
      The name of the hierarchy group.
- Class com.amazonaws.services.connect.model.HierarchyLevel extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the hierarchy group level.
    - arn
```
String arn
```
      The ARN for the hierarchy group level.
    - name
```
String name
```
      The name of the hierarchy group level.
- Class com.amazonaws.services.connect.model.HierarchyPath extends Object implements Serializable
  - Serialized Fields
    - levelOne
```
HierarchyGroupSummary levelOne
```
      A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.
    - levelTwo
```
HierarchyGroupSummary levelTwo
```
      A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.
    - levelThree
```
HierarchyGroupSummary levelThree
```
      A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.
    - levelFour
```
HierarchyGroupSummary levelFour
```
      A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.
    - levelFive
```
HierarchyGroupSummary levelFive
```
      A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.
- Class com.amazonaws.services.connect.model.HierarchyStructure extends Object implements Serializable
  - Serialized Fields
    - levelOne
```
HierarchyLevel levelOne
```
      A HierarchyLevel object that contains information about the hierarchy group level.
    - levelTwo
```
HierarchyLevel levelTwo
```
      A HierarchyLevel object that contains information about the hierarchy group level.
    - levelThree
```
HierarchyLevel levelThree
```
      A HierarchyLevel object that contains information about the hierarchy group level.
    - levelFour
```
HierarchyLevel levelFour
```
      A HierarchyLevel object that contains information about the hierarchy group level.
    - levelFive
```
HierarchyLevel levelFive
```
      A HierarchyLevel object that contains information about the hierarchy group level.
- Class com.amazonaws.services.connect.model.HistoricalMetric extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the historical metric.
    - threshold
```
Threshold threshold
```
      The threshold for the metric, used with service level metrics.
    - statistic
```
String statistic
```
      The statistic for the metric: SUM, MAX, or SUM.
    - unit
```
String unit
```
      The unit for the metric: COUNT, PERCENT, or SECONDS.
- Class com.amazonaws.services.connect.model.HistoricalMetricData extends Object implements Serializable
  - Serialized Fields
    - metric
```
HistoricalMetric metric
```
      A HistoricalMetric object.
    - value
```
Double value
```
      The Value of the metric.
- Class com.amazonaws.services.connect.model.HistoricalMetricResult extends Object implements Serializable
  - Serialized Fields
    - dimensions
```
Dimensions dimensions
```
      The Dimensions for the metrics.
    - collections
```
List<E> collections
```
      A list of HistoricalMetricData objects.
- Class com.amazonaws.services.connect.model.InternalServiceException extends AmazonConnectException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.InvalidParameterException extends AmazonConnectException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.InvalidRequestException extends AmazonConnectException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.LimitExceededException extends AmazonConnectException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.ListRoutingProfilesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
    - nextToken
```
String nextToken
```
      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of routing profiles to return in the response.
- Class com.amazonaws.services.connect.model.ListRoutingProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - routingProfileSummaryList
```
List<E> routingProfileSummaryList
```
      An array of RoutingProfileSummary objects that include the ARN, Id, and Name of the routing profile.
    - nextToken
```
String nextToken
```
      A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.
- Class com.amazonaws.services.connect.model.ListSecurityProfilesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
    - nextToken
```
String nextToken
```
      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of security profiles to return.
- Class com.amazonaws.services.connect.model.ListSecurityProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - securityProfileSummaryList
```
List<E> securityProfileSummaryList
```
      An array of SecurityProfileSummary objects.
    - nextToken
```
String nextToken
```
      A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.
- Class com.amazonaws.services.connect.model.ListUserHierarchyGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
    - nextToken
```
String nextToken
```
      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of hierarchy groups to return.
- Class com.amazonaws.services.connect.model.ListUserHierarchyGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userHierarchyGroupSummaryList
```
List<E> userHierarchyGroupSummaryList
```
      An array of HierarchyGroupSummary objects.
    - nextToken
```
String nextToken
```
      A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.
- Class com.amazonaws.services.connect.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
    - nextToken
```
String nextToken
```
      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
- Class com.amazonaws.services.connect.model.ListUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userSummaryList
```
List<E> userSummaryList
```
      An array of UserSummary objects that contain information about the users in your instance.
    - nextToken
```
String nextToken
```
      A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.
- Class com.amazonaws.services.connect.model.OutboundContactNotPermittedException extends AmazonConnectException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.QueueReference extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the queue associated with the metrics returned.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of queue.
- Class com.amazonaws.services.connect.model.ResourceNotFoundException extends AmazonConnectException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.RoutingProfileSummary extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the routing profile.
    - arn
```
String arn
```
      The ARN of the routing profile.
    - name
```
String name
```
      The name of the routing profile.
- Class com.amazonaws.services.connect.model.SecurityProfileSummary extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the security profile.
    - arn
```
String arn
```
      The ARN of the security profile.
    - name
```
String name
```
      The name of the security profile.
- Class com.amazonaws.services.connect.model.StartOutboundVoiceContactRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - destinationPhoneNumber
```
String destinationPhoneNumber
```
      The phone number of the customer in E.164 format.
    - contactFlowId
```
String contactFlowId
```
      The identifier for the contact flow to connect the outbound call to.
      
      To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
    - clientToken
```
String clientToken
```
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.
    - sourcePhoneNumber
```
String sourcePhoneNumber
```
      The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.
    - queueId
```
String queueId
```
      The queue to add the call to. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue used will be the queue defined in the contact flow.
      
      To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.
    - attributes
```
Map<K,V> attributes
```
      Specify a custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
      
      There can be up to 32,768 UTF-8 bytes across all key-value pairs. Attribute keys can include only alphanumeric, dash, and underscore characters.
      
      For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:
- Class com.amazonaws.services.connect.model.StartOutboundVoiceContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contactId
```
String contactId
```
      The unique identifier of this contact within your Amazon Connect instance.
- Class com.amazonaws.services.connect.model.StopContactRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - contactId
```
String contactId
```
      The unique identifier of the contact to end.
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
- Class com.amazonaws.services.connect.model.StopContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.connect.model.Threshold extends Object implements Serializable
  - Serialized Fields
    - comparison
```
String comparison
```
      The Threshold to use to compare service level metrics to. Only "Less than" (LT) comparisons are supported.
    - thresholdValue
```
Double thresholdValue
```
      The value of the threshold to compare the metric to. Only "Less than" (LT) comparisons are supported.
- Class com.amazonaws.services.connect.model.ThrottlingException extends AmazonConnectException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.UpdateContactAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - initialContactId
```
String initialContactId
```
      The unique identifier of the contact for which to update attributes. This is the identifier for the contact associated with the first interaction with the contact center.
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
    - attributes
```
Map<K,V> attributes
```
      The key-value pairs for the attribute to update.
- Class com.amazonaws.services.connect.model.UpdateContactAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.connect.model.UpdateUserHierarchyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - hierarchyGroupId
```
String hierarchyGroupId
```
      The identifier for the hierarchy group to assign to the user.
    - userId
```
String userId
```
      The identifier of the user account to assign the hierarchy group to.
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
- Class com.amazonaws.services.connect.model.UpdateUserHierarchyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.connect.model.UpdateUserIdentityInfoRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityInfo
```
UserIdentityInfo identityInfo
```
      A UserIdentityInfo object.
    - userId
```
String userId
```
      The identifier for the user account to update identity information for.
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
- Class com.amazonaws.services.connect.model.UpdateUserIdentityInfoResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.connect.model.UpdateUserPhoneConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - phoneConfig
```
UserPhoneConfig phoneConfig
```
      A UserPhoneConfig object that contains settings for AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType to assign to the user.
    - userId
```
String userId
```
      The identifier for the user account to change phone settings for.
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
- Class com.amazonaws.services.connect.model.UpdateUserPhoneConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.connect.model.UpdateUserRoutingProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - routingProfileId
```
String routingProfileId
```
      The identifier of the routing profile to assign to the user.
    - userId
```
String userId
```
      The identifier for the user account to assign the routing profile to.
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
- Class com.amazonaws.services.connect.model.UpdateUserRoutingProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.connect.model.UpdateUserSecurityProfilesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - securityProfileIds
```
List<E> securityProfileIds
```
      The identifiers for the security profiles to assign to the user.
    - userId
```
String userId
```
      The identifier of the user account to assign the security profiles.
    - instanceId
```
String instanceId
```
      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
- Class com.amazonaws.services.connect.model.UpdateUserSecurityProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.connect.model.User extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the user account.
    - arn
```
String arn
```
      The ARN of the user account.
    - username
```
String username
```
      The user name assigned to the user account.
    - identityInfo
```
UserIdentityInfo identityInfo
```
      A UserIdentityInfo object.
    - phoneConfig
```
UserPhoneConfig phoneConfig
```
      A UserPhoneConfig object.
    - directoryUserId
```
String directoryUserId
```
      The directory Id for the user account in the existing directory used for identity management.
    - securityProfileIds
```
List<E> securityProfileIds
```
      The identifier(s) for the security profile assigned to the user.
    - routingProfileId
```
String routingProfileId
```
      The identifier of the routing profile assigned to the user.
    - hierarchyGroupId
```
String hierarchyGroupId
```
      The identifier for the hierarchy group assigned to the user.
- Class com.amazonaws.services.connect.model.UserIdentityInfo extends Object implements Serializable
  - Serialized Fields
    - firstName
```
String firstName
```
      The first name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.
    - lastName
```
String lastName
```
      The last name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.
    - email
```
String email
```
      The email address added to the user account. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.
- Class com.amazonaws.services.connect.model.UserNotFoundException extends AmazonConnectException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connect.model.UserPhoneConfig extends Object implements Serializable
  - Serialized Fields
    - phoneType
```
String phoneType
```
      The phone type selected for the user, either Soft phone or Desk phone.
    - autoAccept
```
Boolean autoAccept
```
      The Auto accept setting for the user, Yes or No.
    - afterContactWorkTimeLimit
```
Integer afterContactWorkTimeLimit
```
      The After Call Work (ACW) timeout setting, in seconds, for the user.
    - deskPhoneNumber
```
String deskPhoneNumber
```
      The phone number for the user's desk phone.
- Class com.amazonaws.services.connect.model.UserSummary extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the user account.
    - arn
```
String arn
```
      The ARN for the user account.
    - username
```
String username
```
      The Amazon Connect user name for the user account.

Serialized Form

Package com.amazonaws.services.connect.model

Class com.amazonaws.services.connect.model.AmazonConnectException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.connect.model.ContactNotFoundException extends AmazonConnectException implements Serializable

Class com.amazonaws.services.connect.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

password

identityInfo

phoneConfig

directoryUserId

securityProfileIds

routingProfileId

hierarchyGroupId

instanceId

Class com.amazonaws.services.connect.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

userId

userArn

Class com.amazonaws.services.connect.model.Credentials extends Object implements Serializable

Serialized Fields

accessToken

accessTokenExpiration

refreshToken

refreshTokenExpiration

Class com.amazonaws.services.connect.model.CurrentMetric extends Object implements Serializable

Serialized Fields

name

unit

Class com.amazonaws.services.connect.model.CurrentMetricData extends Object implements Serializable

Serialized Fields

metric

value

Class com.amazonaws.services.connect.model.CurrentMetricResult extends Object implements Serializable

Serialized Fields

dimensions

collections

Class com.amazonaws.services.connect.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

userId

Class com.amazonaws.services.connect.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.connect.model.DescribeUserHierarchyGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hierarchyGroupId

instanceId

Class com.amazonaws.services.connect.model.DescribeUserHierarchyGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

hierarchyGroup

Class com.amazonaws.services.connect.model.DescribeUserHierarchyStructureRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

Class com.amazonaws.services.connect.model.DescribeUserHierarchyStructureResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

hierarchyStructure

Class com.amazonaws.services.connect.model.DescribeUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userId

instanceId

Class com.amazonaws.services.connect.model.DescribeUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

user

Class com.amazonaws.services.connect.model.DestinationNotAllowedException extends AmazonConnectException implements Serializable

Class com.amazonaws.services.connect.model.Dimensions extends Object implements Serializable

Serialized Fields

queue

channel

Class com.amazonaws.services.connect.model.DuplicateResourceException extends AmazonConnectException implements Serializable

Class com.amazonaws.services.connect.model.Filters extends Object implements Serializable

Serialized Fields

queues

channels

Class com.amazonaws.services.connect.model.GetCurrentMetricDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

filters

groupings

currentMetrics

nextToken

maxResults