Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Connect.Lens

Contents

Operations
Types

Description

Synopsis

Operations

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.

associateApprovedOrigin_origin :: Lens' AssociateApprovedOrigin Text Source #

The domain to add to your allow list.

AssociateBot

associateBot_lexBot :: Lens' AssociateBot (Maybe LexBot) Source #

Undocumented member.

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.

AssociateDefaultVocabulary

associateDefaultVocabulary_vocabularyId :: Lens' AssociateDefaultVocabulary (Maybe Text) Source #

The identifier of the custom vocabulary. If this is empty, the default is set to none.

associateDefaultVocabulary_instanceId :: Lens' AssociateDefaultVocabulary Text Source #

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

associateDefaultVocabulary_languageCode :: Lens' AssociateDefaultVocabulary VocabularyLanguageCode Source #

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

associateDefaultVocabularyResponse_httpStatus :: Lens' AssociateDefaultVocabularyResponse Int Source #

The response's http status code.

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.

associateInstanceStorageConfig_resourceType :: Lens' AssociateInstanceStorageConfig InstanceStorageResourceType Source #

A valid resource type.

associateInstanceStorageConfig_storageConfig :: Lens' AssociateInstanceStorageConfig InstanceStorageConfig Source #

A valid storage type.

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.

associateInstanceStorageConfigResponse_httpStatus :: Lens' AssociateInstanceStorageConfigResponse Int Source #

The response's http status code.

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.

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.

AssociatePhoneNumberContactFlow

associatePhoneNumberContactFlow_phoneNumberId :: Lens' AssociatePhoneNumberContactFlow Text Source #

A unique identifier for the phone number.

associatePhoneNumberContactFlow_instanceId :: Lens' AssociatePhoneNumberContactFlow Text Source #

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

associatePhoneNumberContactFlow_contactFlowId :: Lens' AssociatePhoneNumberContactFlow Text Source #

The identifier of the flow.

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.

associateQueueQuickConnects_queueId :: Lens' AssociateQueueQuickConnects Text Source #

The identifier for the queue.

associateQueueQuickConnects_quickConnectIds :: Lens' AssociateQueueQuickConnects (NonEmpty Text) Source #

The quick connects to associate with this queue.

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.

associateRoutingProfileQueues_routingProfileId :: Lens' AssociateRoutingProfileQueues Text Source #

The identifier of the routing profile.

associateRoutingProfileQueues_queueConfigs :: Lens' AssociateRoutingProfileQueues (NonEmpty RoutingProfileQueueConfig) Source #

The queues to associate with this routing profile.

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.

associateSecurityKeyResponse_httpStatus :: Lens' AssociateSecurityKeyResponse Int Source #

The response's http status code.

ClaimPhoneNumber

claimPhoneNumber_clientToken :: Lens' ClaimPhoneNumber (Maybe Text) Source #

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}$

claimPhoneNumber_phoneNumberDescription :: Lens' ClaimPhoneNumber (Maybe Text) Source #

The description of the phone number.

claimPhoneNumber_tags :: Lens' ClaimPhoneNumber (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

claimPhoneNumber_targetArn :: Lens' ClaimPhoneNumber Text Source #

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

claimPhoneNumber_phoneNumber :: Lens' ClaimPhoneNumber Text Source #

The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].

claimPhoneNumberResponse_phoneNumberArn :: Lens' ClaimPhoneNumberResponse (Maybe Text) Source #

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

claimPhoneNumberResponse_phoneNumberId :: Lens' ClaimPhoneNumberResponse (Maybe Text) Source #

A unique identifier for the phone number.

claimPhoneNumberResponse_httpStatus :: Lens' ClaimPhoneNumberResponse Int Source #

The response's http status code.

CreateAgentStatus

createAgentStatus_description :: Lens' CreateAgentStatus (Maybe Text) Source #

The description of the status.

createAgentStatus_displayOrder :: Lens' CreateAgentStatus (Maybe Natural) Source #

The display order of the status.

createAgentStatus_tags :: Lens' CreateAgentStatus (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

createAgentStatus_instanceId :: Lens' CreateAgentStatus Text Source #

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

createAgentStatus_name :: Lens' CreateAgentStatus Text Source #

The name of the status.

createAgentStatus_state :: Lens' CreateAgentStatus AgentStatusState Source #

The state of the status.

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

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

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

The identifier of the agent status.

createAgentStatusResponse_httpStatus :: Lens' CreateAgentStatusResponse Int Source #

The response's http status code.

CreateContactFlow

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

The description of the flow.

createContactFlow_tags :: Lens' CreateContactFlow (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

createContactFlow_instanceId :: Lens' CreateContactFlow Text Source #

The identifier of the Amazon Connect instance.

createContactFlow_name :: Lens' CreateContactFlow Text Source #

The name of the flow.

createContactFlow_type :: Lens' CreateContactFlow ContactFlowType Source #

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

createContactFlow_content :: Lens' CreateContactFlow Text Source #

The content of the flow.

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

The Amazon Resource Name (ARN) of the flow.

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

The identifier of the flow.

createContactFlowResponse_httpStatus :: Lens' CreateContactFlowResponse Int Source #

The response's http status code.

CreateContactFlowModule

createContactFlowModule_clientToken :: Lens' CreateContactFlowModule (Maybe Text) Source #

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.

createContactFlowModule_description :: Lens' CreateContactFlowModule (Maybe Text) Source #

The description of the flow module.

createContactFlowModule_tags :: Lens' CreateContactFlowModule (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

createContactFlowModule_instanceId :: Lens' CreateContactFlowModule Text Source #

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

createContactFlowModule_name :: Lens' CreateContactFlowModule Text Source #

The name of the flow module.

createContactFlowModule_content :: Lens' CreateContactFlowModule Text Source #

The content of the flow module.

createContactFlowModuleResponse_arn :: Lens' CreateContactFlowModuleResponse (Maybe Text) Source #

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

createContactFlowModuleResponse_id :: Lens' CreateContactFlowModuleResponse (Maybe Text) Source #

The identifier of the flow module.

createContactFlowModuleResponse_httpStatus :: Lens' CreateContactFlowModuleResponse Int Source #

The response's http status code.

CreateHoursOfOperation

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

The description of the hours of operation.

createHoursOfOperation_tags :: Lens' CreateHoursOfOperation (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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_name :: Lens' CreateHoursOfOperation Text Source #

The name of the hours of operation.

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.

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

The identifier for the hours of operation.

createHoursOfOperationResponse_httpStatus :: Lens' CreateHoursOfOperationResponse Int Source #

The response's http status code.

CreateInstance

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

The idempotency token.

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

The identifier for the directory.

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

The name for your instance.

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.

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

The identifier for the instance.

createInstanceResponse_httpStatus :: Lens' CreateInstanceResponse Int Source #

The response's http status code.

CreateIntegrationAssociation

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

The name of the external application. 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_sourceType :: Lens' CreateIntegrationAssociation (Maybe SourceType) Source #

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

createIntegrationAssociation_tags :: Lens' CreateIntegrationAssociation (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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_integrationType :: Lens' CreateIntegrationAssociation IntegrationType Source #

The type of information to be ingested.

createIntegrationAssociation_integrationArn :: Lens' CreateIntegrationAssociation Text Source #

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.

createIntegrationAssociationResponse_integrationAssociationArn :: Lens' CreateIntegrationAssociationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the association.

createIntegrationAssociationResponse_integrationAssociationId :: Lens' CreateIntegrationAssociationResponse (Maybe Text) Source #

The identifier for the integration association.

createIntegrationAssociationResponse_httpStatus :: Lens' CreateIntegrationAssociationResponse Int Source #

The response's http status code.

CreateQueue

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

The description of the queue.

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

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

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

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

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

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

createQueue_tags :: Lens' CreateQueue (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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.

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

The identifier for the queue.

createQueueResponse_httpStatus :: Lens' CreateQueueResponse Int Source #

The response's http status code.

CreateQuickConnect

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

The description of the quick connect.

createQuickConnect_tags :: Lens' CreateQuickConnect (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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.

createQuickConnect_quickConnectConfig :: Lens' CreateQuickConnect QuickConnectConfig Source #

Configuration settings for the quick connect.

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

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

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

The identifier for the quick connect.

createQuickConnectResponse_httpStatus :: Lens' CreateQuickConnectResponse Int Source #

The response's http status code.

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_tags :: Lens' CreateRoutingProfile (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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.

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

The identifier of the routing profile.

createRoutingProfileResponse_httpStatus :: Lens' CreateRoutingProfileResponse Int Source #

The response's http status code.

CreateRule

createRule_clientToken :: Lens' CreateRule (Maybe Text) Source #

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.

createRule_instanceId :: Lens' CreateRule Text Source #

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

createRule_name :: Lens' CreateRule Text Source #

A unique name for the rule.

createRule_triggerEventSource :: Lens' CreateRule RuleTriggerEventSource Source #

The event source to trigger the rule.

createRule_function :: Lens' CreateRule Text Source #

The conditions of the rule.

createRule_actions :: Lens' CreateRule [RuleAction] Source #

A list of actions to be run when the rule is triggered.

createRule_publishStatus :: Lens' CreateRule RulePublishStatus Source #

The publish status of the rule.

createRuleResponse_httpStatus :: Lens' CreateRuleResponse Int Source #

The response's http status code.

createRuleResponse_ruleArn :: Lens' CreateRuleResponse Text Source #

The Amazon Resource Name (ARN) of the rule.

createRuleResponse_ruleId :: Lens' CreateRuleResponse Text Source #

A unique identifier for the rule.

CreateSecurityProfile

createSecurityProfile_allowedAccessControlTags :: Lens' CreateSecurityProfile (Maybe (HashMap Text Text)) Source #

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

createSecurityProfile_description :: Lens' CreateSecurityProfile (Maybe Text) Source #

The description of the security profile.

createSecurityProfile_permissions :: Lens' CreateSecurityProfile (Maybe [Text]) Source #

Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.

createSecurityProfile_tagRestrictedResources :: Lens' CreateSecurityProfile (Maybe [Text]) Source #

The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile | Queue | RoutingProfile

createSecurityProfile_tags :: Lens' CreateSecurityProfile (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

createSecurityProfile_securityProfileName :: Lens' CreateSecurityProfile Text Source #

The name of the security profile.

createSecurityProfile_instanceId :: Lens' CreateSecurityProfile Text Source #

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

createSecurityProfileResponse_securityProfileArn :: Lens' CreateSecurityProfileResponse (Maybe Text) Source #

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

createSecurityProfileResponse_securityProfileId :: Lens' CreateSecurityProfileResponse (Maybe Text) Source #

The identifier for the security profle.

createSecurityProfileResponse_httpStatus :: Lens' CreateSecurityProfileResponse Int Source #

The response's http status code.

CreateTaskTemplate

createTaskTemplate_clientToken :: Lens' CreateTaskTemplate (Maybe Text) Source #

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.

createTaskTemplate_constraints :: Lens' CreateTaskTemplate (Maybe TaskTemplateConstraints) Source #

Constraints that are applicable to the fields listed.

createTaskTemplate_contactFlowId :: Lens' CreateTaskTemplate (Maybe Text) Source #

The identifier of the flow that runs by default when a task is created by referencing this template.

createTaskTemplate_defaults :: Lens' CreateTaskTemplate (Maybe TaskTemplateDefaults) Source #

The default values for fields when a task is created by referencing this template.

createTaskTemplate_description :: Lens' CreateTaskTemplate (Maybe Text) Source #

The description of the task template.

createTaskTemplate_status :: Lens' CreateTaskTemplate (Maybe TaskTemplateStatus) Source #

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.

createTaskTemplate_instanceId :: Lens' CreateTaskTemplate Text Source #

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

createTaskTemplate_name :: Lens' CreateTaskTemplate Text Source #

The name of the task template.

createTaskTemplate_fields :: Lens' CreateTaskTemplate [TaskTemplateField] Source #

Fields that are part of the template.

createTaskTemplateResponse_httpStatus :: Lens' CreateTaskTemplateResponse Int Source #

The response's http status code.

createTaskTemplateResponse_id :: Lens' CreateTaskTemplateResponse Text Source #

The identifier of the task template resource.

createTaskTemplateResponse_arn :: Lens' CreateTaskTemplateResponse Text Source #

The Amazon Resource Name (ARN) for the task template resource.

CreateTrafficDistributionGroup

createTrafficDistributionGroup_clientToken :: Lens' CreateTrafficDistributionGroup (Maybe Text) Source #

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.

createTrafficDistributionGroup_description :: Lens' CreateTrafficDistributionGroup (Maybe Text) Source #

A description for the traffic distribution group.

createTrafficDistributionGroup_tags :: Lens' CreateTrafficDistributionGroup (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

createTrafficDistributionGroup_name :: Lens' CreateTrafficDistributionGroup Text Source #

The name for the traffic distribution group.

createTrafficDistributionGroup_instanceId :: Lens' CreateTrafficDistributionGroup Text Source #

The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId in the ARN of the instance.

createTrafficDistributionGroupResponse_arn :: Lens' CreateTrafficDistributionGroupResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the traffic distribution group.

createTrafficDistributionGroupResponse_id :: Lens' CreateTrafficDistributionGroupResponse (Maybe Text) Source #

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.

createTrafficDistributionGroupResponse_httpStatus :: Lens' CreateTrafficDistributionGroupResponse Int Source #

The response's http status code.

CreateUseCase

createUseCase_tags :: Lens' CreateUseCase (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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.

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

The identifier of the use case.

createUseCaseResponse_httpStatus :: Lens' CreateUseCaseResponse Int Source #

The response's http status code.

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_hierarchyGroupId :: Lens' CreateUser (Maybe Text) Source #

The identifier of the hierarchy group for the user.

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_tags :: Lens' CreateUser (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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_userArn :: Lens' CreateUserResponse (Maybe Text) Source #

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

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

The identifier of the user account.

createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #

The response's http status code.

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_tags :: Lens' CreateUserHierarchyGroup (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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.

createUserHierarchyGroupResponse_hierarchyGroupArn :: Lens' CreateUserHierarchyGroupResponse (Maybe Text) Source #

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

createUserHierarchyGroupResponse_hierarchyGroupId :: Lens' CreateUserHierarchyGroupResponse (Maybe Text) Source #

The identifier of the hierarchy group.

createUserHierarchyGroupResponse_httpStatus :: Lens' CreateUserHierarchyGroupResponse Int Source #

The response's http status code.

CreateVocabulary

createVocabulary_clientToken :: Lens' CreateVocabulary (Maybe Text) Source #

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.

createVocabulary_tags :: Lens' CreateVocabulary (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

createVocabulary_instanceId :: Lens' CreateVocabulary Text Source #

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

createVocabulary_vocabularyName :: Lens' CreateVocabulary Text Source #

A unique name of the custom vocabulary.

createVocabulary_languageCode :: Lens' CreateVocabulary VocabularyLanguageCode Source #

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

createVocabulary_content :: Lens' CreateVocabulary Text Source #

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.

createVocabularyResponse_httpStatus :: Lens' CreateVocabularyResponse Int Source #

The response's http status code.

createVocabularyResponse_vocabularyArn :: Lens' CreateVocabularyResponse Text Source #

The Amazon Resource Name (ARN) of the custom vocabulary.

createVocabularyResponse_vocabularyId :: Lens' CreateVocabularyResponse Text Source #

The identifier of the custom vocabulary.

createVocabularyResponse_state :: Lens' CreateVocabularyResponse VocabularyState Source #

The current state of the custom vocabulary.

DeleteContactFlow

deleteContactFlow_instanceId :: Lens' DeleteContactFlow Text Source #

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

deleteContactFlow_contactFlowId :: Lens' DeleteContactFlow Text Source #

The identifier of the flow.

DeleteContactFlowModule

deleteContactFlowModule_instanceId :: Lens' DeleteContactFlowModule Text Source #

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

deleteContactFlowModule_contactFlowModuleId :: Lens' DeleteContactFlowModule Text Source #

The identifier of the flow module.

deleteContactFlowModuleResponse_httpStatus :: Lens' DeleteContactFlowModuleResponse Int Source #

The response's http status code.

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.

deleteHoursOfOperation_hoursOfOperationId :: Lens' DeleteHoursOfOperation Text Source #

The identifier for the hours of operation.

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.

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.

deleteIntegrationAssociation_integrationAssociationId :: Lens' DeleteIntegrationAssociation Text Source #

The identifier for the integration association.

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.

DeleteRule

deleteRule_instanceId :: Lens' DeleteRule Text Source #

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

