String actionType
The action type.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String evaluationFormId
The unique identifier for the evaluation form.
Integer evaluationFormVersion
The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.
String contactId
The identifier of the contact in this instance of Amazon Connect.
String channel
The channel of the contact.
String initiationMethod
How the contact was initiated.
String agentContactState
The state of the contact.
When AgentContactState is set to CONNECTED_ONHOLD, StateStartTimestamp is
not changed. Instead, StateStartTimestamp reflects the time the contact was CONNECTED
to the agent.
Date stateStartTimestamp
The epoch timestamp when the contact state started.
Date connectedToAgentTimestamp
The time at which the contact was connected to an agent.
QueueReference queue
String arn
The Amazon Resource Name (ARN) of the group.
List<E> l1Ids
The identifiers for level 1 hierarchy groups.
List<E> l2Ids
The identifiers for level 2 hierarchy groups.
List<E> l3Ids
The identifiers for level 3 hierarchy groups.
List<E> l4Ids
The identifiers for level 4 hierarchy groups.
List<E> l5Ids
The identifiers for level 5 hierarchy groups.
String id
The identifier of the agent who accepted the contact.
Date connectedToAgentTimestamp
The timestamp when the contact was connected to the agent.
Integer agentPauseDurationInSeconds
Agent pause duration for a contact in seconds.
HierarchyGroups hierarchyGroups
The agent hierarchy groups for the agent.
DeviceInfo deviceInfo
Information regarding Agent’s device.
ParticipantCapabilities capabilities
AudioQualityMetricsInfo audio
Information about the audio quality of the Agent
String agentStatusARN
The Amazon Resource Name (ARN) of the agent status.
String agentStatusId
The identifier of the agent status.
String name
The name of the agent status.
String description
The description of the agent status.
String type
The type of agent status.
Integer displayOrder
The display order of the agent status.
String state
The state of the agent status.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String id
The identifier for an agent status.
String arn
The Amazon Resource Name (ARN) for the agent status.
String name
The name of the agent status.
String type
The type of the agent status.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
ParticipantCapabilities customer
Information about the customer's video sharing capabilities.
ParticipantCapabilities agent
Information about the agent's video sharing capabilities.
String dataSetId
The identifier of the dataset.
String targetAccountId
The identifier of the target account.
String resourceShareId
The Resource Access Manager share ID.
String resourceShareArn
The Amazon Resource Name (ARN) of the Resource Access Manager share.
Boolean enableAnswerMachineDetection
The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to
true, TrafficType must be set as CAMPAIGN.
Boolean awaitAnswerMachinePrompt
Wait for the answering machine prompt.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String dataSetId
The identifier of the dataset to associate with the target account.
String targetAccountId
The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
String dataSetId
The identifier of the dataset that was associated.
String targetAccountId
The identifier of the target account.
String resourceShareId
The Resource Access Manager share ID that is generated.
String resourceShareArn
The Amazon Resource Name (ARN) of the Resource Access Manager share.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String origin
The domain to add to your allow list.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
LexBot lexBot
LexV2Bot lexV2Bot
The Amazon Lex V2 bot to associate with the instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String languageCode
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
String vocabularyId
The identifier of the custom vocabulary. If this is empty, the default is set to none.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String resourceId
The identifier of the resource.
String flowId
The identifier of the flow.
String resourceType
A valid resource type.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String resourceType
A valid resource type. To enable streaming for real-time analysis of contacts, use the following types:
For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS.
For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still supported and will apply only to
VOICE channel contacts. Use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving
forward.
If you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, no action is
needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
InstanceStorageConfig storageConfig
A valid storage type.
String associationId
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String functionArn
The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
LexBot lexBot
The Amazon Lex bot to associate with the instance.
String phoneNumberId
A unique identifier for the phone number.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactFlowId
The identifier of the flow.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String queueId
The identifier for the queue.
List<E> quickConnectIds
The quick connects to associate with this queue.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String routingProfileId
The identifier of the routing profile.
List<E> queueConfigs
The queues to associate with this routing profile.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String key
A valid security key in PEM format.
String associationId
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
String trafficDistributionGroupId
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
String userId
The identifier of the user account. This can be the ID or the ARN of the user.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance).
String userId
The identifier of the user account.
List<E> userProficiencies
The proficiencies to associate with the user.
String creationTime
The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format:
yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
String fileArn
The unique identifier of the attached file resource (ARN).
String fileId
The unique identifier of the attached file resource.
String fileName
A case-sensitive name of the attached file being uploaded.
Long fileSizeInBytes
The size of the attached file in bytes.
String fileStatus
The current status of the attached file.
CreatedByInfo createdBy
Represents the identity that created the file.
String fileUseCaseType
The use case for the file.
String associatedResourceArn
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example,
{ "Tags": {"key1":"value1", "key2":"value2"} }.
List<E> tagConditions
A leaf node condition which can be used to specify a tag condition.
HierarchyGroupCondition hierarchyGroupCondition
String echoReduction
Makes echo reduction available to clients who connect to the meeting.
Float qualityScore
Number measuring the estimated quality of the media connection.
List<E> potentialQualityIssues
List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.
Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
List<E> dataSetIds
An array of dataset identifiers to associate.
String targetAccountId
The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
List<E> dataSetIds
An array of associated dataset identifiers to remove.
String targetAccountId
The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
List<E> fileIds
The unique identifiers of the attached file resource.
String instanceId
The unique identifier of the Connect instance.
String associatedResourceArn
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
List<E> resourceIds
A list of resource identifiers to retrieve flow associations.
String resourceType
The type of resource association.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
List<E> contactDataRequestList
List of individual contact requests.
String campaignId
A unique identifier for a campaign.
String type
Type of chat integration event.
String contentType
Type of content. This is required when Type is MESSAGE or EVENT.
For allowed message content types, see the ContentType parameter in the SendMessage
topic in the Amazon Connect Participant Service API Reference.
For allowed event content types, see the ContentType parameter in the SendEvent topic
in the Amazon Connect Participant Service API Reference.
String content
Content of the message or event. This is required when Type is MESSAGE and for certain
ContentTypes when Type is EVENT.
For allowed message content, see the Content parameter in the SendMessage
topic in the Amazon Connect Participant Service API Reference.
For allowed event content, see the Content parameter in the SendEvent topic
in the Amazon Connect Participant Service API Reference.
String contentType
The type of the content. Supported types are text/plain, text/markdown,
application/json, and application/vnd.amazonaws.connect.message.interactive.response.
String content
The content of the chat message.
For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of
1024.
For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.
For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are
Minimum of 1, Maximum of 12288.
String streamingEndpointArn
The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.
String phoneNumberId
A unique identifier for the phone number.
String phoneNumberArn
The Amazon Resource Name (ARN) of the phone number.
String phoneNumber
The phone number. Phone numbers are formatted
[+] [country code] [subscriber number including area code].
String phoneNumberCountryCode
The ISO country code.
String phoneNumberType
The type of phone number.
String phoneNumberDescription
The description of the phone number.
String targetArn
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
String instanceId
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
PhoneNumberStatus phoneNumberStatus
The status of the phone number.
CLAIMED means the previous ClaimPhoneNumber or
UpdatePhoneNumber
operation succeeded.
IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber,
or
UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.
FAILED indicates that the previous ClaimPhoneNumber or
UpdatePhoneNumber
operation has failed. It will include a message indicating the failure reason. A common reason for a failure may
be that the TargetArn value you are claiming or updating a phone number to has reached its limit of
total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API
call, you have one day to retry claiming the phone number before the number is released back to the inventory for
other customers to claim.
You will not be billed for the phone number during the 1-day period if number claiming fails.
String sourcePhoneNumberArn
The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.
String targetArn
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number
inbound traffic is routed through. You must enter InstanceId or TargetArn.
String instanceId
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in
the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
String phoneNumber
The phone number you want to claim. Phone numbers are formatted
[+] [country code] [subscriber number including area code].
String phoneNumberDescription
The description of the phone number.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
String instanceId
The unique identifier of the Connect instance.
String fileId
The unique identifier of the attached file resource.
String associatedResourceArn
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
String arn
The Amazon Resource Name (ARN) for the contact.
String id
The identifier for the contact.
String initialContactId
If this contact is related to other contacts, this is the ID of the initial contact.
String previousContactId
If this contact is not the first contact, this is the ID of the previous contact.
String initiationMethod
Indicates how the contact was initiated.
String name
The name of the contact.
String description
The description of the contact.
String channel
How the contact reached your contact center.
QueueInfo queueInfo
If this contact was queued, this contains information about the queue.
AgentInfo agentInfo
Information about the agent who accepted the contact.
Date initiationTimestamp
The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact
arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when
the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the
transfer was initiated. For API, this is when the request arrived. For
EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For
MONITOR, this is when the supervisor started listening to a contact.
Date disconnectTimestamp
The timestamp when the customer endpoint disconnected from Amazon Connect.
Date lastUpdateTimestamp
The timestamp when contact was last updated.
Date lastPausedTimestamp
The timestamp when the contact was last paused.
Date lastResumedTimestamp
The timestamp when the contact was last resumed.
Integer totalPauseCount
Total pause count for a contact.
Integer totalPauseDurationInSeconds
Total pause duration for a contact in seconds.
Date scheduledTimestamp
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
String relatedContactId
The contactId that is related to this contact.
WisdomInfo wisdomInfo
Information about Amazon Connect Wisdom.
Integer queueTimeAdjustmentSeconds
An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.
Long queuePriority
An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.
Map<K,V> tags
Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
Date connectedToSystemTimestamp
The timestamp when customer endpoint connected to Amazon Connect.
RoutingCriteria routingCriteria
Latest routing criteria on the contact.
Customer customer
Information about the Customer on the contact.
Campaign campaign
String answeringMachineDetectionStatus
Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
CustomerVoiceActivity customerVoiceActivity
Information about customer’s voice activity.
QualityMetrics qualityMetrics
Information about the quality of the participant's media connection.
DisconnectDetails disconnectDetails
Information about the call disconnect experience.
Map<K,V> segmentAttributes
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only
alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example,
connect:Guide or connect:SMS.
Transcript transcript
Search criteria based on transcript analyzed by Amazon Connect Contact Lens.
Endpoint systemEndpoint
Endpoint associated with the Amazon Connect instance from which outbound contact will be initiated for the campaign.
Endpoint customerEndpoint
Endpoint of the customer for which contact will be initiated.
String requestIdentifier
Identifier to uniquely identify individual requests in the batch.
String queueId
The identifier of the queue associated with the Amazon Connect instance in which contacts that are created will be queued.
Map<K,V> attributes
List of attributes to be stored in a contact.
Campaign campaign
Structure to store information associated with a campaign.
List<E> contactStates
A list of up to 9 contact states.
String arn
The Amazon Resource Name (ARN) of the flow.
String id
The identifier of the flow.
String name
The name of the flow.
String type
The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
String state
The type of flow.
String status
The status of the contact flow.
String description
The description of the flow.
String content
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String arn
The Amazon Resource Name (ARN).
String id
The identifier of the flow module.
String name
The name of the flow module.
String content
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
String description
The description of the flow module.
String state
The type of flow module.
String status
The status of the flow module.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
StringCondition stringCondition
ControlPlaneTagFilter tagFilter
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
StringCondition stringCondition
String typeCondition
The type of flow.
String stateCondition
The state of the flow.
String statusCondition
The status of the flow.
ControlPlaneTagFilter tagFilter
String id
The identifier of the flow.
String arn
The Amazon Resource Name (ARN) of the flow.
String name
The name of the flow.
String contactFlowType
The type of flow.
String contactFlowState
The type of flow.
String contactFlowStatus
The status of the contact flow.
String arn
The Amazon Resource Name (ARN) of the contact.
String id
The identifier of the contact summary.
String initialContactId
If this contact is related to other contacts, this is the ID of the initial contact.
String previousContactId
If this contact is not the first contact, this is the ID of the previous contact.
String initiationMethod
Indicates how the contact was initiated.
String channel
How the contact reached your contact center.
ContactSearchSummaryQueueInfo queueInfo
If this contact was queued, this contains information about the queue.
ContactSearchSummaryAgentInfo agentInfo
Information about the agent who accepted the contact.
Date initiationTimestamp
The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact
arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when
the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the
transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is
when the agent started dialing the external participant. For MONITOR, this is when the supervisor
started listening to a contact.
Date disconnectTimestamp
The timestamp when the customer endpoint disconnected from Amazon Connect.
Date scheduledTimestamp
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
TagCondition tagCondition
A leaf node condition which can be used to specify a tag condition.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
AttributeAndCondition andCondition
A list of conditions which would be applied together with an AND condition.
TagCondition tagCondition
HierarchyGroupCondition hierarchyGroupCondition
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the status.
String description
The description of the status.
String state
The state of the status.
Integer displayOrder
The display order of the status.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the flow module.
String description
The description of the flow module.
String content
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String instanceId
The identifier of the Amazon Connect instance.
String name
The name of the flow.
String type
The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
String description
The description of the flow.
String content
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
String status
Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED
status will initiate validation on the content. the SAVED status does not initiate validation of the
content. SAVED | PUBLISHED.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String connectUserArn
An agent ARN representing a connect user.
String aWSIdentityArn
STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is
calculated automatically if ConnectUserArn is not provided.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String title
A title of the evaluation form.
String description
The description of the evaluation form.
List<E> items
Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
EvaluationFormScoringStrategy scoringStrategy
A scoring strategy of the evaluation form.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the hours of operation.
String description
The description of the hours of operation.
String timeZone
The time zone of the hours of operation.
List<E> config
Configuration information for the hours of operation: day, start time, and end time.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String clientToken
The idempotency token.
String identityManagementType
The type of identity management for your Amazon Connect users.
String instanceAlias
The name for your instance.
String directoryId
The identifier for the directory.
Boolean inboundCallsEnabled
Your contact center handles incoming contacts.
Boolean outboundCallsEnabled
Your contact center allows outbound calls.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example,
{ "tags": {"key1":"value1", "key2":"value2"} }.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String integrationType
The type of information to be ingested.
String integrationArn
The Amazon Resource Name (ARN) of the integration.
When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.
String sourceApplicationUrl
The URL for the external application. This field is only required for the EVENT integration type.
String sourceApplicationName
The name of the external application. This field is only required for the EVENT integration type.
String sourceType
The type of the data source. This field is only required for the EVENT integration type.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
ParticipantDetailsToAdd participantDetails
Information identifying the participant.
The only Valid value for ParticipantRole is CUSTOM_BOT.
DisplayName is Required.
ParticipantTokenCredentials participantCredentials
The token used by the chat participant to call CreateParticipantConnection. The participant token is
valid for the lifetime of a chat participant.
String participantId
The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String initialContactId
This is the contactId of the current contact that the CreatePersistentContactAssociation API is
being called from.
String rehydrationType
The contactId chosen for rehydration depends on the type chosen.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the
specified past ended chat session. To use this type, provide the initialContactId of the past ended
chat session in the sourceContactId field. In this type, Amazon Connect determines what the most
recent chat contact on the past ended chat session and uses it to start a persistent chat.
FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the
sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:
Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:
Configuration
SourceContactId = "C2"
RehydrationType = "FROM_SEGMENT"
Expected behavior
This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.
Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:
Configuration
SourceContactId = "C1"
RehydrationType = "ENTIRE_PAST_SESSION"
Expected behavior
This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.
String sourceContactId
The contactId from which a persistent chat session must be started.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String continuedFromContactId
The contactId from which a persistent chat session is started. This field is populated only for persistent chat.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the predefined attribute.
PredefinedAttributeValues values
The values of the predefined attribute.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the prompt.
String description
The description of the prompt.
String s3Uri
The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the queue.
String description
The description of the queue.
OutboundCallerConfig outboundCallerConfig
The outbound caller ID name, number, and outbound whisper flow.
String hoursOfOperationId
The identifier for the hours of operation.
Integer maxContacts
The maximum number of contacts that can be in the queue before it is considered full.
List<E> quickConnectIds
The quick connects available to agents who are working the queue.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
A unique name of the quick connect.
String description
The description of the quick connect.
QuickConnectConfig quickConnectConfig
Configuration settings for the quick connect.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the routing profile. Must not be more than 127 characters.
String description
Description of the routing profile. Must not be more than 250 characters.
String defaultOutboundQueueId
The default outbound queue for the routing profile.
List<E> queueConfigs
The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.
The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig objects
that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per
routing profile per instance that is listed in Amazon Connect
service quotas.
List<E> mediaConcurrencies
The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String agentAvailabilityTimer
Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
A unique name for the rule.
RuleTriggerEventSource triggerEventSource
The event source to trigger the rule.
String function
The conditions of the rule.
List<E> actions
A list of actions to be run when the rule is triggered.
String publishStatus
The publish status of the rule.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String securityProfileName
The name of the security profile.
String description
The description of the security profile.
List<E> permissions
Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Map<K,V> allowedAccessControlTags
The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
List<E> tagRestrictedResources
The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are
acceptable ResourceNames: User | SecurityProfile | Queue |
RoutingProfile
List<E> applications
A list of third-party applications that the security profile will give access to.
List<E> hierarchyRestrictedResources
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are
acceptable ResourceNames: User.
String allowedAccessControlHierarchyGroupId
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the task template.
String description
The description of the task template.
String contactFlowId
The identifier of the flow that runs by default when a task is created by referencing this template.
TaskTemplateConstraints constraints
Constraints that are applicable to the fields listed.
TaskTemplateDefaults defaults
The default values for fields when a task is created by referencing this template.
String status
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be
created from ACTIVE templates. If a template is marked as INACTIVE, then a task that
refers to this template cannot be created.
List<E> fields
Fields that are part of the template.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String name
The name for the traffic distribution group.
String description
A description for the traffic distribution group.
String instanceId
The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId
in the ARN of the instance.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String id
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
String arn
The Amazon Resource Name (ARN) of the traffic distribution group.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String integrationAssociationId
The identifier for the integration association.
String useCaseType
The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String name
The name of the user hierarchy group. Must not be more than 100 characters.
String parentGroupId
The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
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_-.\@]+.
Username can include @ only if used in an email format. For example:
Correct: testuser
Correct: testuser@example.com
Incorrect: testuser@example
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. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String instanceId
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
String clientToken
A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.
String status
Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED
status will initiate validation on the content.
ViewInputContent content
View content containing all content necessary to render a view except for runtime input data.
The total uncompressed content has a maximum file size of 400kB.
String description
The description of the view.
String name
The name of the view.
Map<K,V> tags
The tags associated with the view resource (not specific to view version).These tags can be used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
View view
A view resource object. Contains metadata and content necessary to render the view.
String instanceId
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
String viewId
The identifier of the view. Both ViewArn and ViewId can be used.
String versionDescription
The description for the version being published.
String viewContentSha256
Indicates the checksum value of the latest published view content.
View view
All view data is contained within the View object.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String vocabularyName
A unique name of the custom vocabulary.
String languageCode
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
String content
The content of the custom vocabulary in plain-text format with a table of values. Each row in the table
represents a word or a phrase, described with Phrase, IPA, SoundsLike, and
DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more
information, see Create a
custom vocabulary using a table.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
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.
String behaviorType
Specifies the other channels that can be routed to an agent handling their current channel.
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.
DeviceInfo deviceInfo
Information regarding Customer’s device.
ParticipantCapabilities capabilities
AudioQualityMetricsInfo audio
Information about the audio quality of the Customer
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String evaluationFormId
The unique identifier for the evaluation form.
Integer evaluationFormVersion
A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.
String evaluationFormId
The unique identifier for the evaluation form.
String evaluationFormArn
The Amazon Resource Name (ARN) for the evaluation form resource.
Integer evaluationFormVersion
The version of the deactivated evaluation form resource.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String languageCode
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
String vocabularyId
The identifier of the custom vocabulary.
String vocabularyName
A unique name of the custom vocabulary.
String instanceId
The unique identifier of the Connect instance.
String fileId
The unique identifier of the attached file resource.
String associatedResourceArn
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String evaluationId
A unique identifier for the contact evaluation.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactFlowModuleId
The identifier of the flow module.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactFlowId
The identifier of the flow.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String evaluationFormId
The unique identifier for the evaluation form.
Integer evaluationFormVersion
The unique identifier for the evaluation form.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String hoursOfOperationId
The identifier for the hours of operation.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String integrationAssociationId
The identifier for the integration association.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String promptId
A unique identifier for the prompt.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String queueId
The identifier for the queue.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String quickConnectId
The identifier for the quick connect.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String routingProfileId
The identifier of the routing profile.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String ruleId
A unique identifier for the rule.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String securityProfileId
The identifier for the security profle.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String taskTemplateId
A unique identifier for the task template.
String trafficDistributionGroupId
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String integrationAssociationId
The identifier for the integration association.
String useCaseId
The identifier for the use case.
String hierarchyGroupId
The identifier of the hierarchy group.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String userId
The identifier of the user.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String vocabularyId
The identifier of the custom vocabulary.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String agentStatusId
The identifier for the agent status.
AgentStatus agentStatus
The agent status.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String evaluationId
A unique identifier for the contact evaluation.
Evaluation evaluation
Information about the evaluation form completed for a specific contact.
EvaluationFormContent evaluationForm
Information about the evaluation form.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactFlowModuleId
The identifier of the flow module.
ContactFlowModule contactFlowModule
Information about the flow module.
ContactFlow contactFlow
Information about the flow.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact.
Contact contact
Information about the contact.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String evaluationFormId
A unique identifier for the contact evaluation.
Integer evaluationFormVersion
A version of the evaluation form.
EvaluationForm evaluationForm
Information about the evaluation form.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String hoursOfOperationId
The identifier for the hours of operation.
HoursOfOperation hoursOfOperation
The hours of operation.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String attributeType
The type of attribute.
Attribute attribute
The type of attribute.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Instance instance
The name of the instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String associationId
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
String resourceType
A valid resource type.
InstanceStorageConfig storageConfig
A valid storage type.
String phoneNumberId
A unique identifier for the phone number.
ClaimedPhoneNumberSummary claimedPhoneNumberSummary
Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.
PredefinedAttribute predefinedAttribute
Information about the predefined attribute.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String promptId
A unique identifier for the prompt.
Prompt prompt
Information about the prompt.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String queueId
The identifier for the queue.
Queue queue
The name of the queue.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String quickConnectId
The identifier for the quick connect.
QuickConnect quickConnect
Information about the quick connect.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String routingProfileId
The identifier of the routing profile.
RoutingProfile routingProfile
The routing profile.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String ruleId
A unique identifier for the rule.
Rule rule
Information about the rule.
String securityProfileId
The identifier for the security profle.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
SecurityProfile securityProfile
The security profile.
String trafficDistributionGroupId
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
TrafficDistributionGroup trafficDistributionGroup
Information about the traffic distribution group.
String hierarchyGroupId
The identifier of the hierarchy group.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
HierarchyGroup hierarchyGroup
Information about the hierarchy group.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
HierarchyStructure hierarchyStructure
Information about the hierarchy structure.
String userId
The identifier of the user account.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
User user
Information about the user account and configuration settings.
View view
All view data is contained within the View object.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String vocabularyId
The identifier of the custom vocabulary.
Vocabulary vocabulary
A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.
QueueReference queue
Information about the queue for which metrics are returned.
String channel
The channel used for grouping and filters.
RoutingProfileReference routingProfile
String routingStepExpression
The expression of a step in a routing criteria.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String dataSetId
The identifier of the dataset to remove.
String targetAccountId
The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String origin
The domain URL of the integrated application.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
LexBot lexBot
LexV2Bot lexV2Bot
The Amazon Lex V2 bot to disassociate from the instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String resourceId
The identifier of the resource.
String resourceType
A valid resource type.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String associationId
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
String resourceType
A valid resource type.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance..
String functionArn
The Amazon Resource Name (ARN) of the Lambda function being disassociated.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String botName
The name of the Amazon Lex bot. Maximum character limit of 50.
String lexRegion
The Amazon Web Services Region in which the Amazon Lex bot has been created.
String phoneNumberId
A unique identifier for the phone number.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String queueId
The identifier for the queue.
List<E> quickConnectIds
The quick connects to disassociate from the queue.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String routingProfileId
The identifier of the routing profile.
List<E> queueReferences
The queues to disassociate from this routing profile.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String associationId
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
String trafficDistributionGroupId
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
String userId
The identifier for the user. This can be the ID or the ARN of the user.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String userId
The identifier of the user account.
List<E> userProficiencies
The proficiencies to disassociate from the user.
String potentialDisconnectIssue
Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.
String code
A code that indicates how the contact was terminated.
String encryptionType
The type of encryption.
String keyId
The full ARN of the encryption key.
Be sure to provide the full ARN of the encryption key, not just the ID.
Amazon Connect supports only KMS keys with the default key spec of
SYMMETRIC_DEFAULT .
String evaluationId
A unique identifier for the contact evaluation.
String evaluationArn
The Amazon Resource Name (ARN) for the contact evaluation resource.
EvaluationMetadata metadata
Metadata about the contact evaluation.
Map<K,V> answers
A map of question identifiers to answer value.
Map<K,V> notes
A map of question identifiers to note value.
String status
The status of the contact evaluation.
Map<K,V> scores
A map of item (section or question) identifiers to score value.
Date createdTime
The timestamp for when the evaluation was created.
Date lastModifiedTime
The timestamp for when the evaluation was last updated.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
EvaluationAnswerData value
The value for an answer in a contact evaluation.
EvaluationAnswerData value
The value for an answer in a contact evaluation.
EvaluationAnswerData systemSuggestedValue
The system suggested value for an answer in a contact evaluation.
String evaluationFormId
The unique identifier for the evaluation form.
Integer evaluationFormVersion
A version of the evaluation form.
Boolean locked
The flag indicating whether the evaluation form is locked for changes.
String evaluationFormArn
The Amazon Resource Name (ARN) for the evaluation form resource.
String title
A title of the evaluation form.
String description
The description of the evaluation form.
String status
The status of the evaluation form.
List<E> items
Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
EvaluationFormScoringStrategy scoringStrategy
A scoring strategy of the evaluation form.
Date createdTime
The timestamp for when the evaluation form was created.
String createdBy
The Amazon Resource Name (ARN) of the user who created the evaluation form.
Date lastModifiedTime
The timestamp for when the evaluation form was last updated.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Integer evaluationFormVersion
A version of the evaluation form.
String evaluationFormId
The unique identifier for the evaluation form.
String evaluationFormArn
The Amazon Resource Name (ARN) for the evaluation form resource.
String title
A title of the evaluation form.
String description
The description of the evaluation form.
List<E> items
Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
EvaluationFormScoringStrategy scoringStrategy
A scoring strategy of the evaluation form.
EvaluationFormSection section
The information of the section.
EvaluationFormQuestion question
The information of the question.
NumericQuestionPropertyValueAutomation propertyValue
The property value of the automation.
Integer minValue
The minimum answer value of the range option.
Integer maxValue
The maximum answer value of the range option.
Integer score
The score assigned to answer values within the range option.
Boolean automaticFail
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
Integer minValue
The minimum answer value.
Integer maxValue
The maximum answer value.
List<E> options
The scoring options of the numeric question.
EvaluationFormNumericQuestionAutomation automation
The automation properties of the numeric question.
String title
The title of the question.
String instructions
The instructions of the section.
String refId
The identifier of the question. An identifier must be unique within the evaluation form.
Boolean notApplicableEnabled
The flag to enable not applicable answers to the question.
String questionType
The type of the question.
EvaluationFormQuestionTypeProperties questionTypeProperties
The properties of the type of question. Text questions do not have to define question type properties.
Double weight
The scoring weight of the section.
EvaluationFormNumericQuestionProperties numeric
The properties of the numeric question.
EvaluationFormSingleSelectQuestionProperties singleSelect
The properties of the numeric question.
String title
The title of the section.
String refId
The identifier of the section. An identifier must be unique within the evaluation form.
String instructions
The instructions of the section.
List<E> items
The items of the section.
Double weight
The scoring weight of the section.
SingleSelectQuestionRuleCategoryAutomation ruleCategory
The automation option based on a rule category for the single select question.
String refId
The identifier of the answer option. An identifier must be unique within the question.
String text
The title of the answer option.
Integer score
The score assigned to the answer option.
Boolean automaticFail
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
List<E> options
The answer options of the single select question.
String displayAs
The display mode of the single select question.
EvaluationFormSingleSelectQuestionAutomation automation
The display mode of the single select question.
String evaluationFormId
The unique identifier for the evaluation form.
String evaluationFormArn
The Amazon Resource Name (ARN) for the evaluation form resource.
String title
A title of the evaluation form.
Date createdTime
The timestamp for when the evaluation form was created.
String createdBy
The Amazon Resource Name (ARN) of the user who created the evaluation form.
Date lastModifiedTime
The timestamp for when the evaluation form was last updated.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
Date lastActivatedTime
The timestamp for when the evaluation form was last activated.
String lastActivatedBy
The Amazon Resource Name (ARN) of the user who last activated the evaluation form.
Integer latestVersion
The version number of the latest evaluation form version.
Integer activeVersion
The version of the active evaluation form version.
String evaluationFormArn
The Amazon Resource Name (ARN) for the evaluation form resource.
String evaluationFormId
The unique identifier for the evaluation form.
Integer evaluationFormVersion
A version of the evaluation form.
Boolean locked
The flag indicating whether the evaluation form is locked for changes.
String status
The status of the evaluation form.
Date createdTime
The timestamp for when the evaluation form was created.
String createdBy
The Amazon Resource Name (ARN) of the user who created the evaluation form.
Date lastModifiedTime
The timestamp for when the evaluation form was last updated.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
String contactId
The identifier of the contact in this instance of Amazon Connect.
String evaluatorArn
The Amazon Resource Name (ARN) of the user who last updated the evaluation.
String contactAgentId
The identifier of the agent who performed the contact.
EvaluationScore score
The overall score of the contact evaluation.
String value
The note for an item (section or question) in a contact evaluation.
Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.
Double percentage
The score percentage for an item in a contact evaluation.
Boolean notApplicable
The flag to mark the item as not applicable for scoring.
Boolean automaticFail
The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.
String evaluationId
A unique identifier for the contact evaluation.
String evaluationArn
The Amazon Resource Name (ARN) for the contact evaluation resource.
String evaluationFormTitle
A title of the evaluation form.
String evaluationFormId
The unique identifier for the evaluation form.
String status
The status of the contact evaluation.
String evaluatorArn
The Amazon Resource Name (ARN) of the user who last updated the evaluation.
EvaluationScore score
The overall score of the contact evaluation.
Date createdTime
The timestamp for when the evaluation was created.
Date lastModifiedTime
The timestamp for when the evaluation was last updated.
String name
The name.
AttributeCondition attributeCondition
An object to specify the predefined attribute condition.
List<E> andExpression
List of routing expressions which will be AND-ed together.
List<E> orExpression
List of routing expressions which will be OR-ed together.
String id
Unique identifier of a field.
FieldValueUnion value
Union of potential field value types.
Boolean booleanValue
A Boolean number value type.
Double doubleValue
a Double number value type.
EmptyFieldValue emptyValue
An empty value.
String stringValue
String value type.
List<E> queues
The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues
per request. The GetCurrentMetricsData API in particular requires a queue when you include a
Filter in your request.
List<E> channels
The channel to use to filter the metrics.
List<E> routingProfiles
A list of up to 100 routing profile IDs or ARNs.
List<E> routingStepExpressions
A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.
String filterKey
The key to use for filtering data. For example, QUEUE, ROUTING_PROFILE, AGENT,
CHANNEL, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO,
AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR,
AGENT_HIERARCHY_LEVEL_FIVE. There must be at least 1 key and a maximum 5 keys.
List<E> filterValues
The identifiers to use for filtering data. For example, if you have a filter key of QUEUE, you would
add queue IDs or ARNs in FilterValues.
String instanceId
The unique identifier of the Connect instance.
String fileId
The unique identifier of the attached file resource.
Integer urlExpiryInSeconds
Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
String associatedResourceArn
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
String fileArn
The unique identifier of the attached file resource (ARN).
String fileId
The unique identifier of the attached file resource.
String creationTime
The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format:
yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
String fileStatus
The current status of the attached file.
String fileName
A case-sensitive name of the attached file being uploaded.
Long fileSizeInBytes
The size of the attached file in bytes.
String associatedResourceArn
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
String fileUseCaseType
The use case for the file.
CreatedByInfo createdBy
Represents the identity that created the file.
DownloadUrlMetadata downloadUrlMetadata
URL and expiry to be used when downloading the attached file.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example,
{ "Tags": {"key1":"value1", "key2":"value2"} }.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Filters filters
The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
RoutingStepExpressions: 50
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
When using the RoutingStepExpression filter, you need to pass exactly one QueueId. The
filter is also case sensitive so when using the RoutingStepExpression filter, grouping by
ROUTING_STEP_EXPRESSION is required.
Currently tagging is only supported on the resources that are passed in the filter.
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. VOICE, CHAT, and TASK channels are
supported.
If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
If no Grouping is included in the request, a summary of metrics is returned.
When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is
required.
List<E> currentMetrics
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
When the filter RoutingStepExpression is used, this metric is still calculated from enqueue time.
For example, if a contact that has been queued under <Expression 1> for 10 seconds has expired
and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for this queue will be
counted starting from 10, not 0.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
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 maximum number of results to return per page.
List<E> sortCriteria
The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources
are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted based on
the input metrics.
Note the following:
Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
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.
Long approximateTotalCount
The total count of the result, regardless of the current page size.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
UserDataFilters filters
The filters to apply to returned user data. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Agents: 100
Contact states: 9
User hierarchy groups: 1
The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
Currently tagging is only supported on the resources that are passed in the filter.
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 maximum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Credentials credentials
The credentials to use for federation.
String signInUrl
The URL to sign into the user's instance.
String userArn
The Amazon Resource Name (ARN) of the user.
String userId
The identifier for the user. This can be the ID or the ARN of the user.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String resourceId
The identifier of the resource.
String resourceType
A valid resource type.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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. VOICE, CHAT, and TASK channels are supported.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
To filter by Queues, enter the queue ID/ARN, not the name of the queue.
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.
If no grouping is specified, a summary of metrics for all queues is returned.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
List<E> historicalMetrics
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
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
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For
Comparison, you must enter LT (for "Less than").
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 maximum 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 resourceArn
The Amazon Resource Name (ARN) of the resource. This includes the instanceId an 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 before the end time timestamp. The start and end time depends on the
IntervalPeriod selected. By default the time range between start and end time is 35 days. Historical
metrics are available for 3 months.
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 later than the start time timestamp. It cannot be later than the current timestamp.
IntervalDetails interval
The interval period and timezone to apply to returned metrics.
IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod
values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY |
WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and
EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is
aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL
interval period.
The following list describes restrictions on StartTime and EndTime based on which
IntervalPeriod is requested.
FIFTEEN_MIN: The difference between StartTime and EndTime must be less
than 3 days.
THIRTY_MIN: The difference between StartTime and EndTime must be less than
3 days.
HOUR: The difference between StartTime and EndTime must be less than 3
days.
DAY: The difference between StartTime and EndTime must be less than 35
days.
WEEK: The difference between StartTime and EndTime must be less than 35
days.
TOTAL: The difference between StartTime and EndTime must be less than 35
days.
TimeZone: The timezone applied to requested metrics.
List<E> filters
The filters to apply to returned metrics. You can filter on the following resources:
Agents
Channels
Feature
Queues
Routing profiles
Routing step expression
User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys:
AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO |
AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR |
AGENT_HIERARCHY_LEVEL_FIVE | CASE_TEMPLATE_ARN | CASE_STATUS |
CHANNEL | contact/segmentAttributes/connect:Subtype | FEATURE |
FLOW_TYPE | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID |
FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | INITIATION_METHOD |
RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION |
QUEUE | Q_CONNECT_ENABLED |
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are
valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter
values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a
total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter
key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat, connect:SMS, connect:Telephony, and
connect:WebRTC are valid filterValue examples (not exhaustive) for the
contact/segmentAttributes/connect:Subtype filter key.
ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is
case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be
kept as is.
Q_CONNECT_ENABLED. TRUE and FALSE are the only valid filterValues for the
Q_CONNECT_ENABLED filter key.
TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
This filter is available only for contact record-driven metrics.
List<E> groupings
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE |
AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE |
AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE |
CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL |
contact/segmentAttributes/connect:Subtype | FLOWS_RESOURCE_ID |
FLOWS_MODULE_RESOURCE_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE |
INITIATION_METHOD | Q_CONNECT_ENABLED | QUEUE |
RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION
List<E> metrics
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as
INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK |
API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Metric filter:
Valid values: API| Incoming | Outbound | Transfer |
Callback | Queue_Transfer| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For
Comparison, you must enter LT (for "Less than").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For
Comparison, you must enter LT (for "Less than").
UI name: Contacts answered in X seconds
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For
Comparison, you must enter LT (for "Less than").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For
Comparison, you must enter LT (for "Less than").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as
INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK |
API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
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 maximum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String promptId
A unique identifier for the prompt.
String promptPresignedUrl
A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String taskTemplateId
A unique identifier for the task template.
String snapshotVersion
The system generated version of a task template that is associated with a task, when the task is created.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String id
A unique identifier for the task template.
String arn
The Amazon Resource Name (ARN).
String name
The name of the task template.
String description
The description of the task template.
String contactFlowId
The identifier of the flow that runs by default when a task is created by referencing this template.
TaskTemplateConstraints constraints
Constraints that are applicable to the fields listed.
TaskTemplateDefaults defaults
The default values for fields when a task is created by referencing this template.
List<E> fields
Fields that are part of the template.
String status
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be
created from ACTIVE templates. If a template is marked as INACTIVE, then a task that
refers to this template cannot be created.
Date lastModifiedTime
The timestamp when the task template was last modified.
Date createdTime
The timestamp when the task template was created.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String id
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
TelephonyConfig telephonyConfig
The distribution of traffic between the instance and its replicas.
String id
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
String arn
The Amazon Resource Name (ARN) of the traffic distribution group.
SignInConfig signInConfig
The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
AgentConfig agentConfig
The distribution of agents between the instance and its replica(s).
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.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
AgentHierarchyGroup level1
The group at level one of the agent hierarchy.
AgentHierarchyGroup level2
The group at level two of the agent hierarchy.
AgentHierarchyGroup level3
The group at level three of the agent hierarchy.
AgentHierarchyGroup level4
The group at level four of the agent hierarchy.
AgentHierarchyGroup level5
The group at level five of the agent hierarchy.
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.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String id
The identifier of the hierarchy level.
String arn
The Amazon Resource Name (ARN) of the hierarchy level.
String name
The name of the hierarchy level.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String name
The name of the user hierarchy level. Must not be more than 50 characters.
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.
HierarchyGroupSummaryReference levelOne
Information about level one.
HierarchyGroupSummaryReference levelTwo
Information about level two.
HierarchyGroupSummaryReference levelThree
Information about level three.
HierarchyGroupSummaryReference levelFour
Information about level four.
HierarchyGroupSummaryReference 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.
HierarchyLevelUpdate levelOne
The update for level one.
HierarchyLevelUpdate levelTwo
The update for level two.
HierarchyLevelUpdate levelThree
The update for level three.
HierarchyLevelUpdate levelFour
The update for level four.
HierarchyLevelUpdate levelFive
The update for 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 hoursOfOperationId
The identifier for the hours of operation.
String hoursOfOperationArn
The Amazon Resource Name (ARN) for the hours of operation.
String name
The name for the hours of operation.
String description
The description for the hours of operation.
String timeZone
The time zone for the hours of operation.
List<E> config
Configuration information for the hours of operation.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String day
The day that the hours of operation applies to.
HoursOfOperationTimeSlice startTime
The start time that your contact center opens.
HoursOfOperationTimeSlice endTime
The end time that your contact center closes.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
StringCondition stringCondition
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name, description,
timezone, and resourceID.
ControlPlaneTagFilter tagFilter
String id
The identifier of the hours of operation.
String arn
The Amazon Resource Name (ARN) of the hours of operation.
String name
The name of the hours of operation.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String sourcePhoneNumberArn
The claimed phone number ARN being imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number to import from Amazon Pinpoint.
String phoneNumberDescription
The description of the phone number.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String id
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String arn
The Amazon Resource Name (ARN) of the instance.
String identityManagementType
The identity management type.
String instanceAlias
The alias of instance.
Date createdTime
When the instance was created.
String serviceRole
The service role of the instance.
String instanceStatus
The state of the instance.
InstanceStatusReason statusReason
Relevant details why the instance was not successfully created.
Boolean inboundCallsEnabled
Whether inbound calls are enabled.
Boolean outboundCallsEnabled
Whether outbound calls are enabled.
String instanceAccessUrl
This URL allows contact center users to access the Amazon Connect admin website.
Map<K,V> tags
The tags of an instance.
String message
The message.
String associationId
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
String storageType
A valid storage type.
S3Config s3Config
The S3 bucket configuration.
KinesisVideoStreamConfig kinesisVideoStreamConfig
The configuration of the Kinesis video stream.
KinesisStreamConfig kinesisStreamConfig
The configuration of the Kinesis data stream.
KinesisFirehoseConfig kinesisFirehoseConfig
The configuration of the Kinesis Firehose delivery stream.
String id
The identifier of the instance.
String arn
The Amazon Resource Name (ARN) of the instance.
String identityManagementType
The identity management type of the instance.
String instanceAlias
The alias of the instance.
Date createdTime
When the instance was created.
String serviceRole
The service role of the instance.
String instanceStatus
The state of the instance.
Boolean inboundCallsEnabled
Whether inbound calls are enabled.
Boolean outboundCallsEnabled
Whether outbound calls are enabled.
String instanceAccessUrl
This URL allows contact center users to access the Amazon Connect admin website.
String integrationAssociationId
The identifier for the AppIntegration association.
String integrationAssociationArn
The Amazon Resource Name (ARN) for the AppIntegration association.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String integrationType
The integration type.
String integrationArn
The Amazon Resource Name (ARN) for the AppIntegration.
String sourceApplicationUrl
The URL for the external application.
String sourceApplicationName
The user-provided, friendly name for the external application.
String sourceType
The name of the source.
String timeZone
The timezone applied to requested metrics.
String intervalPeriod
IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod
values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY |
WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and
EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is
aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL
interval period.
The following list describes restrictions on StartTime and EndTime based on what
IntervalPeriod is requested.
FIFTEEN_MIN: The difference between StartTime and EndTime must be less
than 3 days.
THIRTY_MIN: The difference between StartTime and EndTime must be less than
3 days.
HOUR: The difference between StartTime and EndTime must be less than 3
days.
DAY: The difference between StartTime and EndTime must be less than 35
days.
WEEK: The difference between StartTime and EndTime must be less than 35
days.
TOTAL: The difference between StartTime and EndTime must be less than 35
days.
InvalidRequestExceptionReason reason
String attachedFileInvalidRequestExceptionReason
Reason why the StartAttachedFiledUpload request was invalid.
TaskTemplateFieldIdentifier id
Identifier of the invisible field.
String firehoseArn
The Amazon Resource Name (ARN) of the delivery stream.
String streamArn
The Amazon Resource Name (ARN) of the data stream.
String prefix
The prefix of the video stream.
Integer retentionPeriodHours
The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
The default value is 0, indicating that the stream does not persist data.
EncryptionConfig encryptionConfig
The encryption configuration.
String aliasArn
The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
List<E> agentStatusTypes
Available agent status types.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String dataSetId
The identifier of the dataset to get the association status.
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 maximum number of results to return per page.
List<E> results
An array of successful results: DataSetId, TargetAccountId,
ResourceShareId, ResourceShareArn. This is a paginated API, so nextToken
is given if there are more results to be returned.
String nextToken
If there are additional results, this is the token for the next set of results.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
String lexVersion
The version of Amazon Lex or Amazon Lex V2.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact in this instance of Amazon Connect.
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.
This is not expected to be set because the value returned in the previous response is always null.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
String contactFlowModuleState
The state of the flow module.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
List<E> contactFlowTypes
The type of 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 maximum number of results to return per page. The default MaxResult size is 100.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the initial contact.
List<E> referenceTypes
The type of reference.
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.
This is not expected to be set, because the value returned in the previous response is always null.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String languageCode
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
Integer maxResults
The maximum number of results to return per page.
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.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Integer maxResults
The maximum number of results to return per page.
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.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String evaluationFormId
The unique identifier for the evaluation form.
Integer maxResults
The maximum number of results to return per page.
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.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String resourceType
A valid resource type.
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 maximum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page. The default MaxResult size is 100.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String resourceType
A valid resource type.
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 maximum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String integrationType
The integration type.
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 maximum number of results to return per page.
String integrationArn
The Amazon Resource Name (ARN) of the integration.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page. If no value is specified, the default is 10.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
List<E> phoneNumberTypes
The type of phone number.
We recommend using ListPhoneNumbersV2
to return phone number types. While ListPhoneNumbers returns number types UIFN, SHARED,
THIRD_PARTY_TF, and THIRD_PARTY_DID, it incorrectly lists them as
TOLL_FREE or DID.
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 maximum number of results to return per page. The default MaxResult size is 100.
String phoneNumberId
A unique identifier for the phone number.
String phoneNumberArn
The Amazon Resource Name (ARN) of the phone number.
String phoneNumber
The phone number. Phone numbers are formatted
[+] [country code] [subscriber number including area code].
String phoneNumberCountryCode
The ISO country code.
String phoneNumberType
The type of phone number.
String targetArn
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
String instanceId
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String phoneNumberDescription
The description of the phone number.
String sourcePhoneNumberArn
The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.
String targetArn
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number
inbound traffic is routed through. If both TargetArn and InstanceId input are not
provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the
same Amazon Web Services Region as the request.
String instanceId
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in
the Amazon Resource Name (ARN) of the instance. If both TargetArn and InstanceId are
not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the
same AWS Region as the request.
Integer maxResults
The maximum number of results to return per page.
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.
List<E> phoneNumberCountryCodes
The ISO country code.
List<E> phoneNumberTypes
The type of phone number.
String phoneNumberPrefix
The prefix of the phone number. If provided, it must contain + as part of the country code.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum 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 maximum number of results to return per page. The default MaxResult size is 100.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String queueId
The identifier for the 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 maximum number of results to return per page. The default MaxResult size is 100.
String nextToken
If there are additional results, this is the token for the next set of results.
List<E> quickConnectSummaryList
Information about the quick connects.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page. The default MaxResult size is 100.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page. The default MaxResult size is 100.
List<E> quickConnectTypes
The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact in this instance of Amazon Connect.
Integer maxResults
The maximum number of results to return per page.
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.
String outputType
The Contact Lens output type to be returned.
List<E> segmentTypes
Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.
String channel
The channel of the contact. Voice will not be returned.
String status
Status of real-time contact analysis.
List<E> segments
An analyzed transcript or category.
String nextToken
If there are additional results, this is the token for the next set of results.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String routingProfileId
The identifier of the routing profile.
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 maximum number of results to return per page. The default MaxResult size is 100.
String nextToken
If there are additional results, this is the token for the next set of results.
List<E> routingProfileQueueConfigSummaryList
Information about the routing profiles.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page. The default MaxResult size is 100.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String publishStatus
The publish status of the rule.
String eventSourceName
The name of the event source.
Integer maxResults
The maximum number of results to return per page.
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.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
String securityProfileId
The identifier for the security profle.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
List<E> applications
A list of the third-party application's metadata.
String nextToken
If there are additional results, this is the token for the next set of results.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String securityProfileId
The identifier for the security profle.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
List<E> permissions
The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile permissions.
String nextToken
If there are additional results, this is the token for the next set of results.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page. The default MaxResult size is 100.
String resourceArn
The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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.
It is not expected that you set this because the value returned in the previous response is always null.
Integer maxResults
The maximum number of results to return per page.
It is not expected that you set this.
String status
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be
created from ACTIVE templates. If a template is marked as INACTIVE, then a task that
refers to this template cannot be created.
String name
The name of the task template.
Integer maxResults
The maximum number of results to return per page.
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.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String trafficDistributionGroupId
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
Integer maxResults
The maximum number of results to return per page.
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.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String integrationAssociationId
The identifier for the integration association.
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 maximum number of results to return per page.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page. The default MaxResult size is 100.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String userId
The identifier of the user account.
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 maximum number of results to return per page.
String nextToken
If there are additional results, this is the token for the next set of results.
List<E> userProficiencyList
Information about the user proficiencies.
Date lastModifiedTime
The last time that the user's proficiencies are were modified.
String lastModifiedRegion
The region in which a user's proficiencies were last modified.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page. The default MaxResult size is 100.
String instanceId
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
String type
The type of the view.
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 maximum number of results to return per page. The default MaxResult size is 100.
String instanceId
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
String viewId
The identifier of the view. Both ViewArn and ViewId can be used.
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 maximum number of results to return per page. The default MaxResult size is 100.
String channel
The channels that agents can handle in the Contact Control Panel (CCP).
Integer concurrency
The number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE: Minimum value of 1. Maximum value of 1.
Valid Range for CHAT: Minimum value of 1. Maximum value of 10.
Valid Range for TASK: Minimum value of 1. Maximum value of 10.
CrossChannelBehavior crossChannelBehavior
Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.
String audioHostUrl
The audio host URL.
String audioFallbackUrl
The audio fallback URL.
String signalingUrl
The signaling URL.
String turnControlUrl
The turn control URL.
String eventIngestionUrl
The event ingestion URL to which you send client meeting events.
String mediaRegion
The Amazon Web Services Region in which you create the meeting.
MediaPlacement mediaPlacement
The media placement for the meeting.
MeetingFeaturesConfiguration meetingFeatures
The configuration settings of the features available to a meeting.
String meetingId
The Amazon Chime SDK meeting ID.
AudioFeatures audio
The configuration settings for the audio features available to a meeting.
String metricFilterKey
The key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON. These are the same
values as the InitiationMethod and DisconnectReason in the contact record. For more
information, see ContactTraceRecord in the Amazon Connect Administrator Guide.
List<E> metricFilterValues
The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD: INBOUND | OUTBOUND |
TRANSFER | QUEUE_TRANSFER | CALLBACK | API
Valid metric filter values for DISCONNECT_REASON: CUSTOMER_DISCONNECT |
AGENT_DISCONNECT | THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM |
BARGED | CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED |
API
Boolean negate
The flag to use to filter on requested metric filter values or to not filter on requested metric filter values.
By default the negate is false, which indicates to filter on the requested metric filter.
String interval
The interval period provided in the API request.
Date startTime
The timestamp, in UNIX Epoch time format. Start time is based on the interval period selected.
Date endTime
The timestamp, in UNIX Epoch time format. End time is based on the interval period selected. For example, If
IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime
in the API request differs by 1 day, then 48 results are returned in the response. Each result is aggregated by
the 30 minutes period, with each StartTime and EndTime differing by 30 minutes.
String instanceId
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
String contactId
The identifier of the contact.
String userId
The identifier of the user account.
List<E> allowedMonitorCapabilities
Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
List<E> supportedMessagingContentTypes
The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and
application/vnd.amazonaws.connect.message.interactive.response.
Content types must always contain text/plain. You can then put any other supported type in the
list. For example, all the following lists are valid because they contain text/plain:
[text/plain, text/markdown, application/json], [text/markdown, text/plain],
[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].
ParticipantDetails participantDetails
Map<K,V> attributes
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in 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.
ChatStreamingConfiguration streamingConfiguration
String label
The property label of the automation.
String video
The configuration having the video sharing capabilities for participants over the call.
String displayName
Display name of the participant.
String participantRole
The role of the participant in the chat conversation.
String timerType
The type of timer. IDLE indicates the timer applies for considering a human chat participant as
idle. DISCONNECT_NONCUSTOMER indicates the timer applies to automatically disconnecting a chat
participant due to idleness.
ParticipantTimerValue timerValue
The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
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 expiry
The expiration of the token. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
String rehydrationType
The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the
specified past ended chat session. To use this type, provide the initialContactId of the past ended
chat session in the sourceContactId field. In this type, Amazon Connect determines the most recent
chat contact on the specified chat session that has ended, and uses it to start a persistent chat.
FROM_SEGMENT: Rehydrates a chat from the past chat contact that is specified in the
sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
String sourceContactId
The contactId from which a persistent chat session must be started.
String phoneNumber
The phone number in E.164 format.
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 name
The name of the predefined attribute.
PredefinedAttributeValues values
The values of the predefined attribute.
Date lastModifiedTime
Last modified time.
String lastModifiedRegion
Last modified region.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
StringCondition stringCondition
String message
The problem detail's message.
String promptARN
The Amazon Resource Name (ARN) of the prompt.
String promptId
A unique identifier for the prompt.
String name
The name of the prompt.
String description
The description of the prompt.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
StringCondition stringCondition
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name, description, and
resourceID.
ControlPlaneTagFilter tagFilter
String id
The identifier of the prompt.
String arn
The Amazon Resource Name (ARN) of the prompt.
String name
The name of the prompt.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String userId
The identifier of the user.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String agentStatusId
The identifier of the agent status.
AgentQualityMetrics agent
Information about the quality of Agent media connection.
CustomerQualityMetrics customer
Information about the quality of Customer media connection.
String name
The name of the queue.
String queueArn
The Amazon Resource Name (ARN) for the queue.
String queueId
The identifier for the queue.
String description
The description of the queue.
OutboundCallerConfig outboundCallerConfig
The outbound caller ID name, number, and outbound whisper flow.
String hoursOfOperationId
The identifier for the hours of operation.
Integer maxContacts
The maximum number of contacts that can be in the queue before it is considered full.
String status
The status of the queue.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
StringCondition stringCondition
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name, description, and
resourceID.
String queueTypeCondition
The type of queue.
ControlPlaneTagFilter tagFilter
String id
The identifier of the queue.
String arn
The Amazon Resource Name (ARN) of the queue.
String name
The name of the queue.
String queueType
The type of queue.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String quickConnectARN
The Amazon Resource Name (ARN) of the quick connect.
String quickConnectId
The identifier for the quick connect.
String name
The name of the quick connect.
String description
The description.
QuickConnectConfig quickConnectConfig
Contains information about the quick connect.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String quickConnectType
The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
UserQuickConnectConfig userConfig
The user configuration. This is required only if QuickConnectType is USER.
QueueQuickConnectConfig queueConfig
The queue configuration. This is required only if QuickConnectType is QUEUE.
PhoneNumberQuickConnectConfig phoneConfig
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
StringCondition stringCondition
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name, description, and
resourceID.
ControlPlaneTagFilter tagFilter
String id
The identifier for the quick connect.
String arn
The Amazon Resource Name (ARN) of the quick connect.
String name
The name of the quick connect.
String quickConnectType
The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
TaskTemplateFieldIdentifier id
Identifier of the read-only field.
String attachmentName
A case-sensitive name of the attachment being uploaded. Can be redacted.
String contentType
Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
String attachmentId
A unique identifier for the attachment.
String status
Status of the attachment.
RealTimeContactAnalysisSegmentTranscript transcript
RealTimeContactAnalysisSegmentCategories categories
RealTimeContactAnalysisSegmentIssues issues
RealTimeContactAnalysisSegmentEvent event
RealTimeContactAnalysisSegmentAttachments attachments
The analyzed attachments.
String id
The identifier of the segment.
String participantId
The identifier of the participant.
String participantRole
The role of the participant. For example, is it a customer, agent, or system.
String displayName
The display name of the participant. Can be redacted.
List<E> attachments
List of objects describing an individual attachment.
RealTimeContactAnalysisTimeData time
Field describing the time of the event. It can have different representations of time.
String id
The identifier of the contact event.
String participantId
The identifier of the participant.
String participantRole
The role of the participant. For example, is it a customer, agent, or system.
String displayName
The display name of the participant. Can be redacted.
String eventType
Type of the event. For example, application/vnd.amazonaws.connect.event.participant.left.
RealTimeContactAnalysisTimeData time
Field describing the time of the event. It can have different representations of time.
String id
The identifier of the transcript.
String participantId
The identifier of the participant.
String participantRole
The role of the participant. For example, is it a customer, agent, or system.
String displayName
The display name of the participant.
String content
The content of the transcript. Can be redacted.
String contentType
The type of content of the item. For example, text/plain.
RealTimeContactAnalysisTimeData time
Field describing the time of the event. It can have different representations of time.
RealTimeContactAnalysisTranscriptItemRedaction redaction
Object describing redaction that was applied to the transcript. If transcript has the field it means part of the transcript was redacted.
String sentiment
The sentiment detected for this piece of transcript.
Date absoluteTime
Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
String id
Transcript identifier. Matches the identifier from one of the TranscriptSegments.
RealTimeContactAnalysisCharacterInterval characterOffsets
List of character intervals within transcript content/text.
String content
Part of the transcript content that contains identified issue. Can be redacted
String id
Transcript identifier. Matches the identifier from one of the TranscriptSegments.
RealTimeContactAnalysisCharacterInterval characterOffsets
UrlReference url
Information about the reference when the referenceType is URL. Otherwise, null.
AttachmentReference attachment
Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.
StringReference string
Information about a reference when the referenceType is STRING. Otherwise, null.
NumberReference number
Information about a reference when the referenceType is NUMBER. Otherwise, null.
DateReference date
Information about a reference when the referenceType is DATE. Otherwise, null.
EmailReference email
Information about a reference when the referenceType is EMAIL. Otherwise, null.
String phoneNumberId
A unique identifier for the phone number.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in
the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId, or the entire ARN.
String replicaRegion
The Amazon Web Services Region where to replicate the Amazon Connect instance.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String replicaAlias
The alias for the replicated instance. The ReplicaAlias must be unique.
TaskTemplateFieldIdentifier id
The unique identifier for the field.
TagSearchCondition tagSearchCondition
The search criteria to be used to return tags.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact.
String initialContactId
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
List<E> steps
List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
Date activationTimestamp
The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.
Integer index
Information about the index of the routing criteria.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the routing profile.
String routingProfileArn
The Amazon Resource Name (ARN) of the routing profile.
String routingProfileId
The identifier of the routing profile.
String description
The description of the routing profile.
List<E> mediaConcurrencies
The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
String defaultOutboundQueueId
The identifier of the default outbound queue for this routing profile.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Long numberOfAssociatedQueues
The number of associated queues in routing profile.
Long numberOfAssociatedUsers
The number of associated users in routing profile.
String agentAvailabilityTimer
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
Boolean isDefault
Whether this a default routing profile.
List<E> associatedQueueIds
The IDs of the associated queue.
RoutingProfileQueueReference queueReference
Contains information about a queue resource.
Integer priority
The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.
Integer delay
The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.
String queueId
The identifier for the queue.
String queueArn
The Amazon Resource Name (ARN) of the queue.
String queueName
The name of the queue.
Integer priority
The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.
Integer delay
The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.
String channel
The channels this queue supports.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
StringCondition stringCondition
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are associatedQueueIds, name,
description, and resourceID.
ControlPlaneTagFilter tagFilter
String id
The identifier of the routing profile.
String arn
The Amazon Resource Name (ARN) of the routing profile.
String name
The name of the routing profile.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String name
The name of the rule.
String ruleId
A unique identifier for the rule.
String ruleArn
The Amazon Resource Name (ARN) of the rule.
RuleTriggerEventSource triggerEventSource
The event source to trigger the rule.
String function
The conditions of the rule.
List<E> actions
A list of actions to be run when the rule is triggered.
String publishStatus
The publish status of the rule.
Date createdTime
The timestamp for when the rule was created.
Date lastUpdatedTime
The timestamp for the when the rule was last updated.
String lastUpdatedBy
The Amazon Resource Name (ARN) of the user who last updated the rule.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String actionType
The type of action that creates a rule.
TaskActionDefinition taskAction
Information about the task action. This field is required if TriggerEventSource is one of the
following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |
OnSalesforceCaseCreate
EventBridgeActionDefinition eventBridgeAction
Information about the EventBridge action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable |
OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable |
OnPostChatAnalysisAvailable | OnContactEvaluationSubmit |
OnMetricDataUpdate
AssignContactCategoryActionDefinition assignContactCategoryAction
Information about the contact category action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable |
OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable |
OnPostChatAnalysisAvailable | OnZendeskTicketCreate |
OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
SendNotificationActionDefinition sendNotificationAction
Information about the send notification action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable |
OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable |
OnPostChatAnalysisAvailable | OnContactEvaluationSubmit |
OnMetricDataUpdate
CreateCaseActionDefinition createCaseAction
Information about the create case action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable |
OnPostChatAnalysisAvailable.
UpdateCaseActionDefinition updateCaseAction
Information about the update case action.
Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.
EndAssociatedTasksActionDefinition endAssociatedTasksAction
Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate.
SubmitAutoEvaluationActionDefinition submitAutoEvaluationAction
Information about the submit automated evaluation action.
String name
The name of the rule.
String ruleId
A unique identifier for the rule.
String ruleArn
The Amazon Resource Name (ARN) of the rule.
String eventSourceName
The name of the event source.
String publishStatus
The publish status of the rule.
List<E> actionSummaries
A list of ActionTypes associated with a rule.
Date createdTime
The timestamp for when the rule was created.
Date lastUpdatedTime
The timestamp for when the rule was last updated.
String bucketName
The S3 bucket name.
String bucketPrefix
The S3 bucket prefix.
EncryptionConfig encryptionConfig
The Amazon S3 encryption configuration.
String targetArn
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number
inbound traffic is routed through. You must enter InstanceId or TargetArn.
String instanceId
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in
the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
String phoneNumberCountryCode
The ISO country code.
String phoneNumberType
The type of phone number.
String phoneNumberPrefix
The prefix of the phone number. If provided, it must contain + as part of the country code.
Integer maxResults
The maximum number of results to return per page.
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.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
ContactFlowModuleSearchFilter searchFilter
Filters to be applied to search results.
ContactFlowModuleSearchCriteria searchCriteria
The search criteria to be used to return contact flow modules.
The name and description fields support "contains" queries with a minimum of 2
characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result
in invalid results.
List<E> contactFlowModules
The search criteria to be used to return contact flow modules.
String nextToken
If there are additional results, this is the token for the next set of results.
Long approximateTotalCount
The total number of contact flows which matched your search query.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
ContactFlowSearchFilter searchFilter
Filters to be applied to search results.
ContactFlowSearchCriteria searchCriteria
The search criteria to be used to return flows.
The name and description fields support "contains" queries with a minimum of 2
characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result
in invalid results.
String instanceId
The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
SearchContactsTimeRange timeRange
Time range that you want to search results.
SearchCriteria searchCriteria
The search criteria to be used to return contacts.
Integer maxResults
The maximum number of results to return per page.
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.
Sort sort
Specifies a field to sort by and a sort order.
List<E> agentIds
The identifiers of agents who handled the contacts.
AgentHierarchyGroups agentHierarchyGroups
The agent hierarchy groups of the agent at the time of handling the contact.
List<E> channels
The list of channels associated with contacts.
ContactAnalysis contactAnalysis
Search criteria based on analysis outputs from Amazon Connect Contact Lens.
List<E> initiationMethods
The list of initiation methods associated with contacts.
List<E> queueIds
The list of queue IDs associated with contacts.
SearchableContactAttributes searchableContactAttributes
The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by customer contact attributes in the Amazon Connect Administrator Guide.
To use SearchableContactAttributes in a search request, the GetContactAttributes action
is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions
-as-permissionsActions defined by Amazon Connect.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
HoursOfOperationSearchFilter searchFilter
Filters to be applied to search results.
HoursOfOperationSearchCriteria searchCriteria
The search criteria to be used to return hours of operations.
List<E> hoursOfOperations
Information about the hours of operations.
String nextToken
If there are additional results, this is the token for the next set of results.
Long approximateTotalCount
The total number of hours of operations which matched your search query.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
PredefinedAttributeSearchCriteria searchCriteria
The search criteria to be used to return predefined attributes.
List<E> predefinedAttributes
Predefined attributes matched by the search criteria.
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.
Long approximateTotalCount
The approximate number of predefined attributes which matched your search query.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
PromptSearchFilter searchFilter
Filters to be applied to search results.
PromptSearchCriteria searchCriteria
The search criteria to be used to return prompts.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
QueueSearchFilter searchFilter
Filters to be applied to search results.
QueueSearchCriteria searchCriteria
The search criteria to be used to return queues.
The name and description fields support "contains" queries with a minimum of 2
characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw
invalid results.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
QuickConnectSearchFilter searchFilter
Filters to be applied to search results.
QuickConnectSearchCriteria searchCriteria
The search criteria to be used to return quick connects.
String instanceId
The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance.
List<E> resourceTypes
The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.
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 maximum number of results to return per page.
ResourceTagsSearchCriteria searchCriteria
The search criteria to be used to return tags.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
RoutingProfileSearchFilter searchFilter
Filters to be applied to search results.
RoutingProfileSearchCriteria searchCriteria
The search criteria to be used to return routing profiles.
The name and description fields support "contains" queries with a minimum of 2
characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw
invalid results.
List<E> routingProfiles
Information about the routing profiles.
String nextToken
If there are additional results, this is the token for the next set of results.
Long approximateTotalCount
The total number of routing profiles which matched your search query.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page.
SecurityProfileSearchCriteria searchCriteria
The search criteria to be used to return security profiles.
The name field support "contains" queries with a minimum of 2 characters and maximum of 25
characters. Any queries with character lengths outside of this range will throw invalid results.
The currently supported value for FieldName: name
SecurityProfilesSearchFilter searchFilter
Filters to be applied to search results.
List<E> securityProfiles
Information about the security profiles.
String nextToken
If there are additional results, this is the token for the next set of results.
Long approximateTotalCount
The total number of security profiles which matched your search query.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
InstanceID is a required field. The "Required: No" below is incorrect.
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 maximum number of results to return per page.
UserSearchFilter searchFilter
Filters to be applied to search results.
UserSearchCriteria searchCriteria
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Integer maxResults
The maximum number of results to return per page.
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.
String state
The current state of the custom vocabulary.
String nameStartsWith
The starting pattern of the name of the vocabulary.
String languageCode
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
String id
The identifier for the security profile.
String organizationResourceId
The organization resource identifier for the security profile.
String arn
The Amazon Resource Name (ARN) for the secruity profile.
String securityProfileName
The name for the security profile.
String description
The description of the security profile.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Map<K,V> allowedAccessControlTags
The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
List<E> tagRestrictedResources
The list of resources that a security profile applies tag restrictions to in Amazon Connect.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
List<E> hierarchyRestrictedResources
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are
acceptable ResourceNames: User.
String allowedAccessControlHierarchyGroupId
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
StringCondition stringCondition
String id
The identifier of the security profile.
String organizationResourceId
The organization resource identifier.
String arn
The Amazon Resource Name (ARN) of the security profile.
String securityProfileName
The name of the security profile.
String description
The description of the security profile.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
ControlPlaneTagFilter tagFilter
String id
The identifier of the security profile.
String arn
The Amazon Resource Name (ARN) of the security profile.
String name
The name of the security profile.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String valueString
The value of a segment attribute.
String sourceId
External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.
String destinationId
Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone number destination of inbound SMS messages represented by an Amazon Pinpoint phone number ARN.
String subtype
Classification of a channel. This is used in part to uniquely identify chat.
Valid value: ["connect:sms"]
ChatEvent event
Chat integration event payload
NewSessionDetails newSessionDetails
Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.
String initialContactId
Identifier of chat contact used to handle integration event. This may be null if the integration event is not valid without an already existing chat contact.
Boolean newChatCreated
Whether handling the integration event resulted in creating a new chat or acting on existing chat.
String deliveryMethod
Notification delivery method.
String subject
The subject of the email if the delivery method is EMAIL. Supports variable injection. For more
information, see JSONPath
reference in the Amazon Connect Administrators Guide.
String content
Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
String contentType
Content type format.
NotificationRecipientType recipient
Notification recipient.
String category
The category name, as defined in Rules.
String condition
The condition to apply for the automation option. If the condition is PRESENT, then the option is
applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT,
then the option is applied when the contact data does not include the category.
String optionRefId
The identifier of the answer option.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String instanceId
The unique identifier of the Connect instance.
String fileName
A case-sensitive name of the attached file being uploaded.
Long fileSizeInBytes
The size of the attached file in bytes.
Integer urlExpiryInSeconds
Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
String fileUseCaseType
The use case for the file.
String associatedResourceArn
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
CreatedByInfo createdBy
Represents the identity that created the file.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example,
{ "Tags": {"key1":"value1", "key2":"value2"} }.
String fileArn
The unique identifier of the attached file resource (ARN).
String fileId
The unique identifier of the attached file resource.
String creationTime
The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format:
yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
String fileStatus
The current status of the attached file.
CreatedByInfo createdBy
Represents the identity that created the file.
UploadUrlMetadata uploadUrlMetadata
Information to be used while uploading the attached file.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactFlowId
The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx
Map<K,V> attributes
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in 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. If you have a Lex bot in your flow, the initial message is not delivered to the Lex bot.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Integer chatDurationInMinutes
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
List<E> supportedMessagingContentTypes
The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and
application/vnd.amazonaws.connect.message.interactive.response.
Content types must always contain text/plain. You can then put any other supported type in the list.
For example, all the following lists are valid because they contain text/plain:
[text/plain, text/markdown, application/json], [text/markdown, text/plain],
[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].
The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.
PersistentChat persistentChat
Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
String relatedContactId
The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.
You cannot provide data for both RelatedContactId and PersistentChat.
Map<K,V> segmentAttributes
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide.
The types application/vnd.amazonaws.connect.message.interactive and
application/vnd.amazonaws.connect.message.interactive.response must be present in the
SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as {
"connect:Subtype": {"valueString" : "connect:Guide" }}.
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 continuedFromContactId
The contactId from which a persistent chat session is started. This field is populated only for persistent chats.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact in this instance of Amazon Connect.
String evaluationFormId
The unique identifier for the evaluation form.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact.
String initialContactId
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
VoiceRecordingConfiguration voiceRecordingConfiguration
The person being recorded.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
ChatStreamingConfiguration chatStreamingConfiguration
The streaming configuration, such as the Amazon SNS streaming endpoint.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String streamingId
The identifier of the streaming configuration enabled.
String name
The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
String description
A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).
Map<K,V> references
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following
reference types at the time of creation: URL | NUMBER | STRING |
DATE | EMAIL. ATTACHMENT is not a supported reference type during voice
contact creation.
String relatedContactId
The contactId that is related to this contact. Linking voice, task, or chat by using
RelatedContactID copies over contact attributes from the related contact to the new contact. All
updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no
limits to the number of contacts that can be linked by using RelatedContactId.
String destinationPhoneNumber
The phone number of the customer, in E.164 format.
String contactFlowId
The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
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 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 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.
AnswerMachineDetectionConfig answerMachineDetectionConfig
Configuration of the answering machine detection for this outbound call.
String campaignId
The campaign identifier of the outbound communication.
String trafficType
Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The
default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is
set to true. For all other cases, use GENERAL.
String contactId
The identifier of this contact within the Amazon Connect instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String previousContactId
The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task
contacts linked using the same PreviousContactID will affect every contact in the chain. There can
be a maximum of 12 linked task contacts in a chain.
String contactFlowId
The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx
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 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 name
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
Map<K,V> references
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
reference types at the time of creation: URL | NUMBER | STRING |
DATE | EMAIL. ATTACHMENT is not a supported reference type during task
creation.
String description
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Date scheduledTime
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
String taskTemplateId
A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
String quickConnectId
The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the
flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.
String relatedContactId
The contactId that is related to this contact.
Linking tasks together by using RelatedContactID copies over contact attributes from the related
task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited
to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID.
There are no limits to the number of contacts that can be linked by using RelatedContactId.
String contactId
The identifier of this contact within the Amazon Connect instance.
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 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, -, and _ characters.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
String contactFlowId
The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
AllowedCapabilities allowedCapabilities
Information about the video sharing capabilities of the participants (customer, agent).
ParticipantDetails participantDetails
String relatedContactId
The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
Map<K,V> references
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
reference types at the time of creation: URL | NUMBER | STRING |
DATE | EMAIL. ATTACHMENT is not a supported reference type during task
creation.
String description
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
ConnectionData connectionData
Information required for the client application (mobile application or website) to connect to the call.
String contactId
The identifier of the contact in this instance of Amazon Connect.
String participantId
The identifier for a contact participant. The ParticipantId for a contact participant is the same
throughout the contact lifecycle.
String participantToken
The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact participant.
Expiry expiry
An object to specify the expiration of a routing step.
Expression expression
A tagged union to specify expression for a routing step.
String status
Represents status of the Routing step.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact.
String initialContactId
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
String contactId
The ID of the contact.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
DisconnectReason disconnectReason
The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.
String streamingId
The identifier of the streaming configuration enabled.
String evaluationFormId
The identifier of the auto-evaluation enabled form.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String evaluationId
A unique identifier for the contact evaluation.
Map<K,V> answers
A map of question identifiers to answer value.
Map<K,V> notes
A map of question identifiers to note value.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact.
String initialContactId
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
String contactId
The identifier of the contact in this instance of Amazon Connect.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Map<K,V> tags
The tags to be assigned to the contact resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Authorization is not supported by this tag.
String tagKey
The tag key used in the tag search condition.
String tagValue
The tag value used in the tag search condition.
String tagKeyComparisonType
The type of comparison to be made when evaluating the tag key in tag search condition.
String tagValueComparisonType
The type of comparison to be made when evaluating the tag value in tag search condition.
String name
The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
String description
The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
String contactFlowId
The identifier of the flow.
Map<K,V> references
Information about the reference when the referenceType is URL. Otherwise, null.
(Supports variable injection in the Value field.)
TaskTemplateFieldIdentifier id
Identifier of a field.
String defaultValue
Default value for the field.
TaskTemplateFieldIdentifier id
The unique identifier for the field.
String description
The description of the field.
String type
Indicates the type of field.
List<E> singleSelectOptions
A list of options for a single select field.
String name
The name of the task template field.
String id
A unique identifier for the task template.
String arn
The Amazon Resource Name (ARN) of the task template.
String name
The name of the task template.
String description
The description of the task template.
String status
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be
created from ACTIVE templates. If a template is marked as INACTIVE, then a task that
refers to this template cannot be created.
Date lastModifiedTime
The timestamp when the task template was last modified.
Date createdTime
The timestamp when the task template was created.
String id
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
String arn
The Amazon Resource Name (ARN) of the traffic distribution group.
String name
The name of the traffic distribution group.
String description
The description of the traffic distribution group.
String instanceArn
The Amazon Resource Name (ARN).
String status
The status of the traffic distribution group.
CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.
ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.
CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.
PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.
DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.
UPDATE_IN_PROGRESS means the previous UpdateTrafficDistribution operation is still in progress and has not yet completed.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Boolean isDefault
Whether this is the default traffic distribution group created during instance replication. The default traffic
distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic
distribution group is deleted as part of the process for deleting a replica.
The SignInConfig distribution is available only on a default TrafficDistributionGroup
(see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified
SignInConfig and a non-default TrafficDistributionGroup, an
InvalidRequestException is returned.
String id
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
String arn
The Amazon Resource Name (ARN) of the traffic distribution group.
String name
The name of the traffic distribution group.
String instanceArn
The Amazon Resource Name (ARN) of the traffic distribution group.
String status
The status of the traffic distribution group.
CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.
ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.
CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.
PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.
DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.
UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.
Boolean isDefault
Whether this is the default traffic distribution group created during instance replication. The default traffic
distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic
distribution group is deleted as part of the process for deleting a replica.
String userId
The identifier for the user. This can be the ID or the ARN of the user.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact in this instance of Amazon Connect.
String queueId
The identifier for the queue.
String userId
The identifier for the user. This can be the ID or the ARN of the user.
String contactFlowId
The identifier of the flow.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String contactId
The identifier of the contact in this instance of Amazon Connect.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
List<E> tagKeys
A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String agentStatusId
The identifier of the agent status.
String name
The name of the agent status.
String description
The description of the agent status.
String state
The state of the agent status.
Integer displayOrder
The display order of the agent status.
Boolean resetOrderNumber
A number indicating the reset order of the agent status.
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. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Map<K,V> attributes
The Amazon Connect attributes. These attributes can be accessed in 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.
When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:
Remove unnecessary attributes by setting their values to empty.
If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the Amazon Connect Administrator Guide.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String evaluationId
A unique identifier for the contact evaluation.
Map<K,V> answers
A map of question identifiers to answer value.
Map<K,V> notes
A map of question identifiers to note value.
String instanceId
The identifier of the Amazon Connect instance.
String contactFlowId
The identifier of the flow.
String content
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactFlowId
The identifier of the flow.
String name
The name of the flow.
String description
The description of the flow.
String contactFlowState
The state of flow.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactFlowModuleId
The identifier of the flow module.
String content
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactFlowModuleId
The identifier of the flow module.
String name
The name of the flow module.
String description
The description of the flow module.
String state
The state of flow module.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.
String name
The name of the contact.
String description
The description of the contact.
Map<K,V> references
Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact in this instance of Amazon Connect.
Integer queueTimeAdjustmentSeconds
The number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue.
Long queuePriority
Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact.
Date scheduledTime
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String evaluationFormId
The unique identifier for the evaluation form.
Integer evaluationFormVersion
A version of the evaluation form to update.
Boolean createNewVersion
A flag indicating whether the operation must create a new version.
String title
A title of the evaluation form.
String description
The description of the evaluation form.
List<E> items
Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
EvaluationFormScoringStrategy scoringStrategy
A scoring strategy of the evaluation form.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String evaluationFormId
The unique identifier for the evaluation form.
String evaluationFormArn
The Amazon Resource Name (ARN) for the contact evaluation resource.
Integer evaluationFormVersion
The version of the updated evaluation form resource.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String hoursOfOperationId
The identifier of the hours of operation.
String name
The name of the hours of operation.
String description
The description of the hours of operation.
String timeZone
The time zone of the hours of operation.
List<E> config
Configuration information of the hours of operation.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String attributeType
The type of attribute.
Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.
String value
The value for the attribute. Maximum character limit is 100.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String associationId
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
String resourceType
A valid resource type.
InstanceStorageConfig storageConfig
ChatParticipantRoleConfig chat
Configuration information for the chat participant role.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String contactId
The identifier of the contact in this instance of Amazon Connect.
UpdateParticipantRoleConfigChannelInfo channelConfiguration
The Amazon Connect channel you want to configure.
String phoneNumberId
The Amazon Resource Name (ARN) or resource ID of the phone number.
String phoneNumberDescription
The description of the phone number.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String phoneNumberId
A unique identifier for the phone number.
String targetArn
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number
inbound traffic is routed through. You must enter InstanceId or TargetArn.
String instanceId
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in
the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the predefined attribute.
PredefinedAttributeValues values
The values of the predefined attribute.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String promptId
A unique identifier for the prompt.
String name
The name of the prompt.
String description
A description of the prompt.
String s3Uri
The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String queueId
The identifier for the queue.
String hoursOfOperationId
The identifier for the hours of operation.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String queueId
The identifier for the queue.
Integer maxContacts
The maximum number of contacts that can be in the queue before it is considered full.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String queueId
The identifier for the queue.
String name
The name of the queue.
String description
The description of the queue.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String queueId
The identifier for the queue.
OutboundCallerConfig outboundCallerConfig
The outbound caller ID name, number, and outbound whisper flow.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String queueId
The identifier for the queue.
String status
The status of the queue.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String quickConnectId
The identifier for the quick connect.
QuickConnectConfig quickConnectConfig
Information about the configuration settings for the quick connect.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String quickConnectId
The identifier for the quick connect.
String name
The name of the quick connect.
String description
The description of the quick connect.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String routingProfileId
The identifier of the routing profile.
String agentAvailabilityTimer
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String routingProfileId
The identifier of the routing profile.
List<E> mediaConcurrencies
The channels that agents can handle in the Contact Control Panel (CCP).
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String routingProfileId
The identifier of the routing profile.
String defaultOutboundQueueId
The identifier for the default outbound queue.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String routingProfileId
The identifier of the routing profile.
String name
The name of the routing profile. Must not be more than 127 characters.
String description
The description of the routing profile. Must not be more than 250 characters.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String routingProfileId
The identifier of the routing profile.
List<E> queueConfigs
The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.
String ruleId
A unique identifier for the rule.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the rule. You can change the name only if TriggerEventSource is one of the following
values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |
OnSalesforceCaseCreate
String function
The conditions of the rule.
List<E> actions
A list of actions to be run when the rule is triggered.
String publishStatus
The publish status of the rule.
String description
The description of the security profile.
List<E> permissions
The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.
String securityProfileId
The identifier for the security profle.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Map<K,V> allowedAccessControlTags
The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
List<E> tagRestrictedResources
The list of resources that a security profile applies tag restrictions to in Amazon Connect.
List<E> applications
A list of the third-party application's metadata.
List<E> hierarchyRestrictedResources
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are
acceptable ResourceNames: User.
String allowedAccessControlHierarchyGroupId
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
String taskTemplateId
A unique identifier for the task template.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String name
The name of the task template.
String description
The description of the task template.
String contactFlowId
The identifier of the flow that runs by default when a task is created by referencing this template.
TaskTemplateConstraints constraints
Constraints that are applicable to the fields listed.
TaskTemplateDefaults defaults
The default values for fields when a task is created by referencing this template.
String status
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be
created from ACTIVE templates. If a template is marked as INACTIVE, then a task that
refers to this template cannot be created.
List<E> fields
Fields that are part of the template.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String id
The identifier of the task template resource.
String arn
The Amazon Resource Name (ARN) for the task template resource.
String name
The name of the task template.
String description
The description of the task template.
String contactFlowId
The identifier of the flow that runs by default when a task is created by referencing this template.
TaskTemplateConstraints constraints
Constraints that are applicable to the fields listed.
TaskTemplateDefaults defaults
The default values for fields when a task is created by referencing this template.
List<E> fields
Fields that are part of the template.
String status
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be
created from ACTIVE templates. If a template is marked as INACTIVE, then a task that
refers to this template cannot be created.
Date lastModifiedTime
The timestamp when the task template was last modified.
Date createdTime
The timestamp when the task template was created.
String id
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
TelephonyConfig telephonyConfig
The distribution of traffic between the instance and its replica(s).
SignInConfig signInConfig
The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
AgentConfig agentConfig
The distribution of agents between the instance and its replica(s).
String name
The name of the hierarchy group. Must not be more than 100 characters.
String hierarchyGroupId
The identifier of the hierarchy group.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String hierarchyGroupId
The identifier of the hierarchy group.
String userId
The identifier of the user account.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
HierarchyStructureUpdate hierarchyStructure
The hierarchy levels to update.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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. You can find the instance ID in the Amazon Resource Name (ARN) of the 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. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String userId
The identifier of the user account.
List<E> userProficiencies
The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do this using AssociateUserProficiencies API.
String routingProfileId
The identifier of the routing profile for the user.
String userId
The identifier of the user account.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
List<E> securityProfileIds
The identifiers of the security profiles for the user.
String userId
The identifier of the user account.
String instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
String instanceId
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
String viewId
The identifier of the view. Both ViewArn and ViewId can be used.
String status
Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED
status will initiate validation on the content.
ViewInputContent content
View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.
The total uncompressed content has a maximum file size of 400kB.
View view
A view resource object. Contains metadata and content necessary to render the view.
String instanceId
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
String viewId
The identifier of the view. Both ViewArn and ViewId can be used.
String name
The name of the view.
String description
The description of the view.
String url
A pre-signed S3 URL that should be used for uploading the attached file.
String urlExpiry
The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format:
yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
Map<K,V> headersToInclude
A map of headers that should be provided when uploading the attached file.
String useCaseId
The identifier for the use case.
String useCaseArn
The Amazon Resource Name (ARN) for the use case.
String useCaseType
The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
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.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
UserReference user
Information about the user for the data that is returned. It contains the resourceId and ARN of the
user.
RoutingProfileReference routingProfile
Information about the routing profile that is assigned to the user.
HierarchyPathReference hierarchyPath
Contains information about the levels of a hierarchy group assigned to a user.
AgentStatusReference status
The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
Map<K,V> availableSlotsByChannel
A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
Map<K,V> maxSlotsByChannel
A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of
slots. This is calculated from MediaConcurrency of
the RoutingProfile assigned to the agent.
Map<K,V> activeSlotsByChannel
A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
List<E> contacts
A list of contact reference information.
String nextStatus
The Next status of the agent.
List<E> queues
A list of up to 100 queues or ARNs.
ContactFilter contactFilter
A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states.
List<E> routingProfiles
A list of up to 100 routing profile IDs or ARNs.
List<E> agents
A list of up to 100 agent IDs or ARNs.
List<E> userHierarchyGroups
A UserHierarchyGroup ID or ARN.
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.
String secondaryEmail
The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.
Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}
String mobile
The user's mobile number.
String phoneType
The phone type.
Boolean autoAccept
The Auto accept setting.
Integer afterContactWorkTimeLimit
The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.
When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in
milliseconds.
String deskPhoneNumber
The phone number for the user's desk phone.
String attributeName
The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance.
String attributeValue
The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance.
Float level
The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
StringCondition stringCondition
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are Username, FirstName,
LastName, RoutingProfileId, SecurityProfileId, ResourceId.
HierarchyGroupCondition hierarchyGroupCondition
A leaf node condition which can be used to specify a hierarchy group condition.
ControlPlaneTagFilter tagFilter
ControlPlaneUserAttributeFilter userAttributeFilter
An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.
This accepts an OR of AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.
String arn
The Amazon Resource Name (ARN) of the user.
String directoryUserId
The directory identifier of the user.
String hierarchyGroupId
The identifier of the user's hierarchy group.
String id
The identifier of the user's summary.
UserIdentityInfoLite identityInfo
The user's first name and last name.
UserPhoneConfig phoneConfig
String routingProfileId
The identifier of the user's routing profile.
List<E> securityProfileIds
The identifiers of the user's security profiles.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String username
The name of the user.
String id
The identifier of the user account.
String arn
The Amazon Resource Name (ARN) of the user account.
String username
The Amazon Connect user name of the user account.
Date lastModifiedTime
The timestamp when this resource was last modified.
String lastModifiedRegion
The Amazon Web Services Region where this resource was last modified.
String id
The identifier of the view.
String arn
The Amazon Resource Name (ARN) of the view.
String name
The name of the view.
String status
Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED
status will initiate validation on the content.
String type
The type of the view - CUSTOMER_MANAGED.
String description
The description of the view.
Integer version
Current version of the view.
String versionDescription
The description of the version.
ViewContent content
View content containing all content necessary to render a view except for runtime input data.
Map<K,V> tags
The tags associated with the view resource (not specific to view version).
Date createdTime
The timestamp of when the view was created.
Date lastModifiedTime
Latest timestamp of the UpdateViewContent or CreateViewVersion operations.
String viewContentSha256
Indicates the checksum value of the latest published view content.
String id
The identifier of the view.
String arn
The Amazon Resource Name (ARN) of the view.
String name
The name of the view.
String type
The type of the view.
String status
Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED
status will initiate validation on the content.
String description
The description of the view.
String id
The identifier of the view version.
String arn
The Amazon Resource Name (ARN) of the view version.
String description
The description of the view version.
String name
The name of the view version.
String type
The type of the view version.
Integer version
The sequentially incremented version of the view version.
String versionDescription
The description of the view version.
String name
A unique name of the custom vocabulary.
String id
The identifier of the custom vocabulary.
String arn
The Amazon Resource Name (ARN) of the custom vocabulary.
String languageCode
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
String state
The current state of the custom vocabulary.
Date lastModifiedTime
The timestamp when the custom vocabulary was last modified.
String failureReason
The reason why the custom vocabulary was not created.
String content
The content of the custom vocabulary in plain-text format with a table of values. Each row in the table
represents a word or a phrase, described with Phrase, IPA, SoundsLike, and
DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a
custom vocabulary using a table.
Map<K,V> tags
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
String name
A unique name of the custom vocabulary.
String id
The identifier of the custom vocabulary.
String arn
The Amazon Resource Name (ARN) of the custom vocabulary.
String languageCode
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
String state
The current state of the custom vocabulary.
Date lastModifiedTime
The timestamp when the custom vocabulary was last modified.
String failureReason
The reason why the custom vocabulary was not created.
String voiceRecordingTrack
Identifies which track is being recorded.
String sessionArn
The Amazon Resource Name (ARN) of the Wisdom session.
Copyright © 2024. All rights reserved.