libZSservicesZSamazonka-connectZSamazonka-connect
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Connect.Lens

Contents

Description

 
Synopsis

Operations

DescribeInstance

describeInstance_instanceId :: Lens' DescribeInstance Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListSecurityProfiles

listSecurityProfiles_nextToken :: Lens' ListSecurityProfiles (Maybe Text) Source #

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.

listSecurityProfiles_maxResults :: Lens' ListSecurityProfiles (Maybe Natural) Source #

The maximum number of results to return per page.

listSecurityProfiles_instanceId :: Lens' ListSecurityProfiles Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listSecurityProfilesResponse_nextToken :: Lens' ListSecurityProfilesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

AssociateLexBot

associateLexBot_instanceId :: Lens' AssociateLexBot Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

associateLexBot_lexBot :: Lens' AssociateLexBot LexBot Source #

The Amazon Lex bot to associate with the instance.

UpdateInstanceAttribute

updateInstanceAttribute_instanceId :: Lens' UpdateInstanceAttribute Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

updateInstanceAttribute_attributeType :: Lens' UpdateInstanceAttribute InstanceAttributeType Source #

The type of attribute.

Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact AWS Support for allowlisting.

updateInstanceAttribute_value :: Lens' UpdateInstanceAttribute Text Source #

The value for the attribute. Maximum character limit is 100.

UpdateQueueStatus

updateQueueStatus_instanceId :: Lens' UpdateQueueStatus Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

UpdateRoutingProfileQueues

updateRoutingProfileQueues_instanceId :: Lens' UpdateRoutingProfileQueues Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

updateRoutingProfileQueues_queueConfigs :: Lens' UpdateRoutingProfileQueues (NonEmpty RoutingProfileQueueConfig) Source #

The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.

DescribeQueue

describeQueue_instanceId :: Lens' DescribeQueue Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

describeQueue_queueId :: Lens' DescribeQueue Text Source #

The identifier for the queue.

ListInstanceAttributes

listInstanceAttributes_nextToken :: Lens' ListInstanceAttributes (Maybe Text) Source #

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.

listInstanceAttributes_maxResults :: Lens' ListInstanceAttributes (Maybe Natural) Source #

The maximum number of results to return per page.

listInstanceAttributes_instanceId :: Lens' ListInstanceAttributes Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listInstanceAttributesResponse_nextToken :: Lens' ListInstanceAttributesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

UpdateAgentStatus

updateAgentStatus_displayOrder :: Lens' UpdateAgentStatus (Maybe Natural) Source #

The display order of the agent status.

updateAgentStatus_name :: Lens' UpdateAgentStatus (Maybe Text) Source #

The name of the agent status.

updateAgentStatus_resetOrderNumber :: Lens' UpdateAgentStatus (Maybe Bool) Source #

A number indicating the reset order of the agent status.

updateAgentStatus_description :: Lens' UpdateAgentStatus (Maybe Text) Source #

The description of the agent status.

updateAgentStatus_instanceId :: Lens' UpdateAgentStatus Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

updateAgentStatus_agentStatusId :: Lens' UpdateAgentStatus Text Source #

The identifier of the agent status.

DescribeInstanceStorageConfig

describeInstanceStorageConfig_instanceId :: Lens' DescribeInstanceStorageConfig Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

describeInstanceStorageConfig_associationId :: Lens' DescribeInstanceStorageConfig Text Source #

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

CreateQuickConnect

createQuickConnect_description :: Lens' CreateQuickConnect (Maybe Text) Source #

The description of the quick connect.

createQuickConnect_instanceId :: Lens' CreateQuickConnect Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

createQuickConnect_name :: Lens' CreateQuickConnect Text Source #

The name of the quick connect.

createQuickConnectResponse_quickConnectARN :: Lens' CreateQuickConnectResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the quick connect.

DescribeContactFlow

describeContactFlow_instanceId :: Lens' DescribeContactFlow Text Source #

The identifier of the Amazon Connect instance.

UpdateUserHierarchy

updateUserHierarchy_userId :: Lens' UpdateUserHierarchy Text Source #

The identifier of the user account.

updateUserHierarchy_instanceId :: Lens' UpdateUserHierarchy Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

UpdateUserRoutingProfile

updateUserRoutingProfile_routingProfileId :: Lens' UpdateUserRoutingProfile Text Source #

The identifier of the routing profile for the user.

updateUserRoutingProfile_instanceId :: Lens' UpdateUserRoutingProfile Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

UpdateUserHierarchyGroupName

updateUserHierarchyGroupName_name :: Lens' UpdateUserHierarchyGroupName Text Source #

The name of the hierarchy group. Must not be more than 100 characters.

updateUserHierarchyGroupName_instanceId :: Lens' UpdateUserHierarchyGroupName Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

UpdateQueueHoursOfOperation

updateQueueHoursOfOperation_instanceId :: Lens' UpdateQueueHoursOfOperation Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

DescribeRoutingProfile

describeRoutingProfile_instanceId :: Lens' DescribeRoutingProfile Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

DisassociateLexBot

disassociateLexBot_instanceId :: Lens' DisassociateLexBot Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

disassociateLexBot_botName :: Lens' DisassociateLexBot Text Source #

The name of the Amazon Lex bot. Maximum character limit of 50.

disassociateLexBot_lexRegion :: Lens' DisassociateLexBot Text Source #

The Region in which the Amazon Lex bot has been created.

DeleteQuickConnect

deleteQuickConnect_instanceId :: Lens' DeleteQuickConnect Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

deleteQuickConnect_quickConnectId :: Lens' DeleteQuickConnect Text Source #

The identifier for the quick connect.

StartOutboundVoiceContact

startOutboundVoiceContact_answerMachineDetectionConfig :: Lens' StartOutboundVoiceContact (Maybe AnswerMachineDetectionConfig) Source #

Configuration of the answering machine detection for this outbound call.

startOutboundVoiceContact_clientToken :: Lens' StartOutboundVoiceContact (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

startOutboundVoiceContact_trafficType :: Lens' StartOutboundVoiceContact (Maybe TrafficType) Source #

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.

startOutboundVoiceContact_campaignId :: Lens' StartOutboundVoiceContact (Maybe Text) Source #

The campaign identifier of the outbound communication.

startOutboundVoiceContact_queueId :: Lens' StartOutboundVoiceContact (Maybe Text) Source #

The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

startOutboundVoiceContact_attributes :: Lens' StartOutboundVoiceContact (Maybe (HashMap Text Text)) Source #

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

startOutboundVoiceContact_sourcePhoneNumber :: Lens' StartOutboundVoiceContact (Maybe Text) Source #

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.

startOutboundVoiceContact_contactFlowId :: Lens' StartOutboundVoiceContact Text Source #

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact 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

startOutboundVoiceContact_instanceId :: Lens' StartOutboundVoiceContact Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

startOutboundVoiceContactResponse_contactId :: Lens' StartOutboundVoiceContactResponse (Maybe Text) Source #

The identifier of this contact within the Amazon Connect instance.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

GetMetricData

getMetricData_nextToken :: Lens' GetMetricData (Maybe Text) Source #

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.

getMetricData_groupings :: Lens' GetMetricData (Maybe [Grouping]) Source #

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.

getMetricData_maxResults :: Lens' GetMetricData (Maybe Natural) Source #

The maximum number of results to return per page.