deleteRule_ruleId :: Lens' DeleteRule Text Source #

A unique identifier for the rule.

DeleteSecurityProfile

deleteSecurityProfile_instanceId :: Lens' DeleteSecurityProfile Text Source #

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

deleteSecurityProfile_securityProfileId :: Lens' DeleteSecurityProfile Text Source #

The identifier for the security profle.

DeleteTaskTemplate

deleteTaskTemplate_instanceId :: Lens' DeleteTaskTemplate Text Source #

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

deleteTaskTemplate_taskTemplateId :: Lens' DeleteTaskTemplate Text Source #

A unique identifier for the task template.

deleteTaskTemplateResponse_httpStatus :: Lens' DeleteTaskTemplateResponse Int Source #

The response's http status code.

DeleteTrafficDistributionGroup

deleteTrafficDistributionGroup_trafficDistributionGroupId :: Lens' DeleteTrafficDistributionGroup Text Source #

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.

deleteTrafficDistributionGroupResponse_httpStatus :: Lens' DeleteTrafficDistributionGroupResponse Int Source #

The response's http status code.

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.

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.

DeleteUserHierarchyGroup

deleteUserHierarchyGroup_hierarchyGroupId :: Lens' DeleteUserHierarchyGroup Text Source #

The identifier of the hierarchy group.

deleteUserHierarchyGroup_instanceId :: Lens' DeleteUserHierarchyGroup Text Source #

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

DeleteVocabulary

deleteVocabulary_instanceId :: Lens' DeleteVocabulary Text Source #

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

deleteVocabulary_vocabularyId :: Lens' DeleteVocabulary Text Source #

The identifier of the custom vocabulary.

deleteVocabularyResponse_httpStatus :: Lens' DeleteVocabularyResponse Int Source #

The response's http status code.

deleteVocabularyResponse_vocabularyArn :: Lens' DeleteVocabularyResponse Text Source #

The Amazon Resource Name (ARN) of the custom vocabulary.

deleteVocabularyResponse_vocabularyId :: Lens' DeleteVocabularyResponse Text Source #

The identifier of the custom vocabulary.

deleteVocabularyResponse_state :: Lens' DeleteVocabularyResponse VocabularyState Source #

The current state of the custom vocabulary.

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.

describeAgentStatus_agentStatusId :: Lens' DescribeAgentStatus Text Source #

The identifier for the agent status.

describeAgentStatusResponse_agentStatus :: Lens' DescribeAgentStatusResponse (Maybe AgentStatus) Source #

The agent status.

describeAgentStatusResponse_httpStatus :: Lens' DescribeAgentStatusResponse Int Source #

The response's http status code.

DescribeContact

describeContact_instanceId :: Lens' DescribeContact Text Source #

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

describeContact_contactId :: Lens' DescribeContact Text Source #

The identifier of the contact.

describeContactResponse_contact :: Lens' DescribeContactResponse (Maybe Contact) Source #

Information about the contact.

describeContactResponse_httpStatus :: Lens' DescribeContactResponse Int Source #

The response's http status code.

DescribeContactFlow

describeContactFlow_instanceId :: Lens' DescribeContactFlow Text Source #

The identifier of the Amazon Connect instance.

describeContactFlow_contactFlowId :: Lens' DescribeContactFlow Text Source #

The identifier of the flow.

describeContactFlowResponse_contactFlow :: Lens' DescribeContactFlowResponse (Maybe ContactFlow) Source #

Information about the flow.

describeContactFlowResponse_httpStatus :: Lens' DescribeContactFlowResponse Int Source #

The response's http status code.

DescribeContactFlowModule

describeContactFlowModule_instanceId :: Lens' DescribeContactFlowModule Text Source #

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

describeContactFlowModule_contactFlowModuleId :: Lens' DescribeContactFlowModule Text Source #

The identifier of the flow module.

describeContactFlowModuleResponse_contactFlowModule :: Lens' DescribeContactFlowModuleResponse (Maybe ContactFlowModule) Source #

Information about the flow module.

describeContactFlowModuleResponse_httpStatus :: Lens' DescribeContactFlowModuleResponse Int Source #

The response's http status code.

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.

describeHoursOfOperation_hoursOfOperationId :: Lens' DescribeHoursOfOperation Text Source #

The identifier for the hours of operation.

describeHoursOfOperationResponse_hoursOfOperation :: Lens' DescribeHoursOfOperationResponse (Maybe HoursOfOperation) Source #

The hours of operation.

describeHoursOfOperationResponse_httpStatus :: Lens' DescribeHoursOfOperationResponse Int Source #

The response's http status code.

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.

describeInstanceResponse_instance :: Lens' DescribeInstanceResponse (Maybe Instance) Source #

The name of the instance.

describeInstanceResponse_httpStatus :: Lens' DescribeInstanceResponse Int Source #

The response's http status code.

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.

describeInstanceAttribute_attributeType :: Lens' DescribeInstanceAttribute InstanceAttributeType Source #

The type of attribute.

describeInstanceAttributeResponse_attribute :: Lens' DescribeInstanceAttributeResponse (Maybe Attribute) Source #

The type of attribute.

describeInstanceAttributeResponse_httpStatus :: Lens' DescribeInstanceAttributeResponse Int Source #

The response's http status code.

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.

describeInstanceStorageConfig_resourceType :: Lens' DescribeInstanceStorageConfig InstanceStorageResourceType Source #

A valid resource type.

describeInstanceStorageConfigResponse_storageConfig :: Lens' DescribeInstanceStorageConfigResponse (Maybe InstanceStorageConfig) Source #

A valid storage type.

describeInstanceStorageConfigResponse_httpStatus :: Lens' DescribeInstanceStorageConfigResponse Int Source #

The response's http status code.

DescribePhoneNumber

describePhoneNumber_phoneNumberId :: Lens' DescribePhoneNumber Text Source #

A unique identifier for the phone number.

describePhoneNumberResponse_claimedPhoneNumberSummary :: Lens' DescribePhoneNumberResponse (Maybe ClaimedPhoneNumberSummary) Source #

Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.

describePhoneNumberResponse_httpStatus :: Lens' DescribePhoneNumberResponse Int Source #

The response's http status code.

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.

describeQueueResponse_queue :: Lens' DescribeQueueResponse (Maybe Queue) Source #

The name of the queue.

describeQueueResponse_httpStatus :: Lens' DescribeQueueResponse Int Source #

The response's http status code.

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.

describeQuickConnect_quickConnectId :: Lens' DescribeQuickConnect Text Source #

The identifier for the quick connect.

describeQuickConnectResponse_quickConnect :: Lens' DescribeQuickConnectResponse (Maybe QuickConnect) Source #

Information about the quick connect.

describeQuickConnectResponse_httpStatus :: Lens' DescribeQuickConnectResponse Int Source #

The response's http status code.

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.

describeRoutingProfile_routingProfileId :: Lens' DescribeRoutingProfile Text Source #

The identifier of the routing profile.

describeRoutingProfileResponse_routingProfile :: Lens' DescribeRoutingProfileResponse (Maybe RoutingProfile) Source #

The routing profile.

describeRoutingProfileResponse_httpStatus :: Lens' DescribeRoutingProfileResponse Int Source #

The response's http status code.

DescribeRule

describeRule_instanceId :: Lens' DescribeRule Text Source #

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

describeRule_ruleId :: Lens' DescribeRule Text Source #

A unique identifier for the rule.

describeRuleResponse_httpStatus :: Lens' DescribeRuleResponse Int Source #

The response's http status code.

describeRuleResponse_rule :: Lens' DescribeRuleResponse Rule Source #

Information about the rule.

DescribeSecurityProfile

describeSecurityProfile_securityProfileId :: Lens' DescribeSecurityProfile Text Source #

The identifier for the security profle.

describeSecurityProfile_instanceId :: Lens' DescribeSecurityProfile Text Source #

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

describeSecurityProfileResponse_securityProfile :: Lens' DescribeSecurityProfileResponse (Maybe SecurityProfile) Source #

The security profile.

describeSecurityProfileResponse_httpStatus :: Lens' DescribeSecurityProfileResponse Int Source #

The response's http status code.

DescribeTrafficDistributionGroup

describeTrafficDistributionGroup_trafficDistributionGroupId :: Lens' DescribeTrafficDistributionGroup Text Source #

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.

describeTrafficDistributionGroupResponse_trafficDistributionGroup :: Lens' DescribeTrafficDistributionGroupResponse (Maybe TrafficDistributionGroup) Source #

Information about the traffic distribution group.

describeTrafficDistributionGroupResponse_httpStatus :: Lens' DescribeTrafficDistributionGroupResponse Int Source #

The response's http status code.

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.

describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int Source #

The response's http status code.

DescribeUserHierarchyGroup

describeUserHierarchyGroup_hierarchyGroupId :: Lens' DescribeUserHierarchyGroup Text Source #

The identifier of the hierarchy group.

describeUserHierarchyGroup_instanceId :: Lens' DescribeUserHierarchyGroup Text Source #

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

describeUserHierarchyGroupResponse_hierarchyGroup :: Lens' DescribeUserHierarchyGroupResponse (Maybe HierarchyGroup) Source #

Information about the hierarchy group.

describeUserHierarchyGroupResponse_httpStatus :: Lens' DescribeUserHierarchyGroupResponse Int Source #

The response's http status code.

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.

describeUserHierarchyStructureResponse_hierarchyStructure :: Lens' DescribeUserHierarchyStructureResponse (Maybe HierarchyStructure) Source #

Information about the hierarchy structure.

describeUserHierarchyStructureResponse_httpStatus :: Lens' DescribeUserHierarchyStructureResponse Int Source #

The response's http status code.

DescribeVocabulary

describeVocabulary_instanceId :: Lens' DescribeVocabulary Text Source #

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

describeVocabulary_vocabularyId :: Lens' DescribeVocabulary Text Source #

The identifier of the custom vocabulary.

describeVocabularyResponse_httpStatus :: Lens' DescribeVocabularyResponse Int Source #

The response's http status code.

describeVocabularyResponse_vocabulary :: Lens' DescribeVocabularyResponse Vocabulary Source #

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.

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.

DisassociateBot

disassociateBot_lexBot :: Lens' DisassociateBot (Maybe LexBot) Source #

Undocumented member.

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.

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.

disassociateInstanceStorageConfig_resourceType :: Lens' DisassociateInstanceStorageConfig InstanceStorageResourceType Source #

A valid resource type.

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.

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 Amazon Web Services Region in which the Amazon Lex bot has been created.

DisassociatePhoneNumberContactFlow

disassociatePhoneNumberContactFlow_phoneNumberId :: Lens' DisassociatePhoneNumberContactFlow Text Source #

A unique identifier for the phone number.

disassociatePhoneNumberContactFlow_instanceId :: Lens' DisassociatePhoneNumberContactFlow Text Source #

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

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.

disassociateQueueQuickConnects_queueId :: Lens' DisassociateQueueQuickConnects Text Source #

The identifier for the queue.

disassociateQueueQuickConnects_quickConnectIds :: Lens' DisassociateQueueQuickConnects (NonEmpty Text) Source #

The quick connects to disassociate from the queue.

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.

disassociateRoutingProfileQueues_routingProfileId :: Lens' DisassociateRoutingProfileQueues Text Source #

The identifier of the routing profile.

disassociateRoutingProfileQueues_queueReferences :: Lens' DisassociateRoutingProfileQueues [RoutingProfileQueueReference] Source #

The queues to disassociate from this routing profile.

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.

DismissUserContact

dismissUserContact_userId :: Lens' DismissUserContact Text Source #

The identifier of the user account.

dismissUserContact_instanceId :: Lens' DismissUserContact Text Source #

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

dismissUserContact_contactId :: Lens' DismissUserContact Text Source #

The identifier of the contact.

dismissUserContactResponse_httpStatus :: Lens' DismissUserContactResponse Int Source #

The response's http status code.

GetContactAttributes

getContactAttributes_instanceId :: Lens' GetContactAttributes Text Source #

The identifier of the Amazon Connect instance.

getContactAttributes_initialContactId :: Lens' GetContactAttributes Text Source #

The identifier of the initial contact.

getContactAttributesResponse_attributes :: Lens' GetContactAttributesResponse (Maybe (HashMap Text Text)) Source #

Information about the attributes.

getContactAttributesResponse_httpStatus :: Lens' GetContactAttributesResponse Int Source #

The response's http status code.

GetCurrentMetricData

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

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

The maximum number of results to return per page.

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_sortCriteria :: Lens' GetCurrentMetricData (Maybe [CurrentMetricSortCriteria]) Source #

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.

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

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.

Currently tagging is only supported on the resources that are passed in the filter.

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_approximateTotalCount :: Lens' GetCurrentMetricDataResponse (Maybe Integer) Source #

The total count of the result, regardless of the current page size.

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

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

getCurrentMetricDataResponse_metricResults :: Lens' GetCurrentMetricDataResponse (Maybe [CurrentMetricResult]) Source #

Information about the real-time metrics.

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.

getCurrentMetricDataResponse_httpStatus :: Lens' GetCurrentMetricDataResponse Int Source #

The response's http status code.

GetCurrentUserData

getCurrentUserData_maxResults :: Lens' GetCurrentUserData (Maybe Natural) Source #

The maximum number of results to return per page.

getCurrentUserData_nextToken :: Lens' GetCurrentUserData (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.

getCurrentUserData_instanceId :: Lens' GetCurrentUserData Text Source #

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

getCurrentUserData_filters :: Lens' GetCurrentUserData UserDataFilters Source #

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.

getCurrentUserDataResponse_approximateTotalCount :: Lens' GetCurrentUserDataResponse (Maybe Integer) Source #

The total count of the result, regardless of the current page size.

getCurrentUserDataResponse_nextToken :: Lens' GetCurrentUserDataResponse (Maybe Text) Source #

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

getCurrentUserDataResponse_userDataList :: Lens' GetCurrentUserDataResponse (Maybe [UserData]) Source #

A list of the user data that is returned.

getCurrentUserDataResponse_httpStatus :: Lens' GetCurrentUserDataResponse Int Source #

The response's http status code.

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.

getFederationTokenResponse_credentials :: Lens' GetFederationTokenResponse (Maybe Credentials) Source #

The credentials to use for federation.

getFederationTokenResponse_signInUrl :: Lens' GetFederationTokenResponse (Maybe Text) Source #

The URL to sign into the user's instance.

getFederationTokenResponse_userArn :: Lens' GetFederationTokenResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user.

getFederationTokenResponse_userId :: Lens' GetFederationTokenResponse (Maybe Text) Source #

The identifier for the user.

getFederationTokenResponse_httpStatus :: Lens' GetFederationTokenResponse Int Source #

The response's http status code.

GetMetricData

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

getMetricDataResponse_httpStatus :: Lens' GetMetricDataResponse Int Source #

The response's http status code.

GetTaskTemplate

getTaskTemplate_snapshotVersion :: Lens' GetTaskTemplate (Maybe Text) Source #

The system generated version of a task template that is associated with a task, when the task is created.

getTaskTemplate_instanceId :: Lens' GetTaskTemplate Text Source #

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

getTaskTemplate_taskTemplateId :: Lens' GetTaskTemplate Text Source #

A unique identifier for the task template.

getTaskTemplateResponse_constraints :: Lens' GetTaskTemplateResponse (Maybe TaskTemplateConstraints) Source #

Constraints that are applicable to the fields listed.

getTaskTemplateResponse_contactFlowId :: Lens' GetTaskTemplateResponse (Maybe Text) Source #

The identifier of the flow that runs by default when a task is created by referencing this template.

getTaskTemplateResponse_createdTime :: Lens' GetTaskTemplateResponse (Maybe UTCTime) Source #

The timestamp when the task template was created.

getTaskTemplateResponse_defaults :: Lens' GetTaskTemplateResponse (Maybe TaskTemplateDefaults) Source #

The default values for fields when a task is created by referencing this template.

getTaskTemplateResponse_description :: Lens' GetTaskTemplateResponse (Maybe Text) Source #

The description of the task template.

getTaskTemplateResponse_fields :: Lens' GetTaskTemplateResponse (Maybe [TaskTemplateField]) Source #

Fields that are part of the template.

getTaskTemplateResponse_instanceId :: Lens' GetTaskTemplateResponse (Maybe Text) Source #

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

getTaskTemplateResponse_lastModifiedTime :: Lens' GetTaskTemplateResponse (Maybe UTCTime) Source #

The timestamp when the task template was last modified.

