String username
The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.
String password
The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
UserIdentityInfo identityInfo
The information about the identity of the user.
UserPhoneConfig phoneConfig
The phone settings for the user.
String directoryUserId
The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your 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 error is returned.
List<E> securityProfileIds
The identifier of the security profile for the user.
String routingProfileId
The identifier of the routing profile for the user.
String hierarchyGroupId
The identifier of the hierarchy group for the user.
String instanceId
The identifier of the Amazon Connect instance.
Map<K,V> tags
One or more tags.
String accessToken
An access token generated for a federated user to access Amazon Connect.
Date accessTokenExpiration
A token generated with an expiration time for the session a user is logged in to Amazon Connect.
String refreshToken
Renews a token generated for a user to access the Amazon Connect instance.
Date refreshTokenExpiration
Renews the expiration timer for a generated token.
CurrentMetric metric
Information about the metric.
Double value
The value of the metric.
Dimensions dimensions
The dimensions for the metrics.
List<E> collections
The set of metrics.
HierarchyGroup hierarchyGroup
Information about the hierarchy group.
String instanceId
The identifier of the Amazon Connect instance.
HierarchyStructure hierarchyStructure
Information about the hierarchy structure.
User user
Information about the user account and configuration settings.
QueueReference queue
Information about the queue for which metrics are returned.
String channel
The channel used for grouping and filters.
String instanceId
The identifier of the Amazon Connect instance.
Filters filters
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the
resources associated with the queues or channels included in the filter. You can include both queue IDs and queue
ARNs in the same request. The only supported channel is VOICE.
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 metrics is returned.
List<E> currentMetrics
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available:
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: SECONDS
Unit: COUNT
Unit: COUNT
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 token must use the same request parameters as the request that generated the token.
Integer maxResults
The maximimum number of results to return per page.
String nextToken
If there are additional results, this is the token for the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
List<E> metricResults
Information about the real-time metrics.
Date dataSnapshotTime
The time at which the metrics were retrieved and cached for pagination.
String instanceId
The identifier of the Amazon Connect instance.
Credentials credentials
The credentials to use for federation.
String instanceId
The identifier of the Amazon Connect instance.
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.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
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 start time timestamp.
The time range between the start and end time must be less than 24 hours.
Filters filters
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the
resources associated with the queues or channels included in the filter. You can include both queue IDs and queue
ARNs in the same request. The only supported channel is VOICE.
List<E> groupings
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
The only supported grouping is QUEUE.
If no grouping is specified, a summary of metrics for all queues is returned.
List<E> historicalMetrics
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
Unit: PERCENT
Statistic: 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
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.
Integer maxResults
The maximimum number of results to return per page.
String nextToken
If there are additional results, this is the token for the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
List<E> metricResults
Information about the historical metrics.
If no grouping is specified, a summary of metric data is returned.
String id
The identifier of the hierarchy group.
String arn
The Amazon Resource Name (ARN) of the hierarchy group.
String name
The name of the hierarchy group.
String levelId
The identifier of the level in the hierarchy group.
HierarchyPath hierarchyPath
Information about the levels in the hierarchy group.
HierarchyGroupSummary levelOne
Information about level one.
HierarchyGroupSummary levelTwo
Information about level two.
HierarchyGroupSummary levelThree
Information about level three.
HierarchyGroupSummary levelFour
Information about level four.
HierarchyGroupSummary levelFive
Information about level five.
HierarchyLevel levelOne
Information about level one.
HierarchyLevel levelTwo
Information about level two.
HierarchyLevel levelThree
Information about level three.
HierarchyLevel levelFour
Information about level four.
HierarchyLevel levelFive
Information about level five.
HistoricalMetric metric
Information about the metric.
Double value
The value of the metric.
Dimensions dimensions
The dimension for the metrics.
List<E> collections
The set of metrics.
String instanceId
The identifier of the Amazon Connect instance.
List<E> contactFlowTypes
The type of contact flow.
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.
Integer maxResults
The maximimum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance.
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.
Integer maxResults
The maximimum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance.
List<E> phoneNumberTypes
The type of phone number.
List<E> phoneNumberCountryCodes
The ISO country code.
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.
Integer maxResults
The maximimum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance.
List<E> queueTypes
The type of queue.
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.
Integer maxResults
The maximimum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance.
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.
Integer maxResults
The maximimum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance.
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.
Integer maxResults
The maximimum number of results to return per page.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
String instanceId
The identifier of the Amazon Connect instance.
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.
Integer maxResults
The maximimum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance.
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.
Integer maxResults
The maximimum number of results to return per page.
String displayName
Display name of the participant.
String id
The identifier of the phone number.
String arn
The Amazon Resource Name (ARN) of the phone number.
String phoneNumber
The phone number.
String phoneNumberType
The type of phone number.
String phoneNumberCountryCode
The ISO country code.
String instanceId
The identifier of the Amazon Connect instance.
String contactFlowId
The identifier of the contact flow for the chat.
Map<K,V> attributes
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 per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
ParticipantDetails participantDetails
Information identifying the participant.
ChatMessage initialMessage
The initial message to be sent to the newly created chat.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String contactId
The identifier of this contact within the Amazon Connect instance.
String participantId
The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
String participantToken
The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
String destinationPhoneNumber
The phone number of the customer, in E.164 format.
String contactFlowId
The identifier of the contact flow for the outbound call.
String instanceId
The identifier of the Amazon Connect instance.
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.
String sourcePhoneNumber
The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
String queueId
The queue for the call. 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 defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
Map<K,V> attributes
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 per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
String contactId
The identifier of this contact within the Amazon Connect instance.
String initialContactId
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
String instanceId
The identifier of the Amazon Connect instance.
Map<K,V> attributes
The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
UserIdentityInfo identityInfo
The identity information for the user.
String userId
The identifier of the user account.
String instanceId
The identifier of the Amazon Connect instance.
UserPhoneConfig phoneConfig
Information about phone configuration settings for the user.
String userId
The identifier of the user account.
String instanceId
The identifier of the Amazon Connect instance.
String id
The identifier of the user account.
String arn
The Amazon Resource Name (ARN) of the user account.
String username
The user name assigned to the user account.
UserIdentityInfo identityInfo
Information about the user identity.
UserPhoneConfig phoneConfig
Information about the phone configuration for the user.
String directoryUserId
The identifier of the user account in the directory used for identity management.
List<E> securityProfileIds
The identifiers of the security profiles for the user.
String routingProfileId
The identifier of the routing profile for the user.
String hierarchyGroupId
The identifier of the hierarchy group for the user.
Map<K,V> tags
The tags.
String firstName
The first name. This is required if you are using Amazon Connect or SAML for identity management.
String lastName
The last name. This is required if you are using Amazon Connect or SAML for identity management.
String email
The email address. If you are using SAML for identity management and include this parameter, an error is returned.
Copyright © 2019. All rights reserved.