getMetricData_instanceId :: Lens' GetMetricData Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

getMetricData_startTime :: Lens' GetMetricData UTCTime Source #

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.

getMetricData_endTime :: Lens' GetMetricData UTCTime Source #

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.

getMetricData_filters :: Lens' GetMetricData Filters Source #

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.

To filter by Queues, enter the queue ID/ARN, not the name of the queue.

getMetricData_historicalMetrics :: Lens' GetMetricData [HistoricalMetric] Source #

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).

ABANDON_TIME
Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME
Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED
Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED
Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED
Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST
Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED
Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED
Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING
Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND
Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS
Unit: COUNT

Statistic: SUM

CONTACTS_MISSED
Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED
Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN
Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE
Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT
Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Unit: COUNT

Statistic: SUM

HANDLE_TIME
Unit: SECONDS

Statistic: AVG

HOLD_TIME
Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME
Unit: SECONDS

Statistic: AVG

INTERACTION_TIME
Unit: SECONDS

Statistic: AVG

OCCUPANCY
Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME
Unit: SECONDS

Statistic: AVG

QUEUED_TIME
Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL
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").

getMetricDataResponse_metricResults :: Lens' GetMetricDataResponse (Maybe [HistoricalMetricResult]) Source #

Information about the historical metrics.

If no grouping is specified, a summary of metric data is returned.

getMetricDataResponse_nextToken :: Lens' GetMetricDataResponse (Maybe Text) Source #

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.

StartContactRecording

startContactRecording_instanceId :: Lens' StartContactRecording Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

startContactRecording_initialContactId :: Lens' StartContactRecording Text Source #

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

CreateInstance

createInstance_directoryId :: Lens' CreateInstance (Maybe Text) Source #

The identifier for the directory.

createInstance_identityManagementType :: Lens' CreateInstance DirectoryType Source #

The type of identity management for your Amazon Connect users.

createInstance_inboundCallsEnabled :: Lens' CreateInstance Bool Source #

Your contact center handles incoming contacts.

createInstance_outboundCallsEnabled :: Lens' CreateInstance Bool Source #

Your contact center allows outbound calls.

createInstanceResponse_arn :: Lens' CreateInstanceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the instance.

AssociateBot

associateBot_lexV2Bot :: Lens' AssociateBot (Maybe LexV2Bot) Source #

The Amazon Lex V2 bot to associate with the instance.

associateBot_instanceId :: Lens' AssociateBot Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

AssociateQueueQuickConnects

associateQueueQuickConnects_instanceId :: Lens' AssociateQueueQuickConnects Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

StartTaskContact

startTaskContact_clientToken :: Lens' StartTaskContact (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

startTaskContact_references :: Lens' StartTaskContact (Maybe (HashMap Text Reference)) Source #

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

startTaskContact_previousContactId :: Lens' StartTaskContact (Maybe Text) Source #

The identifier of the previous chat, voice, or task contact.

startTaskContact_attributes :: Lens' StartTaskContact (Maybe (HashMap Text Text)) Source #

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

startTaskContact_description :: Lens' StartTaskContact (Maybe Text) Source #

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

startTaskContact_instanceId :: Lens' StartTaskContact Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

startTaskContact_contactFlowId :: Lens' StartTaskContact Text Source #

The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact 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

startTaskContact_name :: Lens' StartTaskContact Text Source #

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

startTaskContactResponse_contactId :: Lens' StartTaskContactResponse (Maybe Text) Source #

The identifier of this contact within the Amazon Connect instance.

ListUsers

listUsers_nextToken :: Lens' ListUsers (Maybe Text) Source #

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.

listUsers_maxResults :: Lens' ListUsers (Maybe Natural) Source #

The maximum number of results to return per page.

listUsers_instanceId :: Lens' ListUsers Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.

ListUserHierarchyGroups

listUserHierarchyGroups_nextToken :: Lens' ListUserHierarchyGroups (Maybe Text) Source #

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.

listUserHierarchyGroups_maxResults :: Lens' ListUserHierarchyGroups (Maybe Natural) Source #

The maximum number of results to return per page.

listUserHierarchyGroups_instanceId :: Lens' ListUserHierarchyGroups Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listUserHierarchyGroupsResponse_nextToken :: Lens' ListUserHierarchyGroupsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

ListQueues

listQueues_nextToken :: Lens' ListQueues (Maybe Text) Source #

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.

listQueues_maxResults :: Lens' ListQueues (Maybe Natural) Source #

The maximum number of results to return per page.

listQueues_instanceId :: Lens' ListQueues Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listQueuesResponse_nextToken :: Lens' ListQueuesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

DescribeInstanceAttribute

describeInstanceAttribute_instanceId :: Lens' DescribeInstanceAttribute Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListBots

listBots_nextToken :: Lens' ListBots (Maybe Text) Source #

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.

listBots_maxResults :: Lens' ListBots (Maybe Natural) Source #

The maximum number of results to return per page.

listBots_instanceId :: Lens' ListBots Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listBots_lexVersion :: Lens' ListBots LexVersion Source #

The version of Amazon Lex or Amazon Lex V2.

listBotsResponse_nextToken :: Lens' ListBotsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listBotsResponse_lexBots :: Lens' ListBotsResponse (Maybe [LexBotConfig]) Source #

The names and Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

listBotsResponse_httpStatus :: Lens' ListBotsResponse Int Source #

The response's http status code.

UpdateQuickConnectConfig

updateQuickConnectConfig_instanceId :: Lens' UpdateQuickConnectConfig Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

updateQuickConnectConfig_quickConnectConfig :: Lens' UpdateQuickConnectConfig QuickConnectConfig Source #

Information about the configuration settings for the quick connect.

DescribeAgentStatus

describeAgentStatus_instanceId :: Lens' DescribeAgentStatus Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

DeleteInstance

deleteInstance_instanceId :: Lens' DeleteInstance Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

DisassociateInstanceStorageConfig

disassociateInstanceStorageConfig_instanceId :: Lens' DisassociateInstanceStorageConfig Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

disassociateInstanceStorageConfig_associationId :: Lens' DisassociateInstanceStorageConfig Text Source #

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

CreateRoutingProfile

createRoutingProfile_queueConfigs :: Lens' CreateRoutingProfile (Maybe (NonEmpty RoutingProfileQueueConfig)) Source #

The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.

createRoutingProfile_instanceId :: Lens' CreateRoutingProfile Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

createRoutingProfile_name :: Lens' CreateRoutingProfile Text Source #

The name of the routing profile. Must not be more than 127 characters.

createRoutingProfile_description :: Lens' CreateRoutingProfile Text Source #

Description of the routing profile. Must not be more than 250 characters.

createRoutingProfile_defaultOutboundQueueId :: Lens' CreateRoutingProfile Text Source #

The default outbound queue for the routing profile.

createRoutingProfile_mediaConcurrencies :: Lens' CreateRoutingProfile [MediaConcurrency] Source #

The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.

createRoutingProfileResponse_routingProfileArn :: Lens' CreateRoutingProfileResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the routing profile.

UpdateInstanceStorageConfig

updateInstanceStorageConfig_instanceId :: Lens' UpdateInstanceStorageConfig Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

updateInstanceStorageConfig_associationId :: Lens' UpdateInstanceStorageConfig Text Source #

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

DisassociateQueueQuickConnects

disassociateQueueQuickConnects_instanceId :: Lens' DisassociateQueueQuickConnects Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