getTaskTemplateResponse_status :: Lens' GetTaskTemplateResponse (Maybe TaskTemplateStatus) Source #

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.

getTaskTemplateResponse_tags :: Lens' GetTaskTemplateResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

getTaskTemplateResponse_httpStatus :: Lens' GetTaskTemplateResponse Int Source #

The response's http status code.

getTaskTemplateResponse_id :: Lens' GetTaskTemplateResponse Text Source #

A unique identifier for the task template.

getTaskTemplateResponse_arn :: Lens' GetTaskTemplateResponse Text Source #

The Amazon Resource Name (ARN).

getTaskTemplateResponse_name :: Lens' GetTaskTemplateResponse Text Source #

The name of the task template.

GetTrafficDistribution

getTrafficDistribution_id :: Lens' GetTrafficDistribution Text Source #

The identifier of the traffic distribution group.

getTrafficDistributionResponse_arn :: Lens' GetTrafficDistributionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the traffic distribution group.

getTrafficDistributionResponse_id :: Lens' GetTrafficDistributionResponse (Maybe Text) Source #

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.

getTrafficDistributionResponse_telephonyConfig :: Lens' GetTrafficDistributionResponse (Maybe TelephonyConfig) Source #

The distribution of traffic between the instance and its replicas.

getTrafficDistributionResponse_httpStatus :: Lens' GetTrafficDistributionResponse Int Source #

The response's http status code.

ListAgentStatuses

listAgentStatuses_agentStatusTypes :: Lens' ListAgentStatuses (Maybe [AgentStatusType]) Source #

Available agent status types.

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

The maximum number of results to return per page.

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_instanceId :: Lens' ListAgentStatuses Text Source #

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

listAgentStatusesResponse_agentStatusSummaryList :: Lens' ListAgentStatusesResponse (Maybe [AgentStatusSummary]) Source #

A summary of agent statuses.

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

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

listAgentStatusesResponse_httpStatus :: Lens' ListAgentStatusesResponse Int Source #

The response's http status code.

ListApprovedOrigins

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

The maximum number of results to return per page.

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

listApprovedOriginsResponse_origins :: Lens' ListApprovedOriginsResponse (Maybe [Text]) Source #

The approved origins.

listApprovedOriginsResponse_httpStatus :: Lens' ListApprovedOriginsResponse Int Source #

The response's http status code.

ListBots

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

The maximum number of results to return per page.

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_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_lexBots :: Lens' ListBotsResponse (Maybe [LexBotConfig]) Source #

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

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

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

listBotsResponse_httpStatus :: Lens' ListBotsResponse Int Source #

The response's http status code.

ListContactFlowModules

listContactFlowModules_contactFlowModuleState :: Lens' ListContactFlowModules (Maybe ContactFlowModuleState) Source #

The state of the flow module.

listContactFlowModules_maxResults :: Lens' ListContactFlowModules (Maybe Natural) Source #

The maximum number of results to return per page.

listContactFlowModules_nextToken :: Lens' ListContactFlowModules (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.

listContactFlowModules_instanceId :: Lens' ListContactFlowModules Text Source #

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

listContactFlowModulesResponse_contactFlowModulesSummaryList :: Lens' ListContactFlowModulesResponse (Maybe [ContactFlowModuleSummary]) Source #

Information about the flow module.

listContactFlowModulesResponse_nextToken :: Lens' ListContactFlowModulesResponse (Maybe Text) Source #

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

listContactFlowModulesResponse_httpStatus :: Lens' ListContactFlowModulesResponse Int Source #

The response's http status code.

ListContactFlows

listContactFlows_contactFlowTypes :: Lens' ListContactFlows (Maybe [ContactFlowType]) Source #

The type of flow.

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

The maximum number of results to return per page. The default MaxResult size is 100.

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_instanceId :: Lens' ListContactFlows Text Source #

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

listContactFlowsResponse_contactFlowSummaryList :: Lens' ListContactFlowsResponse (Maybe [ContactFlowSummary]) Source #

Information about the flows.

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

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

listContactFlowsResponse_httpStatus :: Lens' ListContactFlowsResponse Int Source #

The response's http status code.

ListContactReferences

listContactReferences_nextToken :: Lens' ListContactReferences (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.

This is not expected to be set, because the value returned in the previous response is always null.

listContactReferences_instanceId :: Lens' ListContactReferences Text Source #

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

listContactReferences_contactId :: Lens' ListContactReferences Text Source #

The identifier of the initial contact.

listContactReferences_referenceTypes :: Lens' ListContactReferences [ReferenceType] Source #

The type of reference.

listContactReferencesResponse_nextToken :: Lens' ListContactReferencesResponse (Maybe Text) Source #

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

This is always returned as null in the response.

listContactReferencesResponse_referenceSummaryList :: Lens' ListContactReferencesResponse (Maybe [ReferenceSummary]) Source #

Information about the flows.

listContactReferencesResponse_httpStatus :: Lens' ListContactReferencesResponse Int Source #

The response's http status code.

ListDefaultVocabularies

listDefaultVocabularies_languageCode :: Lens' ListDefaultVocabularies (Maybe VocabularyLanguageCode) Source #

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

listDefaultVocabularies_maxResults :: Lens' ListDefaultVocabularies (Maybe Natural) Source #

The maximum number of results to return per page.

listDefaultVocabularies_nextToken :: Lens' ListDefaultVocabularies (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.

listDefaultVocabularies_instanceId :: Lens' ListDefaultVocabularies Text Source #

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

listDefaultVocabulariesResponse_nextToken :: Lens' ListDefaultVocabulariesResponse (Maybe Text) Source #

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

listDefaultVocabulariesResponse_httpStatus :: Lens' ListDefaultVocabulariesResponse Int Source #

The response's http status code.

listDefaultVocabulariesResponse_defaultVocabularyList :: Lens' ListDefaultVocabulariesResponse [DefaultVocabulary] Source #

A list of default vocabularies.

ListHoursOfOperations

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

The maximum number of results to return per page. The default MaxResult size is 100.

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_instanceId :: Lens' ListHoursOfOperations Text Source #

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

listHoursOfOperationsResponse_hoursOfOperationSummaryList :: Lens' ListHoursOfOperationsResponse (Maybe [HoursOfOperationSummary]) Source #

Information about the hours of operation.

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

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

listHoursOfOperationsResponse_httpStatus :: Lens' ListHoursOfOperationsResponse Int Source #

The response's http status code.

ListInstanceAttributes

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

The maximum number of results to return per page.

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_instanceId :: Lens' ListInstanceAttributes Text Source #

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

listInstanceAttributesResponse_attributes :: Lens' ListInstanceAttributesResponse (Maybe [Attribute]) Source #

The attribute types.

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

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

listInstanceAttributesResponse_httpStatus :: Lens' ListInstanceAttributesResponse Int Source #

The response's http status code.

ListInstanceStorageConfigs

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

The maximum number of results to return per page.

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_instanceId :: Lens' ListInstanceStorageConfigs Text Source #

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

listInstanceStorageConfigs_resourceType :: Lens' ListInstanceStorageConfigs InstanceStorageResourceType Source #

A valid resource type.

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

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

listInstanceStorageConfigsResponse_storageConfigs :: Lens' ListInstanceStorageConfigsResponse (Maybe [InstanceStorageConfig]) Source #

A valid storage type.

listInstanceStorageConfigsResponse_httpStatus :: Lens' ListInstanceStorageConfigsResponse Int Source #

The response's http status code.

ListInstances

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

The maximum number of results to return per page.

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.

listInstancesResponse_instanceSummaryList :: Lens' ListInstancesResponse (Maybe [InstanceSummary]) Source #

Information about the instances.

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

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

listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int Source #

The response's http status code.

ListIntegrationAssociations

listIntegrationAssociations_integrationType :: Lens' ListIntegrationAssociations (Maybe IntegrationType) Source #

The integration type.

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

The maximum number of results to return per page.

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_instanceId :: Lens' ListIntegrationAssociations Text Source #

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

listIntegrationAssociationsResponse_integrationAssociationSummaryList :: Lens' ListIntegrationAssociationsResponse (Maybe [IntegrationAssociationSummary]) Source #

The associations.

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

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

listIntegrationAssociationsResponse_httpStatus :: Lens' ListIntegrationAssociationsResponse Int Source #

The response's http status code.

ListLambdaFunctions

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

The maximum number of results to return per page.

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

listLambdaFunctionsResponse_httpStatus :: Lens' ListLambdaFunctionsResponse Int Source #

The response's http status code.

ListLexBots

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_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_instanceId :: Lens' ListLexBots Text Source #

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

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

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

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

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

listLexBotsResponse_httpStatus :: Lens' ListLexBotsResponse Int Source #

The response's http status code.

ListPhoneNumbers

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

The maximum number of results to return per page. The default MaxResult size is 100.

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_phoneNumberCountryCodes :: Lens' ListPhoneNumbers (Maybe [PhoneNumberCountryCode]) Source #

The ISO country code.

listPhoneNumbers_phoneNumberTypes :: Lens' ListPhoneNumbers (Maybe [PhoneNumberType]) Source #

The type of phone number.

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.

listPhoneNumbersResponse_phoneNumberSummaryList :: Lens' ListPhoneNumbersResponse (Maybe [PhoneNumberSummary]) Source #

Information about the phone numbers.

listPhoneNumbersResponse_httpStatus :: Lens' ListPhoneNumbersResponse Int Source #

The response's http status code.

ListPhoneNumbersV2

listPhoneNumbersV2_maxResults :: Lens' ListPhoneNumbersV2 (Maybe Natural) Source #

The maximum number of results to return per page.

listPhoneNumbersV2_nextToken :: Lens' ListPhoneNumbersV2 (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.

listPhoneNumbersV2_phoneNumberCountryCodes :: Lens' ListPhoneNumbersV2 (Maybe [PhoneNumberCountryCode]) Source #

The ISO country code.

listPhoneNumbersV2_phoneNumberPrefix :: Lens' ListPhoneNumbersV2 (Maybe Text) Source #

The prefix of the phone number. If provided, it must contain + as part of the country code.

listPhoneNumbersV2_phoneNumberTypes :: Lens' ListPhoneNumbersV2 (Maybe [PhoneNumberType]) Source #

The type of phone number.

listPhoneNumbersV2_targetArn :: Lens' ListPhoneNumbersV2 (Maybe Text) Source #

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is 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.

listPhoneNumbersV2Response_listPhoneNumbersSummaryList :: Lens' ListPhoneNumbersV2Response (Maybe [ListPhoneNumbersSummary]) Source #

Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.

listPhoneNumbersV2Response_nextToken :: Lens' ListPhoneNumbersV2Response (Maybe Text) Source #

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

listPhoneNumbersV2Response_httpStatus :: Lens' ListPhoneNumbersV2Response Int Source #

The response's http status code.

ListPrompts

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

The maximum number of results to return per page. The default MaxResult size is 100.

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

listPromptsResponse_promptSummaryList :: Lens' ListPromptsResponse (Maybe [PromptSummary]) Source #

Information about the prompts.

listPromptsResponse_httpStatus :: Lens' ListPromptsResponse Int Source #

The response's http status code.

ListQueueQuickConnects

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

The maximum number of results to return per page. The default MaxResult size is 100.

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_instanceId :: Lens' ListQueueQuickConnects Text Source #

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

listQueueQuickConnects_queueId :: Lens' ListQueueQuickConnects Text Source #

The identifier for the queue.

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

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

listQueueQuickConnectsResponse_quickConnectSummaryList :: Lens' ListQueueQuickConnectsResponse (Maybe [QuickConnectSummary]) Source #

Information about the quick connects.

listQueueQuickConnectsResponse_httpStatus :: Lens' ListQueueQuickConnectsResponse Int Source #

The response's http status code.

ListQueues

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

The maximum number of results to return per page. The default MaxResult size is 100.

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_queueTypes :: Lens' ListQueues (Maybe [QueueType]) Source #

The type of queue.

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.

listQueuesResponse_queueSummaryList :: Lens' ListQueuesResponse (Maybe [QueueSummary]) Source #

Information about the queues.

listQueuesResponse_httpStatus :: Lens' ListQueuesResponse Int Source #

The response's http status code.

ListQuickConnects

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

The maximum number of results to return per page. The default MaxResult size is 100.

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

listQuickConnectsResponse_quickConnectSummaryList :: Lens' ListQuickConnectsResponse (Maybe [QuickConnectSummary]) Source #

Information about the quick connects.

listQuickConnectsResponse_httpStatus :: Lens' ListQuickConnectsResponse Int Source #

The response's http status code.

ListRoutingProfileQueues

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

The maximum number of results to return per page. The default MaxResult size is 100.

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_instanceId :: Lens' ListRoutingProfileQueues Text Source #

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

listRoutingProfileQueues_routingProfileId :: Lens' ListRoutingProfileQueues Text Source #

The identifier of the routing profile.

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

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

listRoutingProfileQueuesResponse_routingProfileQueueConfigSummaryList :: Lens' ListRoutingProfileQueuesResponse (Maybe [RoutingProfileQueueConfigSummary]) Source #

Information about the routing profiles.

listRoutingProfileQueuesResponse_httpStatus :: Lens' ListRoutingProfileQueuesResponse Int Source #

The response's http status code.

ListRoutingProfiles

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

The maximum number of results to return per page. The default MaxResult size is 100.

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

listRoutingProfilesResponse_routingProfileSummaryList :: Lens' ListRoutingProfilesResponse (Maybe [RoutingProfileSummary]) Source #

Information about the routing profiles.

listRoutingProfilesResponse_httpStatus :: Lens' ListRoutingProfilesResponse Int Source #

The response's http status code.

ListRules

listRules_eventSourceName :: Lens' ListRules (Maybe EventSourceName) Source #

The name of the event source.

listRules_maxResults :: Lens' ListRules (Maybe Natural) Source #

The maximum number of results to return per page.

listRules_nextToken :: Lens' ListRules (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.

listRules_publishStatus :: Lens' ListRules (Maybe RulePublishStatus) Source #

The publish status of the rule.

listRules_instanceId :: Lens' ListRules Text Source #

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

listRulesResponse_nextToken :: Lens' ListRulesResponse (Maybe Text) Source #

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

listRulesResponse_httpStatus :: Lens' ListRulesResponse Int Source #

The response's http status code.

listRulesResponse_ruleSummaryList :: Lens' ListRulesResponse [RuleSummary] Source #

Summary information about a rule.

ListSecurityKeys

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

The maximum number of results to return per page.

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

listSecurityKeysResponse_securityKeys :: Lens' ListSecurityKeysResponse (Maybe [SecurityKey]) Source #

The security keys.

listSecurityKeysResponse_httpStatus :: Lens' ListSecurityKeysResponse Int Source #

The response's http status code.

ListSecurityProfilePermissions

listSecurityProfilePermissions_maxResults :: Lens' ListSecurityProfilePermissions (Maybe Natural) Source #

The maximum number of results to return per page.

listSecurityProfilePermissions_nextToken :: Lens' ListSecurityProfilePermissions (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.

listSecurityProfilePermissions_securityProfileId :: Lens' ListSecurityProfilePermissions Text Source #

The identifier for the security profle.

listSecurityProfilePermissions_instanceId :: Lens' ListSecurityProfilePermissions Text Source #

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

listSecurityProfilePermissionsResponse_nextToken :: Lens' ListSecurityProfilePermissionsResponse (Maybe Text) Source #

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

listSecurityProfilePermissionsResponse_permissions :: Lens' ListSecurityProfilePermissionsResponse (Maybe [Text]) Source #

The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile permissions.

listSecurityProfilePermissionsResponse_httpStatus :: Lens' ListSecurityProfilePermissionsResponse Int Source #

The response's http status code.

ListSecurityProfiles

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

The maximum number of results to return per page. The default MaxResult size is 100.

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

listSecurityProfilesResponse_securityProfileSummaryList :: Lens' ListSecurityProfilesResponse (Maybe [SecurityProfileSummary]) Source #

Information about the security profiles.

listSecurityProfilesResponse_httpStatus :: Lens' ListSecurityProfilesResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

Information about the tags.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ListTaskTemplates

listTaskTemplates_maxResults :: Lens' ListTaskTemplates (Maybe Natural) Source #

The maximum number of results to return per page.

It is not expected that you set this.

listTaskTemplates_name :: Lens' ListTaskTemplates (Maybe Text) Source #

The name of the task template.

listTaskTemplates_nextToken :: Lens' ListTaskTemplates (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.

It is not expected that you set this because the value returned in the previous response is always null.

listTaskTemplates_status :: Lens' ListTaskTemplates (Maybe TaskTemplateStatus) Source #

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.

listTaskTemplates_instanceId :: Lens' ListTaskTemplates Text Source #

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

listTaskTemplatesResponse_nextToken :: Lens' ListTaskTemplatesResponse (Maybe Text) Source #

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

This is always returned as a null in the response.

listTaskTemplatesResponse_taskTemplates :: Lens' ListTaskTemplatesResponse (Maybe [TaskTemplateMetadata]) Source #

Provides details about a list of task templates belonging to an instance.

listTaskTemplatesResponse_httpStatus :: Lens' ListTaskTemplatesResponse Int Source #

The response's http status code.

ListTrafficDistributionGroups

listTrafficDistributionGroups_instanceId :: Lens' ListTrafficDistributionGroups (Maybe Text) Source #

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

listTrafficDistributionGroups_maxResults :: Lens' ListTrafficDistributionGroups (Maybe Natural) Source #

The maximum number of results to return per page.

listTrafficDistributionGroups_nextToken :: Lens' ListTrafficDistributionGroups (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.

listTrafficDistributionGroupsResponse_nextToken :: Lens' ListTrafficDistributionGroupsResponse (Maybe Text) Source #

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

listTrafficDistributionGroupsResponse_trafficDistributionGroupSummaryList :: Lens' ListTrafficDistributionGroupsResponse (Maybe [TrafficDistributionGroupSummary]) Source #

A list of traffic distribution groups.

listTrafficDistributionGroupsResponse_httpStatus :: Lens' ListTrafficDistributionGroupsResponse Int Source #

The response's http status code.

ListUseCases

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

The maximum number of results to return per page.

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

listUseCasesResponse_useCaseSummaryList :: Lens' ListUseCasesResponse (Maybe [UseCase]) Source #

The use cases.

listUseCasesResponse_httpStatus :: Lens' ListUseCasesResponse Int Source #

The response's http status code.

ListUserHierarchyGroups

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

The maximum number of results to return per page. The default MaxResult size is 100.

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

listUserHierarchyGroupsResponse_userHierarchyGroupSummaryList :: Lens' ListUserHierarchyGroupsResponse (Maybe [HierarchyGroupSummary]) Source #

Information about the hierarchy groups.

listUserHierarchyGroupsResponse_httpStatus :: Lens' ListUserHierarchyGroupsResponse Int Source #

The response's http status code.

ListUsers

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

The maximum number of results to return per page. The default MaxResult size is 100.

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_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_userSummaryList :: Lens' ListUsersResponse (Maybe [UserSummary]) Source #

Information about the users.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.

MonitorContact

monitorContact_allowedMonitorCapabilities :: Lens' MonitorContact (Maybe [MonitorCapability]) Source #

Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.

monitorContact_clientToken :: Lens' MonitorContact (Maybe Text) Source #

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.

monitorContact_instanceId :: Lens' MonitorContact Text Source #

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

monitorContact_contactId :: Lens' MonitorContact Text Source #

The identifier of the contact.

monitorContact_userId :: Lens' MonitorContact Text Source #

The identifier of the user account.

monitorContactResponse_contactArn :: Lens' MonitorContactResponse (Maybe Text) Source #

The ARN of the contact.

monitorContactResponse_contactId :: Lens' MonitorContactResponse (Maybe Text) Source #

The identifier of the contact.

monitorContactResponse_httpStatus :: Lens' MonitorContactResponse Int Source #

The response's http status code.

PutUserStatus

putUserStatus_userId :: Lens' PutUserStatus Text Source #

The identifier of the user.

putUserStatus_instanceId :: Lens' PutUserStatus Text Source #

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

putUserStatus_agentStatusId :: Lens' PutUserStatus Text Source #

The identifier of the agent status.

putUserStatusResponse_httpStatus :: Lens' PutUserStatusResponse Int Source #

The response's http status code.

ReleasePhoneNumber

releasePhoneNumber_clientToken :: Lens' ReleasePhoneNumber (Maybe Text) Source #

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.

releasePhoneNumber_phoneNumberId :: Lens' ReleasePhoneNumber Text Source #

A unique identifier for the phone number.

ReplicateInstance

replicateInstance_clientToken :: Lens' ReplicateInstance (Maybe Text) Source #

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.

replicateInstance_instanceId :: Lens' ReplicateInstance Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. You can provide the InstanceId, or the entire ARN.

replicateInstance_replicaRegion :: Lens' ReplicateInstance Text Source #

The Amazon Web Services Region where to replicate the Amazon Connect instance.

replicateInstance_replicaAlias :: Lens' ReplicateInstance Text Source #

The alias for the replicated instance. The ReplicaAlias must be unique.

replicateInstanceResponse_arn :: Lens' ReplicateInstanceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the replicated instance.

replicateInstanceResponse_id :: Lens' ReplicateInstanceResponse (Maybe Text) Source #

The identifier of the replicated instance. You can find the instanceId in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.

replicateInstanceResponse_httpStatus :: Lens' ReplicateInstanceResponse Int Source #

The response's http status code.

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_contactId :: Lens' ResumeContactRecording Text Source #

The identifier of the contact.

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.

resumeContactRecordingResponse_httpStatus :: Lens' ResumeContactRecordingResponse Int Source #

The response's http status code.

SearchAvailablePhoneNumbers

searchAvailablePhoneNumbers_maxResults :: Lens' SearchAvailablePhoneNumbers (Maybe Natural) Source #

The maximum number of results to return per page.

searchAvailablePhoneNumbers_nextToken :: Lens' SearchAvailablePhoneNumbers (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.

searchAvailablePhoneNumbers_phoneNumberPrefix :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The prefix of the phone number. If provided, it must contain + as part of the country code.

searchAvailablePhoneNumbers_targetArn :: Lens' SearchAvailablePhoneNumbers Text Source #

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

searchAvailablePhoneNumbers_phoneNumberCountryCode :: Lens' SearchAvailablePhoneNumbers PhoneNumberCountryCode Source #

The ISO country code.

searchAvailablePhoneNumbers_phoneNumberType :: Lens' SearchAvailablePhoneNumbers PhoneNumberType Source #

The type of phone number.

searchAvailablePhoneNumbersResponse_availableNumbersList :: Lens' SearchAvailablePhoneNumbersResponse (Maybe [AvailableNumberSummary]) Source #

A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.

searchAvailablePhoneNumbersResponse_nextToken :: Lens' SearchAvailablePhoneNumbersResponse (Maybe Text) Source #

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

searchAvailablePhoneNumbersResponse_httpStatus :: Lens' SearchAvailablePhoneNumbersResponse Int Source #

The response's http status code.

SearchQueues

searchQueues_maxResults :: Lens' SearchQueues (Maybe Natural) Source #

The maximum number of results to return per page.

searchQueues_nextToken :: Lens' SearchQueues (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.

searchQueues_searchCriteria :: Lens' SearchQueues (Maybe QueueSearchCriteria) Source #

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.

searchQueues_searchFilter :: Lens' SearchQueues (Maybe QueueSearchFilter) Source #

Filters to be applied to search results.

searchQueues_instanceId :: Lens' SearchQueues Text Source #

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

searchQueuesResponse_approximateTotalCount :: Lens' SearchQueuesResponse (Maybe Integer) Source #

The total number of queues which matched your search query.

searchQueuesResponse_nextToken :: Lens' SearchQueuesResponse (Maybe Text) Source #

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

searchQueuesResponse_queues :: Lens' SearchQueuesResponse (Maybe [Queue]) Source #

Information about the queues.

searchQueuesResponse_httpStatus :: Lens' SearchQueuesResponse Int Source #

The response's http status code.

SearchRoutingProfiles

searchRoutingProfiles_maxResults :: Lens' SearchRoutingProfiles (Maybe Natural) Source #

The maximum number of results to return per page.

searchRoutingProfiles_nextToken :: Lens' SearchRoutingProfiles (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.

searchRoutingProfiles_searchCriteria :: Lens' SearchRoutingProfiles (Maybe RoutingProfileSearchCriteria) Source #

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.

searchRoutingProfiles_searchFilter :: Lens' SearchRoutingProfiles (Maybe RoutingProfileSearchFilter) Source #

Filters to be applied to search results.

searchRoutingProfiles_instanceId :: Lens' SearchRoutingProfiles Text Source #

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

searchRoutingProfilesResponse_approximateTotalCount :: Lens' SearchRoutingProfilesResponse (Maybe Integer) Source #

The total number of routing profiles which matched your search query.

searchRoutingProfilesResponse_nextToken :: Lens' SearchRoutingProfilesResponse (Maybe Text) Source #

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

searchRoutingProfilesResponse_routingProfiles :: Lens' SearchRoutingProfilesResponse (Maybe [RoutingProfile]) Source #

Information about the routing profiles.

searchRoutingProfilesResponse_httpStatus :: Lens' SearchRoutingProfilesResponse Int Source #

The response's http status code.

SearchSecurityProfiles

searchSecurityProfiles_maxResults :: Lens' SearchSecurityProfiles (Maybe Natural) Source #

The maximum number of results to return per page.

searchSecurityProfiles_nextToken :: Lens' SearchSecurityProfiles (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.

searchSecurityProfiles_searchCriteria :: Lens' SearchSecurityProfiles (Maybe SecurityProfileSearchCriteria) Source #

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

searchSecurityProfiles_searchFilter :: Lens' SearchSecurityProfiles (Maybe SecurityProfilesSearchFilter) Source #

Filters to be applied to search results.

searchSecurityProfiles_instanceId :: Lens' SearchSecurityProfiles Text Source #

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

searchSecurityProfilesResponse_approximateTotalCount :: Lens' SearchSecurityProfilesResponse (Maybe Integer) Source #

The total number of security profiles which matched your search query.

searchSecurityProfilesResponse_nextToken :: Lens' SearchSecurityProfilesResponse (Maybe Text) Source #

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

searchSecurityProfilesResponse_securityProfiles :: Lens' SearchSecurityProfilesResponse (Maybe [SecurityProfileSearchSummary]) Source #

Information about the security profiles.

searchSecurityProfilesResponse_httpStatus :: Lens' SearchSecurityProfilesResponse Int Source #

The response's http status code.

SearchUsers

searchUsers_instanceId :: Lens' SearchUsers (Maybe Text) Source #

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

searchUsers_maxResults :: Lens' SearchUsers (Maybe Natural) Source #

The maximum number of results to return per page.

searchUsers_nextToken :: Lens' SearchUsers (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.

searchUsers_searchCriteria :: Lens' SearchUsers (Maybe UserSearchCriteria) Source #

Undocumented member.

searchUsers_searchFilter :: Lens' SearchUsers (Maybe UserSearchFilter) Source #

Filters to be applied to search results.

searchUsersResponse_approximateTotalCount :: Lens' SearchUsersResponse (Maybe Integer) Source #

The total number of users who matched your search query.

searchUsersResponse_nextToken :: Lens' SearchUsersResponse (Maybe Text) Source #

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

searchUsersResponse_users :: Lens' SearchUsersResponse (Maybe [UserSearchSummary]) Source #

Information about the users.

searchUsersResponse_httpStatus :: Lens' SearchUsersResponse Int Source #

The response's http status code.

SearchVocabularies

searchVocabularies_languageCode :: Lens' SearchVocabularies (Maybe VocabularyLanguageCode) Source #

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

searchVocabularies_maxResults :: Lens' SearchVocabularies (Maybe Natural) Source #

The maximum number of results to return per page.

searchVocabularies_nameStartsWith :: Lens' SearchVocabularies (Maybe Text) Source #

The starting pattern of the name of the vocabulary.

searchVocabularies_nextToken :: Lens' SearchVocabularies (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.

searchVocabularies_state :: Lens' SearchVocabularies (Maybe VocabularyState) Source #

The current state of the custom vocabulary.

searchVocabularies_instanceId :: Lens' SearchVocabularies Text Source #

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

searchVocabulariesResponse_nextToken :: Lens' SearchVocabulariesResponse (Maybe Text) Source #

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

searchVocabulariesResponse_vocabularySummaryList :: Lens' SearchVocabulariesResponse (Maybe [VocabularySummary]) Source #

The list of the available custom vocabularies.

searchVocabulariesResponse_httpStatus :: Lens' SearchVocabulariesResponse Int Source #

The response's http status code.

StartChatContact

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 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_chatDurationInMinutes :: Lens' StartChatContact (Maybe Natural) Source #

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

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

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.

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

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

startChatContact_supportedMessagingContentTypes :: Lens' StartChatContact (Maybe [Text]) Source #

The supported chat message content types. 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].

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

startChatContact_participantDetails :: Lens' StartChatContact ParticipantDetails Source #

Information identifying the participant.

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

The identifier of this contact within the Amazon Connect instance.

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_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_httpStatus :: Lens' StartChatContactResponse Int Source #

The response's http status code.

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_contactId :: Lens' StartContactRecording Text Source #

The identifier of the contact.

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.

startContactRecording_voiceRecordingConfiguration :: Lens' StartContactRecording VoiceRecordingConfiguration Source #

The person being recorded.

startContactRecordingResponse_httpStatus :: Lens' StartContactRecordingResponse Int Source #

The response's http status code.

StartContactStreaming

startContactStreaming_instanceId :: Lens' StartContactStreaming Text Source #

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

startContactStreaming_contactId :: Lens' StartContactStreaming Text Source #

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

startContactStreaming_chatStreamingConfiguration :: Lens' StartContactStreaming ChatStreamingConfiguration Source #

The streaming configuration, such as the Amazon SNS streaming endpoint.

startContactStreaming_clientToken :: Lens' StartContactStreaming Text Source #

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.

startContactStreamingResponse_httpStatus :: Lens' StartContactStreamingResponse Int Source #

The response's http status code.

startContactStreamingResponse_streamingId :: Lens' StartContactStreamingResponse Text Source #

The identifier of the streaming configuration enabled.

StartOutboundVoiceContact

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

Configuration of the answering machine detection for this outbound call.

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 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_campaignId :: Lens' StartOutboundVoiceContact (Maybe Text) Source #

The campaign identifier of the outbound communication.

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

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.

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 flow is used. If you do not specify a queue, you must specify a source phone number.

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_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_destinationPhoneNumber :: Lens' StartOutboundVoiceContact Text Source #

The phone number of the customer, in E.164 format.

startOutboundVoiceContact_contactFlowId :: Lens' StartOutboundVoiceContact Text Source #

The identifier of the 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 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

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.

startOutboundVoiceContactResponse_httpStatus :: Lens' StartOutboundVoiceContactResponse Int Source #

The response's http status code.

StartTaskContact

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 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_clientToken :: Lens' StartTaskContact (Maybe Text) Source #

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.

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

The identifier of the 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 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

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_previousContactId :: Lens' StartTaskContact (Maybe Text) Source #

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

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

The identifier for the quick connect.

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_scheduledTime :: Lens' StartTaskContact (Maybe UTCTime) Source #

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.

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

A unique identifier for the task template.

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

startTaskContactResponse_httpStatus :: Lens' StartTaskContactResponse Int Source #

The response's http status code.

StopContact

stopContact_contactId :: Lens' StopContact Text Source #

The ID of the contact.

stopContact_instanceId :: Lens' StopContact Text Source #

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

stopContactResponse_httpStatus :: Lens' StopContactResponse Int Source #

The response's http status code.

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_contactId :: Lens' StopContactRecording Text Source #

The identifier of the contact.

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.

stopContactRecordingResponse_httpStatus :: Lens' StopContactRecordingResponse Int Source #

The response's http status code.

StopContactStreaming

stopContactStreaming_instanceId :: Lens' StopContactStreaming Text Source #

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

stopContactStreaming_contactId :: Lens' StopContactStreaming Text Source #

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

stopContactStreaming_streamingId :: Lens' StopContactStreaming Text Source #

The identifier of the streaming configuration enabled.

stopContactStreamingResponse_httpStatus :: Lens' StopContactStreamingResponse Int Source #

The response's http status code.

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_contactId :: Lens' SuspendContactRecording Text Source #

The identifier of the contact.

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.

suspendContactRecordingResponse_httpStatus :: Lens' SuspendContactRecordingResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

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

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

TransferContact

transferContact_clientToken :: Lens' TransferContact (Maybe Text) Source #

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.

transferContact_queueId :: Lens' TransferContact (Maybe Text) Source #

The identifier for the queue.

transferContact_userId :: Lens' TransferContact (Maybe Text) Source #

The identifier for the user.

transferContact_instanceId :: Lens' TransferContact Text Source #

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

transferContact_contactId :: Lens' TransferContact Text Source #