CreateUseCase

createUseCase_instanceId :: Lens' CreateUseCase Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

createUseCase_integrationAssociationId :: Lens' CreateUseCase Text Source #

The identifier for the integration association.

createUseCase_useCaseType :: Lens' CreateUseCase UseCaseType Source #

The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

createUseCaseResponse_useCaseArn :: Lens' CreateUseCaseResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the use case.

DisassociateBot

disassociateBot_lexV2Bot :: Lens' DisassociateBot (Maybe LexV2Bot) Source #

The Amazon Lex V2 bot to disassociate from the instance.

disassociateBot_instanceId :: Lens' DisassociateBot Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListQueueQuickConnects

listQueueQuickConnects_nextToken :: Lens' ListQueueQuickConnects (Maybe Text) Source #

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.

listQueueQuickConnects_maxResults :: Lens' ListQueueQuickConnects (Maybe Natural) Source #

The maximum number of results to return per page.

listQueueQuickConnects_instanceId :: Lens' ListQueueQuickConnects Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listQueueQuickConnectsResponse_nextToken :: Lens' ListQueueQuickConnectsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

GetCurrentMetricData

getCurrentMetricData_nextToken :: Lens' GetCurrentMetricData (Maybe Text) Source #

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.

getCurrentMetricData_groupings :: Lens' GetCurrentMetricData (Maybe [Grouping]) Source #

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 no Grouping is included in the request, a summary of metrics is returned.

getCurrentMetricData_maxResults :: Lens' GetCurrentMetricData (Maybe Natural) Source #

The maximum number of results to return per page.

getCurrentMetricData_instanceId :: Lens' GetCurrentMetricData Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

getCurrentMetricData_filters :: Lens' GetCurrentMetricData Filters Source #

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.

getCurrentMetricData_currentMetrics :: Lens' GetCurrentMetricData [CurrentMetric] Source #

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.

AGENTS_AFTER_CONTACT_WORK
Unit: COUNT

Name in real-time metrics report: ACW

AGENTS_AVAILABLE
Unit: COUNT

Name in real-time metrics report: Available

AGENTS_ERROR
Unit: COUNT

Name in real-time metrics report: Error

AGENTS_NON_PRODUCTIVE
Unit: COUNT

Name in real-time metrics report: NPT (Non-Productive Time)

AGENTS_ON_CALL
Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ON_CONTACT
Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ONLINE
Unit: COUNT

Name in real-time metrics report: Online

AGENTS_STAFFED
Unit: COUNT

Name in real-time metrics report: Staffed

CONTACTS_IN_QUEUE
Unit: COUNT

Name in real-time metrics report: In queue

CONTACTS_SCHEDULED
Unit: COUNT

Name in real-time metrics report: Scheduled

OLDEST_CONTACT_AGE
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.

Name in real-time metrics report: Oldest

SLOTS_ACTIVE
Unit: COUNT

Name in real-time metrics report: Active

SLOTS_AVAILABLE
Unit: COUNT

Name in real-time metrics report: Availability

getCurrentMetricDataResponse_dataSnapshotTime :: Lens' GetCurrentMetricDataResponse (Maybe UTCTime) Source #

The time at which the metrics were retrieved and cached for pagination.

getCurrentMetricDataResponse_nextToken :: Lens' GetCurrentMetricDataResponse (Maybe Text) Source #

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.

CreateContactFlow

createContactFlow_description :: Lens' CreateContactFlow (Maybe Text) Source #

The description of the contact flow.

createContactFlow_instanceId :: Lens' CreateContactFlow Text Source #

The identifier of the Amazon Connect instance.

createContactFlow_name :: Lens' CreateContactFlow Text Source #

The name of the contact flow.

createContactFlow_type :: Lens' CreateContactFlow ContactFlowType Source #

The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.

createContactFlow_content :: Lens' CreateContactFlow Text Source #

The content of the contact flow.

createContactFlowResponse_contactFlowArn :: Lens' CreateContactFlowResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the contact flow.

ListRoutingProfiles

listRoutingProfiles_nextToken :: Lens' ListRoutingProfiles (Maybe Text) Source #

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.

listRoutingProfiles_maxResults :: Lens' ListRoutingProfiles (Maybe Natural) Source #

The maximum number of results to return per page.

listRoutingProfiles_instanceId :: Lens' ListRoutingProfiles Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listRoutingProfilesResponse_nextToken :: Lens' ListRoutingProfilesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

DeleteIntegrationAssociation

deleteIntegrationAssociation_instanceId :: Lens' DeleteIntegrationAssociation Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

DeleteHoursOfOperation

deleteHoursOfOperation_instanceId :: Lens' DeleteHoursOfOperation Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

UpdateUserPhoneConfig

updateUserPhoneConfig_phoneConfig :: Lens' UpdateUserPhoneConfig UserPhoneConfig Source #

Information about phone configuration settings for the user.

updateUserPhoneConfig_instanceId :: Lens' UpdateUserPhoneConfig Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

UpdateHoursOfOperation

updateHoursOfOperation_config :: Lens' UpdateHoursOfOperation (Maybe [HoursOfOperationConfig]) Source #

Configuration information of the hours of operation.

updateHoursOfOperation_timeZone :: Lens' UpdateHoursOfOperation (Maybe Text) Source #

The time zone of the hours of operation.

updateHoursOfOperation_description :: Lens' UpdateHoursOfOperation (Maybe Text) Source #

The description of the hours of operation.

updateHoursOfOperation_instanceId :: Lens' UpdateHoursOfOperation Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListApprovedOrigins

listApprovedOrigins_nextToken :: Lens' ListApprovedOrigins (Maybe Text) Source #

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.

listApprovedOrigins_maxResults :: Lens' ListApprovedOrigins (Maybe Natural) Source #

The maximum number of results to return per page.

listApprovedOrigins_instanceId :: Lens' ListApprovedOrigins Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listApprovedOriginsResponse_nextToken :: Lens' ListApprovedOriginsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

DescribeUserHierarchyStructure

describeUserHierarchyStructure_instanceId :: Lens' DescribeUserHierarchyStructure Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListPhoneNumbers

listPhoneNumbers_nextToken :: Lens' ListPhoneNumbers (Maybe Text) Source #

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.

listPhoneNumbers_maxResults :: Lens' ListPhoneNumbers (Maybe Natural) Source #

The maximum number of results to return per page.

listPhoneNumbers_instanceId :: Lens' ListPhoneNumbers Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listPhoneNumbersResponse_nextToken :: Lens' ListPhoneNumbersResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

UpdateContactAttributes

updateContactAttributes_initialContactId :: Lens' UpdateContactAttributes Text Source #

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

updateContactAttributes_instanceId :: Lens' UpdateContactAttributes Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

updateContactAttributes_attributes :: Lens' UpdateContactAttributes (HashMap Text Text) Source #

The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes.

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

ListUseCases

listUseCases_nextToken :: Lens' ListUseCases (Maybe Text) Source #

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.

listUseCases_maxResults :: Lens' ListUseCases (Maybe Natural) Source #

The maximum number of results to return per page.

listUseCases_instanceId :: Lens' ListUseCases Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listUseCases_integrationAssociationId :: Lens' ListUseCases Text Source #

The identifier for the integration association.

listUseCasesResponse_nextToken :: Lens' ListUseCasesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

StartChatContact