The identifier of the contact in this instance of Amazon Connect.

transferContact_contactFlowId :: Lens' TransferContact Text Source #

The identifier of the flow.

transferContactResponse_contactArn :: Lens' TransferContactResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the contact.

transferContactResponse_contactId :: Lens' TransferContactResponse (Maybe Text) Source #

The identifier of the contact in this instance of Amazon Connect.

transferContactResponse_httpStatus :: Lens' TransferContactResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The tag keys.

UpdateAgentStatus

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

The description of the agent status.

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_state :: Lens' UpdateAgentStatus (Maybe AgentStatusState) Source #

The state 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.

UpdateContact

updateContact_description :: Lens' UpdateContact (Maybe Text) Source #

The description of the contact.

updateContact_name :: Lens' UpdateContact (Maybe Text) Source #

The name of the contact.

updateContact_references :: Lens' UpdateContact (Maybe (HashMap Text Reference)) Source #

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

updateContact_instanceId :: Lens' UpdateContact Text Source #

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

updateContact_contactId :: Lens' UpdateContact Text Source #

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

updateContactResponse_httpStatus :: Lens' UpdateContactResponse Int Source #

The response's http status code.

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

updateContactAttributesResponse_httpStatus :: Lens' UpdateContactAttributesResponse Int Source #

The response's http status code.

UpdateContactFlowContent

updateContactFlowContent_instanceId :: Lens' UpdateContactFlowContent Text Source #

The identifier of the Amazon Connect instance.

updateContactFlowContent_contactFlowId :: Lens' UpdateContactFlowContent Text Source #

The identifier of the flow.

updateContactFlowContent_content :: Lens' UpdateContactFlowContent Text Source #

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

UpdateContactFlowMetadata

updateContactFlowMetadata_contactFlowState :: Lens' UpdateContactFlowMetadata (Maybe ContactFlowState) Source #

The state of flow.

updateContactFlowMetadata_description :: Lens' UpdateContactFlowMetadata (Maybe Text) Source #

The description of the flow.

updateContactFlowMetadata_name :: Lens' UpdateContactFlowMetadata (Maybe Text) Source #

The name of the flow.

updateContactFlowMetadata_instanceId :: Lens' UpdateContactFlowMetadata Text Source #

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

updateContactFlowMetadata_contactFlowId :: Lens' UpdateContactFlowMetadata Text Source #

The identifier of the flow.

UpdateContactFlowModuleContent

updateContactFlowModuleContent_instanceId :: Lens' UpdateContactFlowModuleContent Text Source #

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

updateContactFlowModuleContent_contactFlowModuleId :: Lens' UpdateContactFlowModuleContent Text Source #

The identifier of the flow module.

updateContactFlowModuleContent_content :: Lens' UpdateContactFlowModuleContent Text Source #

The content of the flow module.

updateContactFlowModuleContentResponse_httpStatus :: Lens' UpdateContactFlowModuleContentResponse Int Source #

The response's http status code.

UpdateContactFlowModuleMetadata

updateContactFlowModuleMetadata_description :: Lens' UpdateContactFlowModuleMetadata (Maybe Text) Source #

The description of the flow module.

updateContactFlowModuleMetadata_name :: Lens' UpdateContactFlowModuleMetadata (Maybe Text) Source #

The name of the flow module.

updateContactFlowModuleMetadata_state :: Lens' UpdateContactFlowModuleMetadata (Maybe ContactFlowModuleState) Source #

The state of flow module.

updateContactFlowModuleMetadata_instanceId :: Lens' UpdateContactFlowModuleMetadata Text Source #

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

updateContactFlowModuleMetadata_contactFlowModuleId :: Lens' UpdateContactFlowModuleMetadata Text Source #

The identifier of the flow module.

updateContactFlowModuleMetadataResponse_httpStatus :: Lens' UpdateContactFlowModuleMetadataResponse Int Source #

The response's http status code.

UpdateContactFlowName

updateContactFlowName_description :: Lens' UpdateContactFlowName (Maybe Text) Source #

The description of the flow.

updateContactFlowName_name :: Lens' UpdateContactFlowName (Maybe Text) Source #

The name of the flow.

updateContactFlowName_instanceId :: Lens' UpdateContactFlowName Text Source #

The identifier of the Amazon Connect instance.

updateContactFlowName_contactFlowId :: Lens' UpdateContactFlowName Text Source #

The identifier of the flow.

UpdateContactSchedule

updateContactSchedule_instanceId :: Lens' UpdateContactSchedule Text Source #

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

updateContactSchedule_contactId :: Lens' UpdateContactSchedule Text Source #

The identifier of the contact.

updateContactSchedule_scheduledTime :: Lens' UpdateContactSchedule UTCTime Source #

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.

updateContactScheduleResponse_httpStatus :: Lens' UpdateContactScheduleResponse Int Source #

The response's http status code.

UpdateHoursOfOperation

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

Configuration information of the hours of operation.

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

The description of the hours of operation.

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

The name of the hours of operation.

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

The time zone 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.

updateHoursOfOperation_hoursOfOperationId :: Lens' UpdateHoursOfOperation Text Source #

The identifier of the hours of operation.

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 Amazon Web Services Support for allowlisting.

updateInstanceAttribute_value :: Lens' UpdateInstanceAttribute Text Source #

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

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.

updateInstanceStorageConfig_resourceType :: Lens' UpdateInstanceStorageConfig InstanceStorageResourceType Source #

A valid resource type.

updateInstanceStorageConfig_storageConfig :: Lens' UpdateInstanceStorageConfig InstanceStorageConfig Source #

Undocumented member.

UpdateParticipantRoleConfig

updateParticipantRoleConfig_instanceId :: Lens' UpdateParticipantRoleConfig Text Source #

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

updateParticipantRoleConfig_contactId :: Lens' UpdateParticipantRoleConfig Text Source #

The identifier of the contact in this instance of Amazon Connect.

updateParticipantRoleConfig_channelConfiguration :: Lens' UpdateParticipantRoleConfig UpdateParticipantRoleConfigChannelInfo Source #

The Amazon Connect channel you want to configure.

updateParticipantRoleConfigResponse_httpStatus :: Lens' UpdateParticipantRoleConfigResponse Int Source #

The response's http status code.

UpdatePhoneNumber

updatePhoneNumber_clientToken :: Lens' UpdatePhoneNumber (Maybe Text) Source #

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.

updatePhoneNumber_phoneNumberId :: Lens' UpdatePhoneNumber Text Source #

A unique identifier for the phone number.

updatePhoneNumber_targetArn :: Lens' UpdatePhoneNumber Text Source #

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

updatePhoneNumberResponse_phoneNumberArn :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #

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

updatePhoneNumberResponse_phoneNumberId :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #

A unique identifier for the phone number.

updatePhoneNumberResponse_httpStatus :: Lens' UpdatePhoneNumberResponse Int Source #

The response's http status code.

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.

updateQueueHoursOfOperation_queueId :: Lens' UpdateQueueHoursOfOperation Text Source #

The identifier for the queue.

updateQueueHoursOfOperation_hoursOfOperationId :: Lens' UpdateQueueHoursOfOperation Text Source #

The identifier for the hours of operation.

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.

updateQueueMaxContacts_queueId :: Lens' UpdateQueueMaxContacts Text Source #

The identifier for the queue.

UpdateQueueName

updateQueueName_description :: Lens' UpdateQueueName (Maybe Text) Source #

The description of the queue.

updateQueueName_name :: Lens' UpdateQueueName (Maybe Text) Source #

The name of the queue.

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.

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.

updateQueueOutboundCallerConfig_queueId :: Lens' UpdateQueueOutboundCallerConfig Text Source #

The identifier for the queue.

updateQueueOutboundCallerConfig_outboundCallerConfig :: Lens' UpdateQueueOutboundCallerConfig OutboundCallerConfig Source #

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

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.

updateQueueStatus_queueId :: Lens' UpdateQueueStatus Text Source #

The identifier for the queue.

updateQueueStatus_status :: Lens' UpdateQueueStatus QueueStatus Source #

The status of the queue.

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_quickConnectId :: Lens' UpdateQuickConnectConfig Text Source #

The identifier for the quick connect.

updateQuickConnectConfig_quickConnectConfig :: Lens' UpdateQuickConnectConfig QuickConnectConfig Source #

Information about the configuration settings for the quick connect.

UpdateQuickConnectName

updateQuickConnectName_description :: Lens' UpdateQuickConnectName (Maybe Text) Source #

The description of the quick connect.

updateQuickConnectName_name :: Lens' UpdateQuickConnectName (Maybe Text) Source #

The name of the quick connect.

updateQuickConnectName_instanceId :: Lens' UpdateQuickConnectName Text Source #

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

updateQuickConnectName_quickConnectId :: Lens' UpdateQuickConnectName Text Source #

The identifier for the quick connect.

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_routingProfileId :: Lens' UpdateRoutingProfileConcurrency Text Source #

The identifier of the routing profile.

updateRoutingProfileConcurrency_mediaConcurrencies :: Lens' UpdateRoutingProfileConcurrency [MediaConcurrency] Source #

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

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.

updateRoutingProfileDefaultOutboundQueue_routingProfileId :: Lens' UpdateRoutingProfileDefaultOutboundQueue Text Source #

The identifier of the routing profile.

updateRoutingProfileDefaultOutboundQueue_defaultOutboundQueueId :: Lens' UpdateRoutingProfileDefaultOutboundQueue Text Source #

The identifier for the default outbound queue.

UpdateRoutingProfileName

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

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

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

The name of the routing profile. Must not be more than 127 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.

updateRoutingProfileName_routingProfileId :: Lens' UpdateRoutingProfileName Text Source #

The identifier of the routing profile.

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_routingProfileId :: Lens' UpdateRoutingProfileQueues Text Source #

The identifier of the routing profile.

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.

UpdateRule

updateRule_ruleId :: Lens' UpdateRule Text Source #

A unique identifier for the rule.

updateRule_instanceId :: Lens' UpdateRule Text Source #

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

updateRule_name :: Lens' UpdateRule Text Source #

The name of the rule. You can change the name only if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

updateRule_function :: Lens' UpdateRule Text Source #

The conditions of the rule.

updateRule_actions :: Lens' UpdateRule [RuleAction] Source #

A list of actions to be run when the rule is triggered.

updateRule_publishStatus :: Lens' UpdateRule RulePublishStatus Source #

The publish status of the rule.

UpdateSecurityProfile

updateSecurityProfile_allowedAccessControlTags :: Lens' UpdateSecurityProfile (Maybe (HashMap Text Text)) Source #

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

updateSecurityProfile_description :: Lens' UpdateSecurityProfile (Maybe Text) Source #

The description of the security profile.

updateSecurityProfile_permissions :: Lens' UpdateSecurityProfile (Maybe [Text]) Source #

The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.

updateSecurityProfile_tagRestrictedResources :: Lens' UpdateSecurityProfile (Maybe [Text]) Source #

The list of resources that a security profile applies tag restrictions to in Amazon Connect.

updateSecurityProfile_securityProfileId :: Lens' UpdateSecurityProfile Text Source #

The identifier for the security profle.

updateSecurityProfile_instanceId :: Lens' UpdateSecurityProfile Text Source #

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

UpdateTaskTemplate

updateTaskTemplate_constraints :: Lens' UpdateTaskTemplate (Maybe TaskTemplateConstraints) Source #

Constraints that are applicable to the fields listed.

updateTaskTemplate_contactFlowId :: Lens' UpdateTaskTemplate (Maybe Text) Source #

The identifier of the flow that runs by default when a task is created by referencing this template.

updateTaskTemplate_defaults :: Lens' UpdateTaskTemplate (Maybe TaskTemplateDefaults) Source #

The default values for fields when a task is created by referencing this template.

updateTaskTemplate_description :: Lens' UpdateTaskTemplate (Maybe Text) Source #

The description of the task template.

updateTaskTemplate_fields :: Lens' UpdateTaskTemplate (Maybe [TaskTemplateField]) Source #

Fields that are part of the template.

updateTaskTemplate_name :: Lens' UpdateTaskTemplate (Maybe Text) Source #

The name of the task template.

updateTaskTemplate_status :: Lens' UpdateTaskTemplate (Maybe TaskTemplateStatus) Source #

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.

updateTaskTemplate_taskTemplateId :: Lens' UpdateTaskTemplate Text Source #

A unique identifier for the task template.

updateTaskTemplate_instanceId :: Lens' UpdateTaskTemplate Text Source #

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

updateTaskTemplateResponse_arn :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the task template resource.

updateTaskTemplateResponse_constraints :: Lens' UpdateTaskTemplateResponse (Maybe TaskTemplateConstraints) Source #

Constraints that are applicable to the fields listed.

updateTaskTemplateResponse_contactFlowId :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

The identifier of the flow that runs by default when a task is created by referencing this template.

updateTaskTemplateResponse_createdTime :: Lens' UpdateTaskTemplateResponse (Maybe UTCTime) Source #

The timestamp when the task template was created.

updateTaskTemplateResponse_defaults :: Lens' UpdateTaskTemplateResponse (Maybe TaskTemplateDefaults) Source #

The default values for fields when a task is created by referencing this template.

updateTaskTemplateResponse_description :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

The description of the task template.

updateTaskTemplateResponse_fields :: Lens' UpdateTaskTemplateResponse (Maybe [TaskTemplateField]) Source #

Fields that are part of the template.

updateTaskTemplateResponse_id :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

The identifier of the task template resource.

updateTaskTemplateResponse_instanceId :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

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

updateTaskTemplateResponse_lastModifiedTime :: Lens' UpdateTaskTemplateResponse (Maybe UTCTime) Source #

The timestamp when the task template was last modified.

updateTaskTemplateResponse_name :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

The name of the task template.

updateTaskTemplateResponse_status :: Lens' UpdateTaskTemplateResponse (Maybe TaskTemplateStatus) Source #

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.

updateTaskTemplateResponse_httpStatus :: Lens' UpdateTaskTemplateResponse Int Source #

The response's http status code.

UpdateTrafficDistribution

updateTrafficDistribution_telephonyConfig :: Lens' UpdateTrafficDistribution (Maybe TelephonyConfig) Source #

The distribution of traffic between the instance and its replica(s).

updateTrafficDistribution_id :: Lens' UpdateTrafficDistribution Text Source #

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.

updateTrafficDistributionResponse_httpStatus :: Lens' UpdateTrafficDistributionResponse Int Source #

The response's http status code.

UpdateUserHierarchy

updateUserHierarchy_hierarchyGroupId :: Lens' UpdateUserHierarchy (Maybe Text) Source #

The identifier of the hierarchy group.

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.

UpdateUserHierarchyGroupName

updateUserHierarchyGroupName_name :: Lens' UpdateUserHierarchyGroupName Text Source #

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

updateUserHierarchyGroupName_hierarchyGroupId :: Lens' UpdateUserHierarchyGroupName Text Source #

The identifier of the hierarchy group.

updateUserHierarchyGroupName_instanceId :: Lens' UpdateUserHierarchyGroupName Text Source #

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

UpdateUserHierarchyStructure

updateUserHierarchyStructure_hierarchyStructure :: Lens' UpdateUserHierarchyStructure HierarchyStructureUpdate Source #

The hierarchy levels to update.

updateUserHierarchyStructure_instanceId :: Lens' UpdateUserHierarchyStructure Text Source #

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

UpdateUserIdentityInfo

updateUserIdentityInfo_identityInfo :: Lens' UpdateUserIdentityInfo UserIdentityInfo Source #

The identity information for the user.

updateUserIdentityInfo_userId :: Lens' UpdateUserIdentityInfo Text Source #

The identifier of the user account.

updateUserIdentityInfo_instanceId :: Lens' UpdateUserIdentityInfo 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_userId :: Lens' UpdateUserPhoneConfig Text Source #

The identifier of the user account.

updateUserPhoneConfig_instanceId :: Lens' UpdateUserPhoneConfig 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_userId :: Lens' UpdateUserRoutingProfile Text Source #

The identifier of the user account.

updateUserRoutingProfile_instanceId :: Lens' UpdateUserRoutingProfile Text Source #

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

UpdateUserSecurityProfiles

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

The identifiers of the security profiles for the user.

updateUserSecurityProfiles_userId :: Lens' UpdateUserSecurityProfiles Text Source #

The identifier of the user account.

updateUserSecurityProfiles_instanceId :: Lens' UpdateUserSecurityProfiles Text Source #

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

Types

ActionSummary

actionSummary_actionType :: Lens' ActionSummary ActionType Source #

The action type.

AgentContactReference

agentContactReference_agentContactState :: Lens' AgentContactReference (Maybe ContactState) Source #

The state of the contact.

agentContactReference_channel :: Lens' AgentContactReference (Maybe Channel) Source #

The channel of the contact.

agentContactReference_connectedToAgentTimestamp :: Lens' AgentContactReference (Maybe UTCTime) Source #

The time at which the contact was connected to an agent.

agentContactReference_contactId :: Lens' AgentContactReference (Maybe Text) Source #

The identifier of the contact in this instance of Amazon Connect.

agentContactReference_initiationMethod :: Lens' AgentContactReference (Maybe ContactInitiationMethod) Source #

How the contact was initiated.

agentContactReference_queue :: Lens' AgentContactReference (Maybe QueueReference) Source #

Undocumented member.

agentContactReference_stateStartTimestamp :: Lens' AgentContactReference (Maybe UTCTime) Source #

The epoch timestamp when the contact state started.

AgentInfo

agentInfo_connectedToAgentTimestamp :: Lens' AgentInfo (Maybe UTCTime) Source #

The timestamp when the contact was connected to the agent.

agentInfo_id :: Lens' AgentInfo (Maybe Text) Source #

The identifier of the agent who accepted the contact.

AgentStatus

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

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

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

The identifier of the agent status.

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

The description of the agent status.

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

The display order of the agent status.

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

The name of the agent status.

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

The state of the agent status.

agentStatus_tags :: Lens' AgentStatus (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

agentStatus_type :: Lens' AgentStatus (Maybe AgentStatusType) Source #

The type of agent status.

AgentStatusReference

agentStatusReference_statusArn :: Lens' AgentStatusReference (Maybe Text) Source #

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

agentStatusReference_statusName :: Lens' AgentStatusReference (Maybe Text) Source #

The name of the agent status.

agentStatusReference_statusStartTimestamp :: Lens' AgentStatusReference (Maybe UTCTime) Source #

The start timestamp of the agent's 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.

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

The name of the agent status.

agentStatusSummary_type :: Lens' AgentStatusSummary (Maybe AgentStatusType) Source #

The type of the agent status.

AnswerMachineDetectionConfig

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

Wait for the answering machine prompt.

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.

AssignContactCategoryActionDefinition

AttachmentReference

attachmentReference_name :: Lens' AttachmentReference (Maybe Text) Source #

Identifier of the attachment reference.

attachmentReference_status :: Lens' AttachmentReference (Maybe ReferenceStatus) Source #

Status of the attachment reference type.

attachmentReference_value :: Lens' AttachmentReference (Maybe Text) Source #

The location path of the attachment reference.

Attribute

attribute_attributeType :: Lens' Attribute (Maybe InstanceAttributeType) Source #

The type of attribute.

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

The value of the attribute.

AvailableNumberSummary

availableNumberSummary_phoneNumber :: Lens' AvailableNumberSummary (Maybe Text) Source #

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

availableNumberSummary_phoneNumberCountryCode :: Lens' AvailableNumberSummary (Maybe PhoneNumberCountryCode) Source #

The ISO country code.

availableNumberSummary_phoneNumberType :: Lens' AvailableNumberSummary (Maybe PhoneNumberType) Source #

The type of phone number.

ChatMessage

chatMessage_contentType :: Lens' ChatMessage Text Source #

The type of the content. Supported types are text/plain, text/markdown, and application/json.

chatMessage_content :: Lens' ChatMessage Text Source #

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.

ChatParticipantRoleConfig

chatParticipantRoleConfig_participantTimerConfigList :: Lens' ChatParticipantRoleConfig (NonEmpty ParticipantTimerConfiguration) Source #

A list of participant timers. You can specify any unique combination of role and timer type. Duplicate entries error out the request with a 400.

ChatStreamingConfiguration

chatStreamingConfiguration_streamingEndpointArn :: Lens' ChatStreamingConfiguration Text Source #

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.

ClaimedPhoneNumberSummary

claimedPhoneNumberSummary_phoneNumber :: Lens' ClaimedPhoneNumberSummary (Maybe Text) Source #

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

claimedPhoneNumberSummary_phoneNumberArn :: Lens' ClaimedPhoneNumberSummary (Maybe Text) Source #

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

claimedPhoneNumberSummary_phoneNumberCountryCode :: Lens' ClaimedPhoneNumberSummary (Maybe PhoneNumberCountryCode) Source #

The ISO country code.

claimedPhoneNumberSummary_phoneNumberDescription :: Lens' ClaimedPhoneNumberSummary (Maybe Text) Source #

The description of the phone number.

claimedPhoneNumberSummary_phoneNumberId :: Lens' ClaimedPhoneNumberSummary (Maybe Text) Source #

A unique identifier for the phone number.

claimedPhoneNumberSummary_phoneNumberStatus :: Lens' ClaimedPhoneNumberSummary (Maybe PhoneNumberStatus) Source #

The status of the phone number.

CLAIMED means the previous ClaimedPhoneNumber or UpdatePhoneNumber operation succeeded.
IN_PROGRESS means a ClaimedPhoneNumber or UpdatePhoneNumber 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 ClaimedPhoneNumber 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.

claimedPhoneNumberSummary_phoneNumberType :: Lens' ClaimedPhoneNumberSummary (Maybe PhoneNumberType) Source #

The type of phone number.

claimedPhoneNumberSummary_tags :: Lens' ClaimedPhoneNumberSummary (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

claimedPhoneNumberSummary_targetArn :: Lens' ClaimedPhoneNumberSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Contact

contact_agentInfo :: Lens' Contact (Maybe AgentInfo) Source #

Information about the agent who accepted the contact.

contact_arn :: Lens' Contact (Maybe Text) Source #

The Amazon Resource Name (ARN) for the contact.

contact_channel :: Lens' Contact (Maybe Channel) Source #

How the contact reached your contact center.

contact_description :: Lens' Contact (Maybe Text) Source #

The description of the contact.

contact_disconnectTimestamp :: Lens' Contact (Maybe UTCTime) Source #

The timestamp when the customer endpoint disconnected from Amazon Connect.

contact_id :: Lens' Contact (Maybe Text) Source #

The identifier for the contact.

contact_initialContactId :: Lens' Contact (Maybe Text) Source #

If this contact is related to other contacts, this is the ID of the initial contact.

contact_initiationMethod :: Lens' Contact (Maybe ContactInitiationMethod) Source #

Indicates how the contact was initiated.

contact_initiationTimestamp :: Lens' Contact (Maybe UTCTime) Source #

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.

contact_lastUpdateTimestamp :: Lens' Contact (Maybe UTCTime) Source #

The timestamp when contact was last updated.

contact_name :: Lens' Contact (Maybe Text) Source #

The name of the contact.

contact_previousContactId :: Lens' Contact (Maybe Text) Source #

If this contact is not the first contact, this is the ID of the previous contact.

contact_queueInfo :: Lens' Contact (Maybe QueueInfo) Source #

If this contact was queued, this contains information about the queue.

contact_scheduledTimestamp :: Lens' Contact (Maybe UTCTime) Source #

The timestamp, in Unix epoch time format, at which to start running the inbound flow.

ContactFilter

contactFilter_contactStates :: Lens' ContactFilter (Maybe [ContactState]) Source #

A list of up to 9 contact states.

ContactFlow

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

The Amazon Resource Name (ARN) of the flow.

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

The content of the flow.

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

The description of the flow.

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

The identifier of the flow.

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

The name of the flow.

contactFlow_state :: Lens' ContactFlow (Maybe ContactFlowState) Source #

The type of flow.

contactFlow_tags :: Lens' ContactFlow (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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

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

ContactFlowModule

contactFlowModule_arn :: Lens' ContactFlowModule (Maybe Text) Source #

The Amazon Resource Name (ARN).

contactFlowModule_content :: Lens' ContactFlowModule (Maybe Text) Source #

The content of the flow module.

contactFlowModule_description :: Lens' ContactFlowModule (Maybe Text) Source #

The description of the flow module.

contactFlowModule_id :: Lens' ContactFlowModule (Maybe Text) Source #

The identifier of the flow module.

contactFlowModule_name :: Lens' ContactFlowModule (Maybe Text) Source #

The name of the flow module.

contactFlowModule_state :: Lens' ContactFlowModule (Maybe ContactFlowModuleState) Source #

The type of flow module.

contactFlowModule_status :: Lens' ContactFlowModule (Maybe ContactFlowModuleStatus) Source #

The status of the flow module.

contactFlowModule_tags :: Lens' ContactFlowModule (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

ContactFlowModuleSummary

contactFlowModuleSummary_arn :: Lens' ContactFlowModuleSummary (Maybe Text) Source #

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

contactFlowModuleSummary_id :: Lens' ContactFlowModuleSummary (Maybe Text) Source #

The identifier of the flow module.

contactFlowModuleSummary_name :: Lens' ContactFlowModuleSummary (Maybe Text) Source #

The name of the flow module.

contactFlowModuleSummary_state :: Lens' ContactFlowModuleSummary (Maybe ContactFlowModuleState) Source #

The type of flow module.

ContactFlowSummary

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

The Amazon Resource Name (ARN) of the flow.

contactFlowSummary_contactFlowState :: Lens' ContactFlowSummary (Maybe ContactFlowState) Source #

The type of flow.

contactFlowSummary_contactFlowType :: Lens' ContactFlowSummary (Maybe ContactFlowType) Source #

The type of flow.

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

The identifier of the flow.

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

The name of the flow.

ControlPlaneTagFilter

controlPlaneTagFilter_andConditions :: Lens' ControlPlaneTagFilter (Maybe [TagCondition]) Source #

A list of conditions which would be applied together with an AND condition.

controlPlaneTagFilter_orConditions :: Lens' ControlPlaneTagFilter (Maybe [[TagCondition]]) Source #

A list of conditions which would be applied together with an OR condition.

controlPlaneTagFilter_tagCondition :: Lens' ControlPlaneTagFilter (Maybe TagCondition) Source #

A leaf node condition which can be used to specify a tag condition.

Credentials

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

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

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_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_name :: Lens' CurrentMetric (Maybe CurrentMetricName) Source #

The name of the metric.

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

The unit for the metric.

CurrentMetricData

currentMetricData_metric :: Lens' CurrentMetricData (Maybe CurrentMetric) Source #

Information about the metric.

currentMetricData_value :: Lens' CurrentMetricData (Maybe Double) Source #

The value of the metric.

CurrentMetricResult

currentMetricResult_collections :: Lens' CurrentMetricResult (Maybe [CurrentMetricData]) Source #

The set of metrics.

currentMetricResult_dimensions :: Lens' CurrentMetricResult (Maybe Dimensions) Source #

The dimensions for the metrics.

CurrentMetricSortCriteria

currentMetricSortCriteria_sortByMetric :: Lens' CurrentMetricSortCriteria (Maybe CurrentMetricName) Source #

Undocumented member.

currentMetricSortCriteria_sortOrder :: Lens' CurrentMetricSortCriteria (Maybe SortOrder) Source #

The way to sort.

DateReference

dateReference_name :: Lens' DateReference (Maybe Text) Source #

Identifier of the date reference.

dateReference_value :: Lens' DateReference (Maybe Text) Source #

A valid date.

DefaultVocabulary

defaultVocabulary_instanceId :: Lens' DefaultVocabulary Text Source #

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

defaultVocabulary_languageCode :: Lens' DefaultVocabulary VocabularyLanguageCode Source #

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

defaultVocabulary_vocabularyId :: Lens' DefaultVocabulary Text Source #

The identifier of the custom vocabulary.

defaultVocabulary_vocabularyName :: Lens' DefaultVocabulary Text Source #

A unique name of the custom vocabulary.

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.

dimensions_routingProfile :: Lens' Dimensions (Maybe RoutingProfileReference) Source #

Undocumented member.

Distribution

distribution_region :: Lens' Distribution Text Source #

The Amazon Web Services Region where the traffic is distributed.

distribution_percentage :: Lens' Distribution Natural Source #

The percentage of the traffic that is distributed, in increments of 10.

EmailReference

emailReference_name :: Lens' EmailReference (Maybe Text) Source #

Identifier of the email reference.

emailReference_value :: Lens' EmailReference (Maybe Text) Source #

A valid email address.

EncryptionConfig

encryptionConfig_encryptionType :: Lens' EncryptionConfig EncryptionType Source #

The type of encryption.

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.

EventBridgeActionDefinition

eventBridgeActionDefinition_name :: Lens' EventBridgeActionDefinition Text Source #

The name.

Filters

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

The channel to use to filter the metrics.

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

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.

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

A list of up to 100 routing profile IDs or ARNs.

HierarchyGroup

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

The Amazon Resource Name (ARN) 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.

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

The name of the hierarchy group.

hierarchyGroup_tags :: Lens' HierarchyGroup (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

HierarchyGroupCondition

hierarchyGroupCondition_hierarchyGroupMatchType :: Lens' HierarchyGroupCondition (Maybe HierarchyGroupMatchType) Source #

The type of hierarchy group match.

hierarchyGroupCondition_value :: Lens' HierarchyGroupCondition (Maybe Text) Source #

The value in the hierarchy group condition.

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.

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

The name of the hierarchy group.

HierarchyGroupSummaryReference

hierarchyGroupSummaryReference_arn :: Lens' HierarchyGroupSummaryReference (Maybe Text) Source #

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

hierarchyGroupSummaryReference_id :: Lens' HierarchyGroupSummaryReference (Maybe Text) Source #

The unique identifier for the hierarchy group.

HierarchyLevel

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

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

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

The identifier of the hierarchy level.

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

The name 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

hierarchyPath_levelFive :: Lens' HierarchyPath (Maybe HierarchyGroupSummary) Source #

Information about level five.

hierarchyPath_levelFour :: Lens' HierarchyPath (Maybe HierarchyGroupSummary) Source #

Information about level four.

hierarchyPath_levelOne :: Lens' HierarchyPath (Maybe HierarchyGroupSummary) Source #

Information about level one.

hierarchyPath_levelThree :: Lens' HierarchyPath (Maybe HierarchyGroupSummary) Source #

Information about level three.

hierarchyPath_levelTwo :: Lens' HierarchyPath (Maybe HierarchyGroupSummary) Source #

Information about level two.

HierarchyPathReference

hierarchyPathReference_levelFive :: Lens' HierarchyPathReference (Maybe HierarchyGroupSummaryReference) Source #

Information about level five.

hierarchyPathReference_levelFour :: Lens' HierarchyPathReference (Maybe HierarchyGroupSummaryReference) Source #

Information about level four.

hierarchyPathReference_levelOne :: Lens' HierarchyPathReference (Maybe HierarchyGroupSummaryReference) Source #

Information about level one.

hierarchyPathReference_levelThree :: Lens' HierarchyPathReference (Maybe HierarchyGroupSummaryReference) Source #

Information about level three.

hierarchyPathReference_levelTwo :: Lens' HierarchyPathReference (Maybe HierarchyGroupSummaryReference) Source #

Information about level two.

HierarchyStructure

hierarchyStructure_levelFive :: Lens' HierarchyStructure (Maybe HierarchyLevel) Source #

Information about level five.

hierarchyStructure_levelFour :: Lens' HierarchyStructure (Maybe HierarchyLevel) Source #

Information about level four.

hierarchyStructure_levelOne :: Lens' HierarchyStructure (Maybe HierarchyLevel) Source #

Information about level one.

hierarchyStructure_levelThree :: Lens' HierarchyStructure (Maybe HierarchyLevel) Source #

Information about level three.

hierarchyStructure_levelTwo :: Lens' HierarchyStructure (Maybe HierarchyLevel) Source #

Information about level two.

HierarchyStructureUpdate

hierarchyStructureUpdate_levelFive :: Lens' HierarchyStructureUpdate (Maybe HierarchyLevelUpdate) Source #

The update for level five.

hierarchyStructureUpdate_levelFour :: Lens' HierarchyStructureUpdate (Maybe HierarchyLevelUpdate) Source #

The update for level four.

hierarchyStructureUpdate_levelOne :: Lens' HierarchyStructureUpdate (Maybe HierarchyLevelUpdate) Source #

The update for level one.

hierarchyStructureUpdate_levelThree :: Lens' HierarchyStructureUpdate (Maybe HierarchyLevelUpdate) Source #

The update for level three.

hierarchyStructureUpdate_levelTwo :: Lens' HierarchyStructureUpdate (Maybe HierarchyLevelUpdate) Source #

The update for level two.

HistoricalMetric