startChatContact_clientToken :: Lens' StartChatContact (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

startChatContact_attributes :: Lens' StartChatContact (Maybe (HashMap Text Text)) Source #

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

startChatContact_initialMessage :: Lens' StartChatContact (Maybe ChatMessage) Source #

The initial message to be sent to the newly created chat.

startChatContact_instanceId :: Lens' StartChatContact Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

startChatContact_contactFlowId :: Lens' StartChatContact Text Source #

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact 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

startChatContactResponse_participantToken :: Lens' StartChatContactResponse (Maybe Text) Source #

The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

startChatContactResponse_participantId :: Lens' StartChatContactResponse (Maybe Text) Source #

The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

startChatContactResponse_contactId :: Lens' StartChatContactResponse (Maybe Text) Source #

The identifier of this contact within the Amazon Connect instance.

DeleteUseCase

deleteUseCase_instanceId :: Lens' DeleteUseCase Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

deleteUseCase_integrationAssociationId :: Lens' DeleteUseCase Text Source #

The identifier for the integration association.

deleteUseCase_useCaseId :: Lens' DeleteUseCase Text Source #

The identifier for the use case.

UpdateUserSecurityProfiles

updateUserSecurityProfiles_securityProfileIds :: Lens' UpdateUserSecurityProfiles (NonEmpty Text) Source #

The identifiers of the security profiles for the user.

updateUserSecurityProfiles_instanceId :: Lens' UpdateUserSecurityProfiles Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

GetContactAttributes

getContactAttributes_instanceId :: Lens' GetContactAttributes Text Source #

The identifier of the Amazon Connect instance.

ListLambdaFunctions

listLambdaFunctions_nextToken :: Lens' ListLambdaFunctions (Maybe Text) Source #

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.

listLambdaFunctions_maxResults :: Lens' ListLambdaFunctions (Maybe Natural) Source #

The maximum number of results to return per page.

listLambdaFunctions_instanceId :: Lens' ListLambdaFunctions Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listLambdaFunctionsResponse_lambdaFunctions :: Lens' ListLambdaFunctionsResponse (Maybe [Text]) Source #

The Lambdafunction ARNs associated with the specified instance.

listLambdaFunctionsResponse_nextToken :: Lens' ListLambdaFunctionsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

DescribeUserHierarchyGroup

describeUserHierarchyGroup_instanceId :: Lens' DescribeUserHierarchyGroup Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

DescribeUser

describeUser_userId :: Lens' DescribeUser Text Source #

The identifier of the user account.

describeUser_instanceId :: Lens' DescribeUser Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

describeUserResponse_user :: Lens' DescribeUserResponse (Maybe User) Source #

Information about the user account and configuration settings.

ResumeContactRecording

resumeContactRecording_instanceId :: Lens' ResumeContactRecording Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

resumeContactRecording_initialContactId :: Lens' ResumeContactRecording Text Source #

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

UpdateContactFlowName

updateContactFlowName_instanceId :: Lens' UpdateContactFlowName Text Source #

The identifier of the Amazon Connect instance.

SuspendContactRecording

suspendContactRecording_instanceId :: Lens' SuspendContactRecording Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

suspendContactRecording_initialContactId :: Lens' SuspendContactRecording Text Source #

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

UpdateQueueName

updateQueueName_instanceId :: Lens' UpdateQueueName Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

updateQueueName_queueId :: Lens' UpdateQueueName Text Source #

The identifier for the queue.

UpdateQueueMaxContacts

updateQueueMaxContacts_maxContacts :: Lens' UpdateQueueMaxContacts (Maybe Natural) Source #

The maximum number of contacts that can be in the queue before it is considered full.

updateQueueMaxContacts_instanceId :: Lens' UpdateQueueMaxContacts Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListRoutingProfileQueues

listRoutingProfileQueues_nextToken :: Lens' ListRoutingProfileQueues (Maybe Text) Source #

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.

listRoutingProfileQueues_maxResults :: Lens' ListRoutingProfileQueues (Maybe Natural) Source #

The maximum number of results to return per page.

listRoutingProfileQueues_instanceId :: Lens' ListRoutingProfileQueues Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listRoutingProfileQueuesResponse_nextToken :: Lens' ListRoutingProfileQueuesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

DisassociateRoutingProfileQueues

disassociateRoutingProfileQueues_instanceId :: Lens' DisassociateRoutingProfileQueues Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

DisassociateLambdaFunction

disassociateLambdaFunction_instanceId :: Lens' DisassociateLambdaFunction Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance..

disassociateLambdaFunction_functionArn :: Lens' DisassociateLambdaFunction Text Source #

The Amazon Resource Name (ARN) of the Lambda function being disassociated.

UpdateContactFlowContent

updateContactFlowContent_instanceId :: Lens' UpdateContactFlowContent Text Source #

The identifier of the Amazon Connect instance.

updateContactFlowContent_content :: Lens' UpdateContactFlowContent Text Source #

The JSON string that represents contact flow’s content. For an example, see Example contact flow in Amazon Connect Flow language in the Amazon Connect Administrator Guide.

UpdateUserHierarchyStructure

updateUserHierarchyStructure_instanceId :: Lens' UpdateUserHierarchyStructure Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

DescribeHoursOfOperation

describeHoursOfOperation_instanceId :: Lens' DescribeHoursOfOperation Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListQuickConnects

listQuickConnects_quickConnectTypes :: Lens' ListQuickConnects (Maybe [QuickConnectType]) Source #

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

listQuickConnects_nextToken :: Lens' ListQuickConnects (Maybe Text) Source #

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.

listQuickConnects_maxResults :: Lens' ListQuickConnects (Maybe Natural) Source #

The maximum number of results to return per page.

listQuickConnects_instanceId :: Lens' ListQuickConnects Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listQuickConnectsResponse_nextToken :: Lens' ListQuickConnectsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

CreateUserHierarchyGroup

createUserHierarchyGroup_parentGroupId :: Lens' CreateUserHierarchyGroup (Maybe Text) Source #

The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

createUserHierarchyGroup_name :: Lens' CreateUserHierarchyGroup Text Source #

The name of the user hierarchy group. Must not be more than 100 characters.

createUserHierarchyGroup_instanceId :: Lens' CreateUserHierarchyGroup Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

CreateUser

createUser_directoryUserId :: Lens' CreateUser (Maybe Text) Source #

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.

createUser_identityInfo :: Lens' CreateUser (Maybe UserIdentityInfo) Source #

The information about the identity of the user.

createUser_password :: Lens' CreateUser (Maybe Text) Source #

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.

createUser_hierarchyGroupId :: Lens' CreateUser (Maybe Text) Source #

The identifier of the hierarchy group for the user.

createUser_username :: Lens' CreateUser Text Source #

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_-.\@]+.

createUser_phoneConfig :: Lens' CreateUser UserPhoneConfig Source #

The phone settings for the user.

createUser_securityProfileIds :: Lens' CreateUser (NonEmpty Text) Source #

The identifier of the security profile for the user.

createUser_routingProfileId :: Lens' CreateUser Text Source #

The identifier of the routing profile for the user.

createUser_instanceId :: Lens' CreateUser Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

createUserResponse_userId :: Lens' CreateUserResponse (Maybe Text) Source #

The identifier of the user account.

createUserResponse_userArn :: Lens' CreateUserResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user account.

CreateQueue

createQueue_maxContacts :: Lens' CreateQueue (Maybe Natural) Source #

The maximum number of contacts that can be in the queue before it is considered full.

createQueue_quickConnectIds :: Lens' CreateQueue (Maybe (NonEmpty Text)) Source #

The quick connects available to agents who are working the queue.

createQueue_outboundCallerConfig :: Lens' CreateQueue (Maybe OutboundCallerConfig) Source #

The outbound caller ID name, number, and outbound whisper flow.

createQueue_description :: Lens' CreateQueue (Maybe Text) Source #

The description of the queue.

createQueue_instanceId :: Lens' CreateQueue Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

createQueue_name :: Lens' CreateQueue Text Source #

The name of the queue.

createQueue_hoursOfOperationId :: Lens' CreateQueue Text Source #

The identifier for the hours of operation.

createQueueResponse_queueArn :: Lens' CreateQueueResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the queue.

UpdateQuickConnectName

updateQuickConnectName_instanceId :: Lens' UpdateQuickConnectName Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListPrompts

listPrompts_nextToken :: Lens' ListPrompts (Maybe Text) Source #

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.

listPrompts_maxResults :: Lens' ListPrompts (Maybe Natural) Source #

The maximum number of results to return per page.

listPrompts_instanceId :: Lens' ListPrompts Text Source #

The identifier of the Amazon Connect instance.

listPromptsResponse_nextToken :: Lens' ListPromptsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

AssociateSecurityKey

associateSecurityKey_instanceId :: Lens' AssociateSecurityKey Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

associateSecurityKey_key :: Lens' AssociateSecurityKey Text Source #

A valid security key in PEM format.

associateSecurityKeyResponse_associationId :: Lens' AssociateSecurityKeyResponse (Maybe Text) Source #

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

StopContactRecording

stopContactRecording_instanceId :: Lens' StopContactRecording Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

stopContactRecording_initialContactId :: Lens' StopContactRecording Text Source #

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

DisassociateApprovedOrigin

disassociateApprovedOrigin_instanceId :: Lens' DisassociateApprovedOrigin Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

disassociateApprovedOrigin_origin :: Lens' DisassociateApprovedOrigin Text Source #

The domain URL of the integrated application.

ListSecurityKeys

listSecurityKeys_nextToken :: Lens' ListSecurityKeys (Maybe Text) Source #

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.

listSecurityKeys_maxResults :: Lens' ListSecurityKeys (Maybe Natural) Source #

The maximum number of results to return per page.

listSecurityKeys_instanceId :: Lens' ListSecurityKeys Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listSecurityKeysResponse_nextToken :: Lens' ListSecurityKeysResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

GetFederationToken

getFederationToken_instanceId :: Lens' GetFederationToken Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

StopContact

stopContact_instanceId :: Lens' StopContact Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

DeleteUser

deleteUser_instanceId :: Lens' DeleteUser Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

deleteUser_userId :: Lens' DeleteUser Text Source #

The identifier of the user.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

UpdateUserIdentityInfo

updateUserIdentityInfo_instanceId :: Lens' UpdateUserIdentityInfo Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListInstances

listInstances_nextToken :: Lens' ListInstances (Maybe Text) Source #

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.

listInstances_maxResults :: Lens' ListInstances (Maybe Natural) Source #

The maximum number of results to return per page.

listInstancesResponse_nextToken :: Lens' ListInstancesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

DeleteUserHierarchyGroup

deleteUserHierarchyGroup_instanceId :: Lens' DeleteUserHierarchyGroup Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

UpdateRoutingProfileDefaultOutboundQueue

updateRoutingProfileDefaultOutboundQueue_instanceId :: Lens' UpdateRoutingProfileDefaultOutboundQueue Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

UpdateQueueOutboundCallerConfig

updateQueueOutboundCallerConfig_instanceId :: Lens' UpdateQueueOutboundCallerConfig Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListContactFlows

listContactFlows_nextToken :: Lens' ListContactFlows (Maybe Text) Source #

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.

listContactFlows_maxResults :: Lens' ListContactFlows (Maybe Natural) Source #

The maximum number of results to return per page.

listContactFlows_instanceId :: Lens' ListContactFlows Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listContactFlowsResponse_nextToken :: Lens' ListContactFlowsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

CreateIntegrationAssociation

createIntegrationAssociation_sourceType :: Lens' CreateIntegrationAssociation (Maybe SourceType) Source #

The type of the data source. This field is only required for the EVENT integration type.

createIntegrationAssociation_sourceApplicationUrl :: Lens' CreateIntegrationAssociation (Maybe Text) Source #

The URL for the external application. This field is only required for the EVENT integration type.

createIntegrationAssociation_sourceApplicationName :: Lens' CreateIntegrationAssociation (Maybe Text) Source #

The name of the external application. This field is only required for the EVENT integration type.

createIntegrationAssociation_instanceId :: Lens' CreateIntegrationAssociation Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

createIntegrationAssociation_integrationArn :: Lens' CreateIntegrationAssociation Text Source #

The Amazon Resource Name (ARN) of the integration.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

AssociateApprovedOrigin

associateApprovedOrigin_instanceId :: Lens' AssociateApprovedOrigin Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

CreateHoursOfOperation

createHoursOfOperation_description :: Lens' CreateHoursOfOperation (Maybe Text) Source #

The description of the hours of operation.

createHoursOfOperation_instanceId :: Lens' CreateHoursOfOperation Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

createHoursOfOperation_timeZone :: Lens' CreateHoursOfOperation Text Source #

The time zone of the hours of operation.

createHoursOfOperation_config :: Lens' CreateHoursOfOperation [HoursOfOperationConfig] Source #

Configuration information for the hours of operation: day, start time, and end time.

createHoursOfOperationResponse_hoursOfOperationArn :: Lens' CreateHoursOfOperationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the hours of operation.

DisassociateSecurityKey

disassociateSecurityKey_instanceId :: Lens' DisassociateSecurityKey Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

disassociateSecurityKey_associationId :: Lens' DisassociateSecurityKey Text Source #

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

UpdateRoutingProfileConcurrency

updateRoutingProfileConcurrency_instanceId :: Lens' UpdateRoutingProfileConcurrency Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

updateRoutingProfileConcurrency_mediaConcurrencies :: Lens' UpdateRoutingProfileConcurrency [MediaConcurrency] Source #

The channels that agents can handle in the Contact Control Panel (CCP).

ListInstanceStorageConfigs

listInstanceStorageConfigs_nextToken :: Lens' ListInstanceStorageConfigs (Maybe Text) Source #

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.

listInstanceStorageConfigs_maxResults :: Lens' ListInstanceStorageConfigs (Maybe Natural) Source #

The maximum number of results to return per page.

listInstanceStorageConfigs_instanceId :: Lens' ListInstanceStorageConfigs Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listInstanceStorageConfigsResponse_nextToken :: Lens' ListInstanceStorageConfigsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

DescribeQuickConnect

describeQuickConnect_instanceId :: Lens' DescribeQuickConnect Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

AssociateInstanceStorageConfig

associateInstanceStorageConfig_instanceId :: Lens' AssociateInstanceStorageConfig Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

associateInstanceStorageConfigResponse_associationId :: Lens' AssociateInstanceStorageConfigResponse (Maybe Text) Source #

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

ListHoursOfOperations