historicalMetric_name :: Lens' HistoricalMetric (Maybe HistoricalMetricName) Source #

The name of the metric.

historicalMetric_statistic :: Lens' HistoricalMetric (Maybe Statistic) Source #

The statistic for the metric.

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

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

historicalMetric_unit :: Lens' HistoricalMetric (Maybe Unit) Source #

The unit for the metric.

HistoricalMetricData

historicalMetricData_metric :: Lens' HistoricalMetricData (Maybe HistoricalMetric) Source #

Information about the metric.

historicalMetricData_value :: Lens' HistoricalMetricData (Maybe Double) Source #

The value of the metric.

HistoricalMetricResult

historicalMetricResult_collections :: Lens' HistoricalMetricResult (Maybe [HistoricalMetricData]) Source #

The set of metrics.

historicalMetricResult_dimensions :: Lens' HistoricalMetricResult (Maybe Dimensions) Source #

The dimension for the metrics.

HoursOfOperation

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

Configuration information for the hours of operation.

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

The description 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_name :: Lens' HoursOfOperation (Maybe Text) Source #

The name for the hours of operation.

hoursOfOperation_tags :: Lens' HoursOfOperation (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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

The time zone for the hours of operation.

HoursOfOperationConfig

hoursOfOperationConfig_day :: Lens' HoursOfOperationConfig HoursOfOperationDays Source #

The day that the hours of operation applies to.

hoursOfOperationConfig_startTime :: Lens' HoursOfOperationConfig HoursOfOperationTimeSlice Source #

The start time that your contact center opens.

hoursOfOperationConfig_endTime :: Lens' HoursOfOperationConfig HoursOfOperationTimeSlice Source #

The end time that your contact center closes.

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.

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

The name of the hours of operation.

HoursOfOperationTimeSlice

hoursOfOperationTimeSlice_hours :: Lens' HoursOfOperationTimeSlice Natural Source #

The hours.

hoursOfOperationTimeSlice_minutes :: Lens' HoursOfOperationTimeSlice Natural Source #

The minutes.

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_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_identityManagementType :: Lens' Instance (Maybe DirectoryType) Source #

The identity management type.

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

Whether inbound calls are enabled.

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

The alias of instance.

instance_instanceStatus :: Lens' Instance (Maybe InstanceStatus) Source #

The state of the instance.

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

Whether outbound calls are enabled.

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

The service role of the instance.

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

Relevant details why the instance was not successfully created.

InstanceStatusReason

instanceStatusReason_message :: Lens' InstanceStatusReason (Maybe Text) Source #

The message.

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.

instanceStorageConfig_kinesisStreamConfig :: Lens' InstanceStorageConfig (Maybe KinesisStreamConfig) Source #

The configuration of the Kinesis data stream.

instanceStorageConfig_kinesisVideoStreamConfig :: Lens' InstanceStorageConfig (Maybe KinesisVideoStreamConfig) Source #

The configuration of the Kinesis video stream.

instanceStorageConfig_s3Config :: Lens' InstanceStorageConfig (Maybe S3Config) Source #

The S3 bucket configuration.

instanceStorageConfig_storageType :: Lens' InstanceStorageConfig StorageType Source #

A valid storage type.

InstanceSummary

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

The Amazon Resource Name (ARN) of the instance.

instanceSummary_createdTime :: Lens' InstanceSummary (Maybe UTCTime) Source #

When the instance was created.

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_inboundCallsEnabled :: Lens' InstanceSummary (Maybe Bool) Source #

Whether inbound calls are enabled.

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

The alias of the instance.

instanceSummary_instanceStatus :: Lens' InstanceSummary (Maybe InstanceStatus) Source #

The state of the instance.

instanceSummary_outboundCallsEnabled :: Lens' InstanceSummary (Maybe Bool) Source #

Whether outbound calls are enabled.

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_integrationArn :: Lens' IntegrationAssociationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) for the AppIntegration.

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

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

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

The identifier for the AppIntegration association.

integrationAssociationSummary_integrationType :: Lens' IntegrationAssociationSummary (Maybe IntegrationType) Source #

The integration type.

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

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

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

The URL for the external application.

integrationAssociationSummary_sourceType :: Lens' IntegrationAssociationSummary (Maybe SourceType) Source #

The name of the source.

InvisibleFieldInfo

invisibleFieldInfo_id :: Lens' InvisibleFieldInfo (Maybe TaskTemplateFieldIdentifier) Source #

Identifier of the invisible field.

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_prefix :: Lens' KinesisVideoStreamConfig Text Source #

The prefix of the video stream.

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.

kinesisVideoStreamConfig_encryptionConfig :: Lens' KinesisVideoStreamConfig EncryptionConfig Source #

The encryption configuration.

LexBot

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

The Amazon Web Services Region where the Amazon Lex bot was created.

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

The name of the Amazon Lex bot.

LexBotConfig

lexBotConfig_lexBot :: Lens' LexBotConfig (Maybe LexBot) Source #

Undocumented member.

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.

ListPhoneNumbersSummary

listPhoneNumbersSummary_phoneNumber :: Lens' ListPhoneNumbersSummary (Maybe Text) Source #

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

listPhoneNumbersSummary_phoneNumberArn :: Lens' ListPhoneNumbersSummary (Maybe Text) Source #

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

listPhoneNumbersSummary_phoneNumberCountryCode :: Lens' ListPhoneNumbersSummary (Maybe PhoneNumberCountryCode) Source #

The ISO country code.

listPhoneNumbersSummary_phoneNumberId :: Lens' ListPhoneNumbersSummary (Maybe Text) Source #

A unique identifier for the phone number.

listPhoneNumbersSummary_phoneNumberType :: Lens' ListPhoneNumbersSummary (Maybe PhoneNumberType) Source #

The type of phone number.

listPhoneNumbersSummary_targetArn :: Lens' ListPhoneNumbersSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

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.

NotificationRecipientType

notificationRecipientType_userIds :: Lens' NotificationRecipientType (Maybe [Text]) Source #

A list of user IDs.

notificationRecipientType_userTags :: Lens' NotificationRecipientType (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.

NumberReference

numberReference_name :: Lens' NumberReference (Maybe Text) Source #

Identifier of the number reference.

numberReference_value :: Lens' NumberReference (Maybe Text) Source #

A valid number.

OutboundCallerConfig

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

The caller ID name.

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

The caller ID number.

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

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

ParticipantDetails

participantDetails_displayName :: Lens' ParticipantDetails Text Source #

Display name of the participant.

ParticipantTimerConfiguration

participantTimerConfiguration_participantRole :: Lens' ParticipantTimerConfiguration TimerEligibleParticipantRoles Source #

The role of the participant in the chat conversation.

participantTimerConfiguration_timerType :: Lens' ParticipantTimerConfiguration ParticipantTimerType Source #

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.

participantTimerConfiguration_timerValue :: Lens' ParticipantTimerConfiguration ParticipantTimerValue Source #

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.

ParticipantTimerValue

participantTimerValue_participantTimerAction :: Lens' ParticipantTimerValue (Maybe ParticipantTimerAction) Source #

The timer action. Currently only one value is allowed: Unset. It deletes a timer.

participantTimerValue_participantTimerDurationInMinutes :: Lens' ParticipantTimerValue (Maybe Natural) Source #

The duration of a timer, in minutes.

PhoneNumberQuickConnectConfig

phoneNumberQuickConnectConfig_phoneNumber :: Lens' PhoneNumberQuickConnectConfig Text Source #

The phone number in E.164 format.

PhoneNumberStatus

phoneNumberStatus_message :: Lens' PhoneNumberStatus (Maybe Text) Source #

The status message.

phoneNumberStatus_status :: Lens' PhoneNumberStatus (Maybe PhoneNumberWorkflowStatus) Source #

The status.

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.

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

The phone number.

phoneNumberSummary_phoneNumberCountryCode :: Lens' PhoneNumberSummary (Maybe PhoneNumberCountryCode) Source #

The ISO country code.

phoneNumberSummary_phoneNumberType :: Lens' PhoneNumberSummary (Maybe PhoneNumberType) Source #

The type of 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.

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

The name of the prompt.

Queue

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

The description of the queue.

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

The identifier for the hours of operation.

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_outboundCallerConfig :: Lens' Queue (Maybe OutboundCallerConfig) Source #

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

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_status :: Lens' Queue (Maybe QueueStatus) Source #

The status of the queue.

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

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

QueueInfo

queueInfo_enqueueTimestamp :: Lens' QueueInfo (Maybe UTCTime) Source #

The timestamp when the contact was added to the queue.

queueInfo_id :: Lens' QueueInfo (Maybe Text) Source #

The unique identifier for the queue.

QueueQuickConnectConfig

queueQuickConnectConfig_queueId :: Lens' QueueQuickConnectConfig Text Source #

The identifier for the queue.

queueQuickConnectConfig_contactFlowId :: Lens' QueueQuickConnectConfig Text Source #

The identifier of the flow.

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.

QueueSearchCriteria

queueSearchCriteria_andConditions :: Lens' QueueSearchCriteria (Maybe [QueueSearchCriteria]) Source #

A list of conditions which would be applied together with an AND condition.

queueSearchCriteria_orConditions :: Lens' QueueSearchCriteria (Maybe [QueueSearchCriteria]) Source #

A list of conditions which would be applied together with an OR condition.

queueSearchCriteria_queueTypeCondition :: Lens' QueueSearchCriteria (Maybe SearchableQueueType) Source #

The type of queue.

queueSearchCriteria_stringCondition :: Lens' QueueSearchCriteria (Maybe StringCondition) Source #

Undocumented member.

QueueSearchFilter

queueSearchFilter_tagFilter :: Lens' QueueSearchFilter (Maybe ControlPlaneTagFilter) Source #

Undocumented member.

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.

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

The name of the queue.

queueSummary_queueType :: Lens' QueueSummary (Maybe QueueType) Source #

The type of queue.

QuickConnect

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

The description.

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

The name of 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.

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

The identifier for the quick connect.

quickConnect_tags :: Lens' QuickConnect (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

QuickConnectConfig

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

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

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_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_id :: Lens' QuickConnectSummary (Maybe Text) Source #

The identifier for the quick connect.

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

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

ReadOnlyFieldInfo

readOnlyFieldInfo_id :: Lens' ReadOnlyFieldInfo (Maybe TaskTemplateFieldIdentifier) Source #

Identifier of the read-only field.

Reference

reference_value :: Lens' Reference Text Source #

A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

reference_type :: Lens' Reference ReferenceType Source #

The type of the reference. DATE must be of type Epoch timestamp.

ReferenceSummary

referenceSummary_attachment :: Lens' ReferenceSummary (Maybe AttachmentReference) Source #

Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.

referenceSummary_date :: Lens' ReferenceSummary (Maybe DateReference) Source #

Information about a reference when the referenceType is DATE. Otherwise, null.

referenceSummary_email :: Lens' ReferenceSummary (Maybe EmailReference) Source #

Information about a reference when the referenceType is EMAIL. Otherwise, null.

referenceSummary_number :: Lens' ReferenceSummary (Maybe NumberReference) Source #

Information about a reference when the referenceType is NUMBER. Otherwise, null.

referenceSummary_string :: Lens' ReferenceSummary (Maybe StringReference) Source #

Information about a reference when the referenceType is STRING. Otherwise, null.

referenceSummary_url :: Lens' ReferenceSummary (Maybe UrlReference) Source #

Information about the reference when the referenceType is URL. Otherwise, null.

RequiredFieldInfo

requiredFieldInfo_id :: Lens' RequiredFieldInfo (Maybe TaskTemplateFieldIdentifier) Source #

The unique identifier for the field.

RoutingProfile

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

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

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

The description of the routing profile.

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_mediaConcurrencies :: Lens' RoutingProfile (Maybe [MediaConcurrency]) Source #

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

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

The name of the routing profile.

routingProfile_numberOfAssociatedQueues :: Lens' RoutingProfile (Maybe Integer) Source #

The number of associated queues in routing profile.

routingProfile_numberOfAssociatedUsers :: Lens' RoutingProfile (Maybe Integer) Source #

The number of associated users in routing profile.

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_tags :: Lens' RoutingProfile (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

RoutingProfileQueueConfig

routingProfileQueueConfig_queueReference :: Lens' RoutingProfileQueueConfig RoutingProfileQueueReference Source #

Contains information about a queue resource.

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_queueId :: Lens' RoutingProfileQueueConfigSummary Text Source #

The identifier for the queue.

routingProfileQueueConfigSummary_queueArn :: Lens' RoutingProfileQueueConfigSummary Text Source #

The Amazon Resource Name (ARN) of the queue.

routingProfileQueueConfigSummary_queueName :: Lens' RoutingProfileQueueConfigSummary Text Source #

The name of the queue.

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.

routingProfileQueueConfigSummary_channel :: Lens' RoutingProfileQueueConfigSummary Channel Source #

The channels this queue supports.

RoutingProfileQueueReference

routingProfileQueueReference_queueId :: Lens' RoutingProfileQueueReference Text Source #

The identifier for the queue.

routingProfileQueueReference_channel :: Lens' RoutingProfileQueueReference Channel Source #

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

RoutingProfileReference

routingProfileReference_arn :: Lens' RoutingProfileReference (Maybe Text) Source #

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

routingProfileReference_id :: Lens' RoutingProfileReference (Maybe Text) Source #

The identifier of the routing profile.

RoutingProfileSearchCriteria

routingProfileSearchCriteria_andConditions :: Lens' RoutingProfileSearchCriteria (Maybe [RoutingProfileSearchCriteria]) Source #

A list of conditions which would be applied together with an AND condition.

routingProfileSearchCriteria_orConditions :: Lens' RoutingProfileSearchCriteria (Maybe [RoutingProfileSearchCriteria]) Source #

A list of conditions which would be applied together with an OR condition.

routingProfileSearchCriteria_stringCondition :: Lens' RoutingProfileSearchCriteria (Maybe StringCondition) Source #

Undocumented member.

RoutingProfileSearchFilter

routingProfileSearchFilter_tagFilter :: Lens' RoutingProfileSearchFilter (Maybe ControlPlaneTagFilter) Source #

Undocumented member.

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.

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

The name of the routing profile.

Rule

rule_tags :: Lens' Rule (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

rule_name :: Lens' Rule Text Source #

The name of the rule.

rule_ruleId :: Lens' Rule Text Source #

A unique identifier for the rule.

rule_ruleArn :: Lens' Rule Text Source #

The Amazon Resource Name (ARN) of the rule.

rule_triggerEventSource :: Lens' Rule RuleTriggerEventSource Source #

The event source to trigger the rule.

rule_function :: Lens' Rule Text Source #

The conditions of the rule.

rule_actions :: Lens' Rule [RuleAction] Source #

A list of actions to be run when the rule is triggered.

rule_publishStatus :: Lens' Rule RulePublishStatus Source #

The publish status of the rule.

rule_createdTime :: Lens' Rule UTCTime Source #

The timestamp for when the rule was created.

rule_lastUpdatedTime :: Lens' Rule UTCTime Source #

The timestamp for the when the rule was last updated.

rule_lastUpdatedBy :: Lens' Rule Text Source #

The Amazon Resource Name (ARN) of the user who last updated the rule.

RuleAction

ruleAction_assignContactCategoryAction :: Lens' RuleAction (Maybe AssignContactCategoryActionDefinition) Source #

Information about the contact category action.

ruleAction_eventBridgeAction :: Lens' RuleAction (Maybe EventBridgeActionDefinition) Source #

Information about the EventBridge action.

ruleAction_sendNotificationAction :: Lens' RuleAction (Maybe SendNotificationActionDefinition) Source #

Information about the send notification action.

ruleAction_taskAction :: Lens' RuleAction (Maybe TaskActionDefinition) Source #

Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

ruleAction_actionType :: Lens' RuleAction ActionType Source #

The type of action that creates a rule.

RuleSummary

ruleSummary_name :: Lens' RuleSummary Text Source #

The name of the rule.

ruleSummary_ruleId :: Lens' RuleSummary Text Source #

A unique identifier for the rule.

ruleSummary_ruleArn :: Lens' RuleSummary Text Source #

The Amazon Resource Name (ARN) of the rule.

ruleSummary_eventSourceName :: Lens' RuleSummary EventSourceName Source #

The name of the event source.

ruleSummary_publishStatus :: Lens' RuleSummary RulePublishStatus Source #

The publish status of the rule.

ruleSummary_actionSummaries :: Lens' RuleSummary [ActionSummary] Source #

A list of ActionTypes associated with a rule.