listHoursOfOperations_nextToken :: Lens' ListHoursOfOperations (Maybe Text) Source #

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.

listHoursOfOperations_maxResults :: Lens' ListHoursOfOperations (Maybe Natural) Source #

The maximum number of results to return per page.

listHoursOfOperations_instanceId :: Lens' ListHoursOfOperations Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listHoursOfOperationsResponse_nextToken :: Lens' ListHoursOfOperationsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

ListIntegrationAssociations

listIntegrationAssociations_nextToken :: Lens' ListIntegrationAssociations (Maybe Text) Source #

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.

listIntegrationAssociations_maxResults :: Lens' ListIntegrationAssociations (Maybe Natural) Source #

The maximum number of results to return per page.

listIntegrationAssociations_instanceId :: Lens' ListIntegrationAssociations Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listIntegrationAssociationsResponse_nextToken :: Lens' ListIntegrationAssociationsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

CreateAgentStatus

createAgentStatus_instanceId :: Lens' CreateAgentStatus Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

createAgentStatusResponse_agentStatusARN :: Lens' CreateAgentStatusResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the agent status.

UpdateRoutingProfileName

updateRoutingProfileName_name :: Lens' UpdateRoutingProfileName (Maybe Text) Source #

The name of the routing profile. Must not be more than 127 characters.

updateRoutingProfileName_description :: Lens' UpdateRoutingProfileName (Maybe Text) Source #

The description of the routing profile. Must not be more than 250 characters.

updateRoutingProfileName_instanceId :: Lens' UpdateRoutingProfileName Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListLexBots

listLexBots_nextToken :: Lens' ListLexBots (Maybe Text) Source #

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.

listLexBots_maxResults :: Lens' ListLexBots (Maybe Natural) Source #

The maximum number of results to return per page. If no value is specified, the default is 10.

listLexBots_instanceId :: Lens' ListLexBots Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listLexBotsResponse_nextToken :: Lens' ListLexBotsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listLexBotsResponse_lexBots :: Lens' ListLexBotsResponse (Maybe [LexBot]) Source #

The names and Regions of the Amazon Lex bots associated with the specified instance.

ListAgentStatuses

listAgentStatuses_nextToken :: Lens' ListAgentStatuses (Maybe Text) Source #

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.

listAgentStatuses_maxResults :: Lens' ListAgentStatuses (Maybe Natural) Source #

The maximum number of results to return per page.

listAgentStatuses_instanceId :: Lens' ListAgentStatuses Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listAgentStatusesResponse_nextToken :: Lens' ListAgentStatusesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

AssociateLambdaFunction

associateLambdaFunction_instanceId :: Lens' AssociateLambdaFunction Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

associateLambdaFunction_functionArn :: Lens' AssociateLambdaFunction Text Source #

The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.

AssociateRoutingProfileQueues

associateRoutingProfileQueues_instanceId :: Lens' AssociateRoutingProfileQueues Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Types

AgentStatus

agentStatus_displayOrder :: Lens' AgentStatus (Maybe Natural) Source #

The display order of the agent status.

agentStatus_state :: Lens' AgentStatus (Maybe AgentStatusState) Source #

The state of the agent status.

agentStatus_name :: Lens' AgentStatus (Maybe Text) Source #

The name of the agent status.

agentStatus_agentStatusId :: Lens' AgentStatus (Maybe Text) Source #

The identifier of the agent status.

agentStatus_agentStatusARN :: Lens' AgentStatus (Maybe Text) Source #

The Amazon Resource Name (ARN) of the agent status.

agentStatus_description :: Lens' AgentStatus (Maybe Text) Source #

The description of the agent status.

AgentStatusSummary

agentStatusSummary_arn :: Lens' AgentStatusSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) for the agent status.

agentStatusSummary_id :: Lens' AgentStatusSummary (Maybe Text) Source #

The identifier for an agent status.

AnswerMachineDetectionConfig

answerMachineDetectionConfig_enableAnswerMachineDetection :: Lens' AnswerMachineDetectionConfig (Maybe Bool) Source #

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.

Attribute

attribute_value :: Lens' Attribute (Maybe Text) Source #

The value of the attribute.

ChatMessage

chatMessage_contentType :: Lens' ChatMessage Text Source #

The type of the content. Supported types are text and plain.

chatMessage_content :: Lens' ChatMessage Text Source #

The content of the chat message.

ContactFlow

contactFlow_arn :: Lens' ContactFlow (Maybe Text) Source #

The Amazon Resource Name (ARN) of the contact flow.

contactFlow_content :: Lens' ContactFlow (Maybe Text) Source #

The content of the contact flow.

contactFlow_name :: Lens' ContactFlow (Maybe Text) Source #

The name of the contact flow.

contactFlow_id :: Lens' ContactFlow (Maybe Text) Source #

The identifier of the contact flow.

contactFlow_type :: Lens' ContactFlow (Maybe ContactFlowType) Source #

The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.

contactFlow_description :: Lens' ContactFlow (Maybe Text) Source #

The description of the contact flow.

ContactFlowSummary

contactFlowSummary_arn :: Lens' ContactFlowSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the contact flow.

contactFlowSummary_id :: Lens' ContactFlowSummary (Maybe Text) Source #

The identifier of the contact flow.

Credentials

credentials_accessTokenExpiration :: Lens' Credentials (Maybe UTCTime) Source #

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

credentials_accessToken :: Lens' Credentials (Maybe Text) Source #

An access token generated for a federated user to access Amazon Connect.

credentials_refreshToken :: Lens' Credentials (Maybe Text) Source #

Renews a token generated for a user to access the Amazon Connect instance.

credentials_refreshTokenExpiration :: Lens' Credentials (Maybe UTCTime) Source #

Renews the expiration timer for a generated token.

CurrentMetric

currentMetric_unit :: Lens' CurrentMetric (Maybe Unit) Source #

The unit for the metric.

CurrentMetricData

CurrentMetricResult

Dimensions

dimensions_channel :: Lens' Dimensions (Maybe Channel) Source #

The channel used for grouping and filters.

dimensions_queue :: Lens' Dimensions (Maybe QueueReference) Source #

Information about the queue for which metrics are returned.

EncryptionConfig

encryptionConfig_keyId :: Lens' EncryptionConfig Text Source #

The full ARN of the encryption key.

Be sure to provide the full ARN of the encryption key, not just the ID.

Filters

filters_queues :: Lens' Filters (Maybe (NonEmpty Text)) Source #

The queues to use to filter the metrics. You can specify up to 100 queues per request.

filters_channels :: Lens' Filters (Maybe [Channel]) Source #

The channel to use to filter the metrics.

HierarchyGroup

hierarchyGroup_arn :: Lens' HierarchyGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the hierarchy group.

hierarchyGroup_name :: Lens' HierarchyGroup (Maybe Text) Source #

The name of the hierarchy group.

hierarchyGroup_hierarchyPath :: Lens' HierarchyGroup (Maybe HierarchyPath) Source #

Information about the levels in the hierarchy group.

hierarchyGroup_id :: Lens' HierarchyGroup (Maybe Text) Source #

The identifier of the hierarchy group.

hierarchyGroup_levelId :: Lens' HierarchyGroup (Maybe Text) Source #

The identifier of the level in the hierarchy group.

HierarchyGroupSummary

hierarchyGroupSummary_arn :: Lens' HierarchyGroupSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the hierarchy group.