ruleSummary_createdTime :: Lens' RuleSummary UTCTime Source #

The timestamp for when the rule was created.

ruleSummary_lastUpdatedTime :: Lens' RuleSummary UTCTime Source #

The timestamp for when the rule was last updated.

RuleTriggerEventSource

ruleTriggerEventSource_integrationAssociationId :: Lens' RuleTriggerEventSource (Maybe Text) Source #

The identifier for the integration association.

ruleTriggerEventSource_eventSourceName :: Lens' RuleTriggerEventSource EventSourceName Source #

The name of the event source.

S3Config

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

The Amazon S3 encryption configuration.

s3Config_bucketName :: Lens' S3Config Text Source #

The S3 bucket name.

s3Config_bucketPrefix :: Lens' S3Config Text Source #

The S3 bucket prefix.

SecurityKey

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_creationTime :: Lens' SecurityKey (Maybe UTCTime) Source #

When the security key was created.

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

The key of the security key.

SecurityProfile

securityProfile_allowedAccessControlTags :: Lens' SecurityProfile (Maybe (HashMap Text Text)) Source #

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

securityProfile_arn :: Lens' SecurityProfile (Maybe Text) Source #

The Amazon Resource Name (ARN) for the secruity profile.

securityProfile_description :: Lens' SecurityProfile (Maybe Text) Source #

The description of the security profile.

securityProfile_id :: Lens' SecurityProfile (Maybe Text) Source #

The identifier for the security profile.

securityProfile_organizationResourceId :: Lens' SecurityProfile (Maybe Text) Source #

The organization resource identifier for the security profile.

securityProfile_securityProfileName :: Lens' SecurityProfile (Maybe Text) Source #

The name for the security profile.

securityProfile_tagRestrictedResources :: Lens' SecurityProfile (Maybe [Text]) Source #

The list of resources that a security profile applies tag restrictions to in Amazon Connect.

securityProfile_tags :: Lens' SecurityProfile (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

SecurityProfileSearchCriteria

securityProfileSearchCriteria_andConditions :: Lens' SecurityProfileSearchCriteria (Maybe [SecurityProfileSearchCriteria]) Source #

A list of conditions which would be applied together with an AND condition.

securityProfileSearchCriteria_orConditions :: Lens' SecurityProfileSearchCriteria (Maybe [SecurityProfileSearchCriteria]) Source #

A list of conditions which would be applied together with an OR condition.

securityProfileSearchCriteria_stringCondition :: Lens' SecurityProfileSearchCriteria (Maybe StringCondition) Source #

Undocumented member.

SecurityProfileSearchSummary

securityProfileSearchSummary_arn :: Lens' SecurityProfileSearchSummary (Maybe Text) Source #

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

securityProfileSearchSummary_description :: Lens' SecurityProfileSearchSummary (Maybe Text) Source #

The description of the security profile.

securityProfileSearchSummary_id :: Lens' SecurityProfileSearchSummary (Maybe Text) Source #

The identifier of the security profile.

securityProfileSearchSummary_organizationResourceId :: Lens' SecurityProfileSearchSummary (Maybe Text) Source #

The organization resource identifier.

securityProfileSearchSummary_securityProfileName :: Lens' SecurityProfileSearchSummary (Maybe Text) Source #

The name of the security profile.

securityProfileSearchSummary_tags :: Lens' SecurityProfileSearchSummary (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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.

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

The name of the security profile.

SecurityProfilesSearchFilter

securityProfilesSearchFilter_tagFilter :: Lens' SecurityProfilesSearchFilter (Maybe ControlPlaneTagFilter) Source #

Undocumented member.

SendNotificationActionDefinition

sendNotificationActionDefinition_subject :: Lens' SendNotificationActionDefinition (Maybe Text) Source #

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.

sendNotificationActionDefinition_deliveryMethod :: Lens' SendNotificationActionDefinition NotificationDeliveryType Source #

Notification delivery method.

sendNotificationActionDefinition_content :: Lens' SendNotificationActionDefinition Text Source #

Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

sendNotificationActionDefinition_contentType :: Lens' SendNotificationActionDefinition NotificationContentType Source #

Content type format.

sendNotificationActionDefinition_recipient :: Lens' SendNotificationActionDefinition NotificationRecipientType Source #

Notification recipient.

StringCondition

stringCondition_comparisonType :: Lens' StringCondition (Maybe StringComparisonType) Source #

The type of comparison to be made when evaluating the string condition.

stringCondition_fieldName :: Lens' StringCondition (Maybe Text) Source #

The name of the field in the string condition.

stringCondition_value :: Lens' StringCondition (Maybe Text) Source #

The value of the string.

StringReference

stringReference_name :: Lens' StringReference (Maybe Text) Source #

Identifier of the string reference.

stringReference_value :: Lens' StringReference (Maybe Text) Source #

A valid string.

TagCondition

tagCondition_tagKey :: Lens' TagCondition (Maybe Text) Source #

The tag key in the tag condition.

tagCondition_tagValue :: Lens' TagCondition (Maybe Text) Source #

The tag value in the tag condition.

TaskActionDefinition

taskActionDefinition_description :: Lens' TaskActionDefinition (Maybe Text) Source #

The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

taskActionDefinition_references :: Lens' TaskActionDefinition (Maybe (HashMap Text Reference)) Source #

Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)

taskActionDefinition_name :: Lens' TaskActionDefinition Text Source #

The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

taskActionDefinition_contactFlowId :: Lens' TaskActionDefinition Text Source #

The identifier of the flow.

TaskTemplateConstraints

taskTemplateConstraints_invisibleFields :: Lens' TaskTemplateConstraints (Maybe [InvisibleFieldInfo]) Source #

Lists the fields that are invisible to agents.

taskTemplateConstraints_readOnlyFields :: Lens' TaskTemplateConstraints (Maybe [ReadOnlyFieldInfo]) Source #

Lists the fields that are read-only to agents, and cannot be edited.

taskTemplateConstraints_requiredFields :: Lens' TaskTemplateConstraints (Maybe [RequiredFieldInfo]) Source #

Lists the fields that are required to be filled by agents.

TaskTemplateDefaultFieldValue

taskTemplateDefaultFieldValue_defaultValue :: Lens' TaskTemplateDefaultFieldValue (Maybe Text) Source #

Default value for the field.

taskTemplateDefaultFieldValue_id :: Lens' TaskTemplateDefaultFieldValue (Maybe TaskTemplateFieldIdentifier) Source #

Identifier of a field.

TaskTemplateDefaults

taskTemplateDefaults_defaultFieldValues :: Lens' TaskTemplateDefaults (Maybe [TaskTemplateDefaultFieldValue]) Source #

Default value for the field.

TaskTemplateField

taskTemplateField_description :: Lens' TaskTemplateField (Maybe Text) Source #

The description of the field.

taskTemplateField_singleSelectOptions :: Lens' TaskTemplateField (Maybe [Text]) Source #

A list of options for a single select field.

taskTemplateField_type :: Lens' TaskTemplateField (Maybe TaskTemplateFieldType) Source #

Indicates the type of field.

taskTemplateField_id :: Lens' TaskTemplateField TaskTemplateFieldIdentifier Source #

The unique identifier for the field.

TaskTemplateFieldIdentifier

taskTemplateFieldIdentifier_name :: Lens' TaskTemplateFieldIdentifier (Maybe Text) Source #

The name of the task template field.

TaskTemplateMetadata

taskTemplateMetadata_arn :: Lens' TaskTemplateMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task template.

taskTemplateMetadata_createdTime :: Lens' TaskTemplateMetadata (Maybe UTCTime) Source #

The timestamp when the task template was created.

taskTemplateMetadata_description :: Lens' TaskTemplateMetadata (Maybe Text) Source #

The description of the task template.

taskTemplateMetadata_id :: Lens' TaskTemplateMetadata (Maybe Text) Source #

A unique identifier for the task template.

taskTemplateMetadata_lastModifiedTime :: Lens' TaskTemplateMetadata (Maybe UTCTime) Source #

The timestamp when the task template was last modified.

taskTemplateMetadata_name :: Lens' TaskTemplateMetadata (Maybe Text) Source #

The name of the task template.

taskTemplateMetadata_status :: Lens' TaskTemplateMetadata (Maybe TaskTemplateStatus) Source #

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.

TelephonyConfig

telephonyConfig_distributions :: Lens' TelephonyConfig [Distribution] Source #

Information about traffic distributions.

Threshold

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

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

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

The threshold value to compare.

TrafficDistributionGroup

trafficDistributionGroup_arn :: Lens' TrafficDistributionGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the traffic distribution group.

trafficDistributionGroup_description :: Lens' TrafficDistributionGroup (Maybe Text) Source #

The description of the traffic distribution group.

trafficDistributionGroup_id :: Lens' TrafficDistributionGroup (Maybe Text) Source #

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_instanceArn :: Lens' TrafficDistributionGroup (Maybe Text) Source #

The Amazon Resource Name (ARN).

trafficDistributionGroup_name :: Lens' TrafficDistributionGroup (Maybe Text) Source #

The name of the traffic distribution group.

trafficDistributionGroup_status :: Lens' TrafficDistributionGroup (Maybe TrafficDistributionGroupStatus) Source #

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.

trafficDistributionGroup_tags :: Lens' TrafficDistributionGroup (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

TrafficDistributionGroupSummary

trafficDistributionGroupSummary_arn :: Lens' TrafficDistributionGroupSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the traffic distribution group.

trafficDistributionGroupSummary_id :: Lens' TrafficDistributionGroupSummary (Maybe Text) Source #

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.

trafficDistributionGroupSummary_instanceArn :: Lens' TrafficDistributionGroupSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the traffic distribution group.

trafficDistributionGroupSummary_name :: Lens' TrafficDistributionGroupSummary (Maybe Text) Source #

The name of the traffic distribution group.

trafficDistributionGroupSummary_status :: Lens' TrafficDistributionGroupSummary (Maybe TrafficDistributionGroupStatus) Source #

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.

UpdateParticipantRoleConfigChannelInfo

updateParticipantRoleConfigChannelInfo_chat :: Lens' UpdateParticipantRoleConfigChannelInfo (Maybe ChatParticipantRoleConfig) Source #

Configuration information for the chat participant role.

UrlReference

urlReference_name :: Lens' UrlReference (Maybe Text) Source #

Identifier of the URL reference.

urlReference_value :: Lens' UrlReference (Maybe Text) Source #

A valid URL.

UseCase

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.

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.

User

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

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

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

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

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

The identifier of the hierarchy group for the user.

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

The identifier of the user account.

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

Information about the user identity.

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

Information about the phone configuration for the user.

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

The identifier of the routing profile for the user.

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

The identifiers of the security profiles for the user.

user_tags :: Lens' User (Maybe (HashMap Text Text)) Source #

The tags.

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

The user name assigned to the user account.

UserData

userData_activeSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural)) Source #

A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.

userData_availableSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural)) Source #

A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.

userData_contacts :: Lens' UserData (Maybe [AgentContactReference]) Source #

A list of contact reference information.

userData_hierarchyPath :: Lens' UserData (Maybe HierarchyPathReference) Source #

Contains information about the levels of a hierarchy group assigned to a user.

userData_maxSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural)) Source #

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.

userData_nextStatus :: Lens' UserData (Maybe Text) Source #

The Next status of the agent.

userData_routingProfile :: Lens' UserData (Maybe RoutingProfileReference) Source #

Information about the routing profile that is assigned to the user.

userData_status :: Lens' UserData (Maybe AgentStatusReference) Source #

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.

userData_user :: Lens' UserData (Maybe UserReference) Source #

Information about the user for the data that is returned. It contains the resourceId and ARN of the user.

UserDataFilters

userDataFilters_agents :: Lens' UserDataFilters (Maybe (NonEmpty Text)) Source #

A list of up to 100 agent IDs or ARNs.

userDataFilters_contactFilter :: Lens' UserDataFilters (Maybe ContactFilter) Source #

A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states.

userDataFilters_queues :: Lens' UserDataFilters (Maybe (NonEmpty Text)) Source #

A list of up to 100 queues or ARNs.

userDataFilters_routingProfiles :: Lens' UserDataFilters (Maybe (NonEmpty Text)) Source #

A list of up to 100 routing profile IDs or ARNs.

userDataFilters_userHierarchyGroups :: Lens' UserDataFilters (Maybe (NonEmpty Text)) Source #

A UserHierarchyGroup ID or ARN.

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_firstName :: Lens' UserIdentityInfo (Maybe Text) Source #

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

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_mobile :: Lens' UserIdentityInfo (Maybe Text) Source #

The user's mobile number.

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

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}

UserIdentityInfoLite

userIdentityInfoLite_firstName :: Lens' UserIdentityInfoLite (Maybe Text) Source #

The user's first name.

userIdentityInfoLite_lastName :: Lens' UserIdentityInfoLite (Maybe Text) Source #

The user's last name.

UserPhoneConfig

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

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

When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

userPhoneConfig_autoAccept :: Lens' UserPhoneConfig (Maybe Bool) Source #

The Auto accept setting.

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

The phone number for the user's desk phone.

userPhoneConfig_phoneType :: Lens' UserPhoneConfig PhoneType Source #

The phone type.

UserQuickConnectConfig

userQuickConnectConfig_userId :: Lens' UserQuickConnectConfig Text Source #

The identifier of the user.

userQuickConnectConfig_contactFlowId :: Lens' UserQuickConnectConfig Text Source #

The identifier of the flow.

UserReference

userReference_arn :: Lens' UserReference (Maybe Text) Source #

The Amazon Resource Name (ARN) for the user.

userReference_id :: Lens' UserReference (Maybe Text) Source #

The unique identifier for the user.

UserSearchCriteria

userSearchCriteria_andConditions :: Lens' UserSearchCriteria (Maybe [UserSearchCriteria]) Source #

A list of conditions which would be applied together with an AND condition.

userSearchCriteria_hierarchyGroupCondition :: Lens' UserSearchCriteria (Maybe HierarchyGroupCondition) Source #

A leaf node condition which can be used to specify a hierarchy group condition.

userSearchCriteria_orConditions :: Lens' UserSearchCriteria (Maybe [UserSearchCriteria]) Source #

A list of conditions which would be applied together with an OR condition.

userSearchCriteria_stringCondition :: Lens' UserSearchCriteria (Maybe StringCondition) Source #

A leaf node condition which can be used to specify a string condition.

UserSearchFilter

userSearchFilter_tagFilter :: Lens' UserSearchFilter (Maybe ControlPlaneTagFilter) Source #

Undocumented member.

UserSearchSummary

userSearchSummary_arn :: Lens' UserSearchSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user.

userSearchSummary_directoryUserId :: Lens' UserSearchSummary (Maybe Text) Source #

The directory identifier of the user.

userSearchSummary_hierarchyGroupId :: Lens' UserSearchSummary (Maybe Text) Source #

The identifier of the user's hierarchy group.

userSearchSummary_id :: Lens' UserSearchSummary (Maybe Text) Source #

The identifier of the user's summary.

userSearchSummary_identityInfo :: Lens' UserSearchSummary (Maybe UserIdentityInfoLite) Source #

The user's first name and last name.

userSearchSummary_phoneConfig :: Lens' UserSearchSummary (Maybe UserPhoneConfig) Source #

Undocumented member.

userSearchSummary_routingProfileId :: Lens' UserSearchSummary (Maybe Text) Source #

The identifier of the user's routing profile.

userSearchSummary_securityProfileIds :: Lens' UserSearchSummary (Maybe (NonEmpty Text)) Source #

The identifiers of the user's security profiles.

userSearchSummary_tags :: Lens' UserSearchSummary (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

userSearchSummary_username :: Lens' UserSearchSummary (Maybe Text) Source #

The name of the user.

UserSummary

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

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

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

The identifier of the user account.

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

The Amazon Connect user name of the user account.

Vocabulary

vocabulary_content :: Lens' Vocabulary (Maybe Text) Source #

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.

vocabulary_failureReason :: Lens' Vocabulary (Maybe Text) Source #

The reason why the custom vocabulary was not created.

vocabulary_tags :: Lens' Vocabulary (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

vocabulary_name :: Lens' Vocabulary Text Source #

A unique name of the custom vocabulary.

vocabulary_id :: Lens' Vocabulary Text Source #

The identifier of the custom vocabulary.

vocabulary_arn :: Lens' Vocabulary Text Source #

The Amazon Resource Name (ARN) of the custom vocabulary.

vocabulary_languageCode :: Lens' Vocabulary VocabularyLanguageCode Source #

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?