hierarchyGroupSummary_id :: Lens' HierarchyGroupSummary (Maybe Text) Source #

The identifier of the hierarchy group.

HierarchyLevel

hierarchyLevel_arn :: Lens' HierarchyLevel (Maybe Text) Source #

The Amazon Resource Name (ARN) of the hierarchy level.

hierarchyLevel_name :: Lens' HierarchyLevel (Maybe Text) Source #

The name of the hierarchy level.

hierarchyLevel_id :: Lens' HierarchyLevel (Maybe Text) Source #

The identifier of the hierarchy level.

HierarchyLevelUpdate

hierarchyLevelUpdate_name :: Lens' HierarchyLevelUpdate Text Source #

The name of the user hierarchy level. Must not be more than 50 characters.

HierarchyPath

HierarchyStructure

HierarchyStructureUpdate

HistoricalMetric

historicalMetric_threshold :: Lens' HistoricalMetric (Maybe Threshold) Source #

The threshold for the metric, used with service level metrics.

HistoricalMetricData

HistoricalMetricResult

HoursOfOperation

hoursOfOperation_config :: Lens' HoursOfOperation (Maybe [HoursOfOperationConfig]) Source #

Configuration information for the hours of operation.

hoursOfOperation_name :: Lens' HoursOfOperation (Maybe Text) Source #

The name for the hours of operation.

hoursOfOperation_hoursOfOperationArn :: Lens' HoursOfOperation (Maybe Text) Source #

The Amazon Resource Name (ARN) for the hours of operation.

hoursOfOperation_hoursOfOperationId :: Lens' HoursOfOperation (Maybe Text) Source #

The identifier for the hours of operation.

hoursOfOperation_timeZone :: Lens' HoursOfOperation (Maybe Text) Source #

The time zone for the hours of operation.

hoursOfOperation_description :: Lens' HoursOfOperation (Maybe Text) Source #

The description for the hours of operation.

HoursOfOperationConfig

hoursOfOperationConfig_day :: Lens' HoursOfOperationConfig HoursOfOperationDays Source #

The day that the hours of operation applies to.

HoursOfOperationSummary

hoursOfOperationSummary_arn :: Lens' HoursOfOperationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the hours of operation.

hoursOfOperationSummary_id :: Lens' HoursOfOperationSummary (Maybe Text) Source #

The identifier of the hours of operation.

HoursOfOperationTimeSlice

Instance

instance_arn :: Lens' Instance (Maybe Text) Source #

The Amazon Resource Name (ARN) of the instance.

instance_createdTime :: Lens' Instance (Maybe UTCTime) Source #

When the instance was created.

instance_outboundCallsEnabled :: Lens' Instance (Maybe Bool) Source #

Whether outbound calls are enabled.

instance_inboundCallsEnabled :: Lens' Instance (Maybe Bool) Source #

Whether inbound calls are enabled.

instance_id :: Lens' Instance (Maybe Text) Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

instance_statusReason :: Lens' Instance (Maybe InstanceStatusReason) Source #

Relevant details why the instance was not successfully created.

instance_serviceRole :: Lens' Instance (Maybe Text) Source #

The service role of the instance.

InstanceStatusReason

InstanceStorageConfig

instanceStorageConfig_associationId :: Lens' InstanceStorageConfig (Maybe Text) Source #

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

instanceStorageConfig_kinesisFirehoseConfig :: Lens' InstanceStorageConfig (Maybe KinesisFirehoseConfig) Source #

The configuration of the Kinesis Firehose delivery stream.

InstanceSummary

instanceSummary_arn :: Lens' InstanceSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the instance.

instanceSummary_id :: Lens' InstanceSummary (Maybe Text) Source #

The identifier of the instance.

instanceSummary_identityManagementType :: Lens' InstanceSummary (Maybe DirectoryType) Source #

The identity management type of the instance.

instanceSummary_serviceRole :: Lens' InstanceSummary (Maybe Text) Source #

The service role of the instance.

IntegrationAssociationSummary

integrationAssociationSummary_instanceId :: Lens' IntegrationAssociationSummary (Maybe Text) Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

integrationAssociationSummary_integrationAssociationArn :: Lens' IntegrationAssociationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) for the AppIntegration association.

integrationAssociationSummary_sourceApplicationName :: Lens' IntegrationAssociationSummary (Maybe Text) Source #

The user-provided, friendly name for the external application.

integrationAssociationSummary_integrationArn :: Lens' IntegrationAssociationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) for the AppIntegration.

KinesisFirehoseConfig

kinesisFirehoseConfig_firehoseArn :: Lens' KinesisFirehoseConfig Text Source #

The Amazon Resource Name (ARN) of the delivery stream.

KinesisStreamConfig

kinesisStreamConfig_streamArn :: Lens' KinesisStreamConfig Text Source #

The Amazon Resource Name (ARN) of the data stream.

KinesisVideoStreamConfig

kinesisVideoStreamConfig_retentionPeriodHours :: Lens' KinesisVideoStreamConfig Natural Source #

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.

LexBot

lexBot_lexRegion :: Lens' LexBot (Maybe Text) Source #

The Region that the Amazon Lex bot was created in.

lexBot_name :: Lens' LexBot (Maybe Text) Source #

The name of the Amazon Lex bot.

LexBotConfig

lexBotConfig_lexV2Bot :: Lens' LexBotConfig (Maybe LexV2Bot) Source #

Configuration information of an Amazon Lex V2 bot.

LexV2Bot

lexV2Bot_aliasArn :: Lens' LexV2Bot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

MediaConcurrency

mediaConcurrency_channel :: Lens' MediaConcurrency Channel Source #

The channels that agents can handle in the Contact Control Panel (CCP).

mediaConcurrency_concurrency :: Lens' MediaConcurrency Natural Source #

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.

OutboundCallerConfig

outboundCallerConfig_outboundFlowId :: Lens' OutboundCallerConfig (Maybe Text) Source #

The outbound whisper flow to be used during an outbound call.

ParticipantDetails

PhoneNumberQuickConnectConfig

PhoneNumberSummary

phoneNumberSummary_arn :: Lens' PhoneNumberSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the phone number.

phoneNumberSummary_id :: Lens' PhoneNumberSummary (Maybe Text) Source #

The identifier of the phone number.

PromptSummary

promptSummary_arn :: Lens' PromptSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the prompt.

promptSummary_id :: Lens' PromptSummary (Maybe Text) Source #

The identifier of the prompt.

Queue

queue_status :: Lens' Queue (Maybe QueueStatus) Source #

The status of the queue.

queue_queueArn :: Lens' Queue (Maybe Text) Source #

The Amazon Resource Name (ARN) for the queue.

queue_queueId :: Lens' Queue (Maybe Text) Source #

The identifier for the queue.

queue_maxContacts :: Lens' Queue (Maybe Natural) Source #

The maximum number of contacts that can be in the queue before it is considered full.

queue_name :: Lens' Queue (Maybe Text) Source #

The name of the queue.

queue_hoursOfOperationId :: Lens' Queue (Maybe Text) Source #

The identifier for the hours of operation.

queue_outboundCallerConfig :: Lens' Queue (Maybe OutboundCallerConfig) Source #

The outbound caller ID name, number, and outbound whisper flow.

queue_description :: Lens' Queue (Maybe Text) Source #

The description of the queue.

queue_tags :: Lens' Queue (Maybe (HashMap Text Text)) Source #

One or more tags.

QueueQuickConnectConfig

QueueReference

queueReference_arn :: Lens' QueueReference (Maybe Text) Source #

The Amazon Resource Name (ARN) of the queue.

queueReference_id :: Lens' QueueReference (Maybe Text) Source #

The identifier of the queue.

QueueSummary

queueSummary_arn :: Lens' QueueSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the queue.

queueSummary_id :: Lens' QueueSummary (Maybe Text) Source #

The identifier of the queue.

QuickConnect

quickConnect_name :: Lens' QuickConnect (Maybe Text) Source #

The name of the quick connect.

quickConnect_quickConnectId :: Lens' QuickConnect (Maybe Text) Source #

The identifier for the quick connect.

quickConnect_quickConnectARN :: Lens' QuickConnect (Maybe Text) Source #

The Amazon Resource Name (ARN) of the quick connect.

quickConnect_quickConnectConfig :: Lens' QuickConnect (Maybe QuickConnectConfig) Source #

Contains information about the quick connect.

QuickConnectConfig

quickConnectConfig_queueConfig :: Lens' QuickConnectConfig (Maybe QueueQuickConnectConfig) Source #

The queue configuration. This is required only if QuickConnectType is QUEUE.

quickConnectConfig_userConfig :: Lens' QuickConnectConfig (Maybe UserQuickConnectConfig) Source #

The user configuration. This is required only if QuickConnectType is USER.

quickConnectConfig_phoneConfig :: Lens' QuickConnectConfig (Maybe PhoneNumberQuickConnectConfig) Source #

The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

quickConnectConfig_quickConnectType :: Lens' QuickConnectConfig QuickConnectType Source #

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

QuickConnectSummary

quickConnectSummary_arn :: Lens' QuickConnectSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the quick connect.

quickConnectSummary_quickConnectType :: Lens' QuickConnectSummary (Maybe QuickConnectType) Source #

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

quickConnectSummary_id :: Lens' QuickConnectSummary (Maybe Text) Source #

The identifier for the quick connect.

Reference

reference_value :: Lens' Reference Text Source #

A formatted URL that displays to an agent in the Contact Control Panel (CCP)

RoutingProfile

routingProfile_instanceId :: Lens' RoutingProfile (Maybe Text) Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

routingProfile_routingProfileArn :: Lens' RoutingProfile (Maybe Text) Source #

The Amazon Resource Name (ARN) of the routing profile.

routingProfile_routingProfileId :: Lens' RoutingProfile (Maybe Text) Source #

The identifier of the routing profile.

routingProfile_defaultOutboundQueueId :: Lens' RoutingProfile (Maybe Text) Source #

The identifier of the default outbound queue for this routing profile.

routingProfile_name :: Lens' RoutingProfile (Maybe Text) Source #

The name of the routing profile.

routingProfile_mediaConcurrencies :: Lens' RoutingProfile (Maybe [MediaConcurrency]) Source #

The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

routingProfile_description :: Lens' RoutingProfile (Maybe Text) Source #

The description of the routing profile.

RoutingProfileQueueConfig

routingProfileQueueConfig_priority :: Lens' RoutingProfileQueueConfig Natural Source #

The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

routingProfileQueueConfig_delay :: Lens' RoutingProfileQueueConfig Natural Source #

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.

RoutingProfileQueueConfigSummary

routingProfileQueueConfigSummary_priority :: Lens' RoutingProfileQueueConfigSummary Natural Source #

The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

routingProfileQueueConfigSummary_delay :: Lens' RoutingProfileQueueConfigSummary Natural Source #

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.

RoutingProfileQueueReference

routingProfileQueueReference_channel :: Lens' RoutingProfileQueueReference Channel Source #

The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

RoutingProfileSummary

routingProfileSummary_arn :: Lens' RoutingProfileSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the routing profile.

routingProfileSummary_id :: Lens' RoutingProfileSummary (Maybe Text) Source #

The identifier of the routing profile.

S3Config

s3Config_encryptionConfig :: Lens' S3Config (Maybe EncryptionConfig) Source #

The Amazon S3 encryption configuration.

SecurityKey

securityKey_creationTime :: Lens' SecurityKey (Maybe UTCTime) Source #

When the security key was created.

securityKey_associationId :: Lens' SecurityKey (Maybe Text) Source #

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

securityKey_key :: Lens' SecurityKey (Maybe Text) Source #

The key of the security key.

SecurityProfileSummary

securityProfileSummary_arn :: Lens' SecurityProfileSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the security profile.

securityProfileSummary_id :: Lens' SecurityProfileSummary (Maybe Text) Source #

The identifier of the security profile.

Threshold

threshold_thresholdValue :: Lens' Threshold (Maybe Double) Source #

The threshold value to compare.

threshold_comparison :: Lens' Threshold (Maybe Comparison) Source #

The type of comparison. Only "less than" (LT) comparisons are supported.

UseCase

useCase_useCaseType :: Lens' UseCase (Maybe UseCaseType) Source #

The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

useCase_useCaseArn :: Lens' UseCase (Maybe Text) Source #

The Amazon Resource Name (ARN) for the use case.

useCase_useCaseId :: Lens' UseCase (Maybe Text) Source #

The identifier for the use case.

User

user_routingProfileId :: Lens' User (Maybe Text) Source #

The identifier of the routing profile for the user.

user_directoryUserId :: Lens' User (Maybe Text) Source #

The identifier of the user account in the directory used for identity management.

user_arn :: Lens' User (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user account.

user_identityInfo :: Lens' User (Maybe UserIdentityInfo) Source #

Information about the user identity.

user_securityProfileIds :: Lens' User (Maybe (NonEmpty Text)) Source #

The identifiers of the security profiles for the user.

user_username :: Lens' User (Maybe Text) Source #

The user name assigned to the user account.

user_id :: Lens' User (Maybe Text) Source #

The identifier of the user account.

user_hierarchyGroupId :: Lens' User (Maybe Text) Source #

The identifier of the hierarchy group for the user.

user_phoneConfig :: Lens' User (Maybe UserPhoneConfig) Source #

Information about the phone configuration for the user.

UserIdentityInfo

userIdentityInfo_email :: Lens' UserIdentityInfo (Maybe Text) Source #

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

userIdentityInfo_lastName :: Lens' UserIdentityInfo (Maybe Text) Source #

The last name. This is required if you are using Amazon Connect or SAML for identity management.

userIdentityInfo_firstName :: Lens' UserIdentityInfo (Maybe Text) Source #

The first name. This is required if you are using Amazon Connect or SAML for identity management.

UserPhoneConfig

userPhoneConfig_afterContactWorkTimeLimit :: Lens' UserPhoneConfig (Maybe Natural) Source #

The After Call Work (ACW) timeout setting, in seconds.

userPhoneConfig_deskPhoneNumber :: Lens' UserPhoneConfig (Maybe Text) Source #

The phone number for the user's desk phone.

UserQuickConnectConfig

UserSummary

userSummary_arn :: Lens' UserSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user account.

userSummary_username :: Lens' UserSummary (Maybe Text) Source #

The Amazon Connect user name of the user account.

userSummary_id :: Lens' UserSummary (Maybe Text) Source #

The identifier of the user account.

VoiceRecordingConfiguration