Type definitions#
Auto-generated documentation for Connect type annotations stubs module types-aiobotocore-connect.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]ActionSummaryTypeDef#
# ActionSummaryTypeDef definition
class ActionSummaryTypeDef(TypedDict):
ActionType: ActionTypeType, # (1)- See ActionTypeType
ActivateEvaluationFormRequestRequestTypeDef#
# ActivateEvaluationFormRequestRequestTypeDef definition
class ActivateEvaluationFormRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: int,ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,DistributionTypeDef#
# DistributionTypeDef definition
class DistributionTypeDef(TypedDict):
Region: str,
Percentage: int,QueueReferenceTypeDef#
# QueueReferenceTypeDef definition
class QueueReferenceTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],AgentInfoTypeDef#
# AgentInfoTypeDef definition
class AgentInfoTypeDef(TypedDict):
Id: NotRequired[str],
ConnectedToAgentTimestamp: NotRequired[datetime],AgentStatusReferenceTypeDef#
# AgentStatusReferenceTypeDef definition
class AgentStatusReferenceTypeDef(TypedDict):
StatusStartTimestamp: NotRequired[datetime],
StatusArn: NotRequired[str],
StatusName: NotRequired[str],AgentStatusSummaryTypeDef#
# AgentStatusSummaryTypeDef definition
class AgentStatusSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
Type: NotRequired[AgentStatusTypeType], # (1)AgentStatusTypeDef#
# AgentStatusTypeDef definition
class AgentStatusTypeDef(TypedDict):
AgentStatusARN: NotRequired[str],
AgentStatusId: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
Type: NotRequired[AgentStatusTypeType], # (1)
DisplayOrder: NotRequired[int],
State: NotRequired[AgentStatusStateType], # (2)
Tags: NotRequired[Dict[str, str]],AnswerMachineDetectionConfigTypeDef#
# AnswerMachineDetectionConfigTypeDef definition
class AnswerMachineDetectionConfigTypeDef(TypedDict):
EnableAnswerMachineDetection: NotRequired[bool],
AwaitAnswerMachinePrompt: NotRequired[bool],AssociateApprovedOriginRequestRequestTypeDef#
# AssociateApprovedOriginRequestRequestTypeDef definition
class AssociateApprovedOriginRequestRequestTypeDef(TypedDict):
InstanceId: str,
Origin: str,LexBotTypeDef#
# LexBotTypeDef definition
class LexBotTypeDef(TypedDict):
Name: str,
LexRegion: str,LexV2BotTypeDef#
# LexV2BotTypeDef definition
class LexV2BotTypeDef(TypedDict):
AliasArn: NotRequired[str],AssociateDefaultVocabularyRequestRequestTypeDef#
# AssociateDefaultVocabularyRequestRequestTypeDef definition
class AssociateDefaultVocabularyRequestRequestTypeDef(TypedDict):
InstanceId: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
VocabularyId: NotRequired[str],AssociateLambdaFunctionRequestRequestTypeDef#
# AssociateLambdaFunctionRequestRequestTypeDef definition
class AssociateLambdaFunctionRequestRequestTypeDef(TypedDict):
InstanceId: str,
FunctionArn: str,AssociatePhoneNumberContactFlowRequestRequestTypeDef#
# AssociatePhoneNumberContactFlowRequestRequestTypeDef definition
class AssociatePhoneNumberContactFlowRequestRequestTypeDef(TypedDict):
PhoneNumberId: str,
InstanceId: str,
ContactFlowId: str,AssociateQueueQuickConnectsRequestRequestTypeDef#
# AssociateQueueQuickConnectsRequestRequestTypeDef definition
class AssociateQueueQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
QuickConnectIds: Sequence[str],AssociateSecurityKeyRequestRequestTypeDef#
# AssociateSecurityKeyRequestRequestTypeDef definition
class AssociateSecurityKeyRequestRequestTypeDef(TypedDict):
InstanceId: str,
Key: str,AssociateTrafficDistributionGroupUserRequestRequestTypeDef#
# AssociateTrafficDistributionGroupUserRequestRequestTypeDef definition
class AssociateTrafficDistributionGroupUserRequestRequestTypeDef(TypedDict):
TrafficDistributionGroupId: str,
UserId: str,
InstanceId: str,AttachmentReferenceTypeDef#
# AttachmentReferenceTypeDef definition
class AttachmentReferenceTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],
Status: NotRequired[ReferenceStatusType], # (1)AttributeTypeDef#
# AttributeTypeDef definition
class AttributeTypeDef(TypedDict):
AttributeType: NotRequired[InstanceAttributeTypeType], # (1)
Value: NotRequired[str],AvailableNumberSummaryTypeDef#
# AvailableNumberSummaryTypeDef definition
class AvailableNumberSummaryTypeDef(TypedDict):
PhoneNumber: NotRequired[str],
PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType], # (1)
PhoneNumberType: NotRequired[PhoneNumberTypeType], # (2)ChatMessageTypeDef#
# ChatMessageTypeDef definition
class ChatMessageTypeDef(TypedDict):
ContentType: str,
Content: str,ChatStreamingConfigurationTypeDef#
# ChatStreamingConfigurationTypeDef definition
class ChatStreamingConfigurationTypeDef(TypedDict):
StreamingEndpointArn: str,ClaimPhoneNumberRequestRequestTypeDef#
# ClaimPhoneNumberRequestRequestTypeDef definition
class ClaimPhoneNumberRequestRequestTypeDef(TypedDict):
TargetArn: str,
PhoneNumber: str,
PhoneNumberDescription: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
ClientToken: NotRequired[str],PhoneNumberStatusTypeDef#
# PhoneNumberStatusTypeDef definition
class PhoneNumberStatusTypeDef(TypedDict):
Status: NotRequired[PhoneNumberWorkflowStatusType], # (1)
Message: NotRequired[str],ContactFilterTypeDef#
# ContactFilterTypeDef definition
class ContactFilterTypeDef(TypedDict):
ContactStates: NotRequired[Sequence[ContactStateType]], # (1)- See ContactStateType
ContactFlowModuleSummaryTypeDef#
# ContactFlowModuleSummaryTypeDef definition
class ContactFlowModuleSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
State: NotRequired[ContactFlowModuleStateType], # (1)ContactFlowModuleTypeDef#
# ContactFlowModuleTypeDef definition
class ContactFlowModuleTypeDef(TypedDict):
Arn: NotRequired[str],
Id: NotRequired[str],
Name: NotRequired[str],
Content: NotRequired[str],
Description: NotRequired[str],
State: NotRequired[ContactFlowModuleStateType], # (1)
Status: NotRequired[ContactFlowModuleStatusType], # (2)
Tags: NotRequired[Dict[str, str]],ContactFlowSummaryTypeDef#
# ContactFlowSummaryTypeDef definition
class ContactFlowSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
ContactFlowType: NotRequired[ContactFlowTypeType], # (1)
ContactFlowState: NotRequired[ContactFlowStateType], # (2)ContactFlowTypeDef#
# ContactFlowTypeDef definition
class ContactFlowTypeDef(TypedDict):
Arn: NotRequired[str],
Id: NotRequired[str],
Name: NotRequired[str],
Type: NotRequired[ContactFlowTypeType], # (1)
State: NotRequired[ContactFlowStateType], # (2)
Description: NotRequired[str],
Content: NotRequired[str],
Tags: NotRequired[Dict[str, str]],QueueInfoTypeDef#
# QueueInfoTypeDef definition
class QueueInfoTypeDef(TypedDict):
Id: NotRequired[str],
EnqueueTimestamp: NotRequired[datetime],WisdomInfoTypeDef#
# WisdomInfoTypeDef definition
class WisdomInfoTypeDef(TypedDict):
SessionArn: NotRequired[str],TagConditionTypeDef#
# TagConditionTypeDef definition
class TagConditionTypeDef(TypedDict):
TagKey: NotRequired[str],
TagValue: NotRequired[str],CreateAgentStatusRequestRequestTypeDef#
# CreateAgentStatusRequestRequestTypeDef definition
class CreateAgentStatusRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
State: AgentStatusStateType, # (1)
Description: NotRequired[str],
DisplayOrder: NotRequired[int],
Tags: NotRequired[Mapping[str, str]],CreateContactFlowModuleRequestRequestTypeDef#
# CreateContactFlowModuleRequestRequestTypeDef definition
class CreateContactFlowModuleRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
Content: str,
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
ClientToken: NotRequired[str],CreateContactFlowRequestRequestTypeDef#
# CreateContactFlowRequestRequestTypeDef definition
class CreateContactFlowRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
Type: ContactFlowTypeType, # (1)
Content: str,
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],EvaluationFormScoringStrategyTypeDef#
# EvaluationFormScoringStrategyTypeDef definition
class EvaluationFormScoringStrategyTypeDef(TypedDict):
Mode: EvaluationFormScoringModeType, # (1)
Status: EvaluationFormScoringStatusType, # (2)CreateInstanceRequestRequestTypeDef#
# CreateInstanceRequestRequestTypeDef definition
class CreateInstanceRequestRequestTypeDef(TypedDict):
IdentityManagementType: DirectoryTypeType, # (1)
InboundCallsEnabled: bool,
OutboundCallsEnabled: bool,
ClientToken: NotRequired[str],
InstanceAlias: NotRequired[str],
DirectoryId: NotRequired[str],CreateIntegrationAssociationRequestRequestTypeDef#
# CreateIntegrationAssociationRequestRequestTypeDef definition
class CreateIntegrationAssociationRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationType: IntegrationTypeType, # (1)
IntegrationArn: str,
SourceApplicationUrl: NotRequired[str],
SourceApplicationName: NotRequired[str],
SourceType: NotRequired[SourceTypeType], # (2)
Tags: NotRequired[Mapping[str, str]],- See IntegrationTypeType
- See SourceTypeType
ParticipantDetailsToAddTypeDef#
# ParticipantDetailsToAddTypeDef definition
class ParticipantDetailsToAddTypeDef(TypedDict):
ParticipantRole: NotRequired[ParticipantRoleType], # (1)
DisplayName: NotRequired[str],ParticipantTokenCredentialsTypeDef#
# ParticipantTokenCredentialsTypeDef definition
class ParticipantTokenCredentialsTypeDef(TypedDict):
ParticipantToken: NotRequired[str],
Expiry: NotRequired[str],CreatePromptRequestRequestTypeDef#
# CreatePromptRequestRequestTypeDef definition
class CreatePromptRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
S3Uri: str,
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],OutboundCallerConfigTypeDef#
# OutboundCallerConfigTypeDef definition
class OutboundCallerConfigTypeDef(TypedDict):
OutboundCallerIdName: NotRequired[str],
OutboundCallerIdNumberId: NotRequired[str],
OutboundFlowId: NotRequired[str],RuleTriggerEventSourceTypeDef#
# RuleTriggerEventSourceTypeDef definition
class RuleTriggerEventSourceTypeDef(TypedDict):
EventSourceName: EventSourceNameType, # (1)
IntegrationAssociationId: NotRequired[str],CreateSecurityProfileRequestRequestTypeDef#
# CreateSecurityProfileRequestRequestTypeDef definition
class CreateSecurityProfileRequestRequestTypeDef(TypedDict):
SecurityProfileName: str,
InstanceId: str,
Description: NotRequired[str],
Permissions: NotRequired[Sequence[str]],
Tags: NotRequired[Mapping[str, str]],
AllowedAccessControlTags: NotRequired[Mapping[str, str]],
TagRestrictedResources: NotRequired[Sequence[str]],CreateTrafficDistributionGroupRequestRequestTypeDef#
# CreateTrafficDistributionGroupRequestRequestTypeDef definition
class CreateTrafficDistributionGroupRequestRequestTypeDef(TypedDict):
Name: str,
InstanceId: str,
Description: NotRequired[str],
ClientToken: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],CreateUseCaseRequestRequestTypeDef#
# CreateUseCaseRequestRequestTypeDef definition
class CreateUseCaseRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
UseCaseType: UseCaseTypeType, # (1)
Tags: NotRequired[Mapping[str, str]],- See UseCaseTypeType
CreateUserHierarchyGroupRequestRequestTypeDef#
# CreateUserHierarchyGroupRequestRequestTypeDef definition
class CreateUserHierarchyGroupRequestRequestTypeDef(TypedDict):
Name: str,
InstanceId: str,
ParentGroupId: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],UserIdentityInfoTypeDef#
# UserIdentityInfoTypeDef definition
class UserIdentityInfoTypeDef(TypedDict):
FirstName: NotRequired[str],
LastName: NotRequired[str],
Email: NotRequired[str],
SecondaryEmail: NotRequired[str],
Mobile: NotRequired[str],UserPhoneConfigTypeDef#
# UserPhoneConfigTypeDef definition
class UserPhoneConfigTypeDef(TypedDict):
PhoneType: PhoneTypeType, # (1)
AutoAccept: NotRequired[bool],
AfterContactWorkTimeLimit: NotRequired[int],
DeskPhoneNumber: NotRequired[str],- See PhoneTypeType
CreateVocabularyRequestRequestTypeDef#
# CreateVocabularyRequestRequestTypeDef definition
class CreateVocabularyRequestRequestTypeDef(TypedDict):
InstanceId: str,
VocabularyName: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
Content: str,
ClientToken: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],CredentialsTypeDef#
# CredentialsTypeDef definition
class CredentialsTypeDef(TypedDict):
AccessToken: NotRequired[str],
AccessTokenExpiration: NotRequired[datetime],
RefreshToken: NotRequired[str],
RefreshTokenExpiration: NotRequired[datetime],CrossChannelBehaviorTypeDef#
# CrossChannelBehaviorTypeDef definition
class CrossChannelBehaviorTypeDef(TypedDict):
BehaviorType: BehaviorTypeType, # (1)- See BehaviorTypeType
CurrentMetricTypeDef#
# CurrentMetricTypeDef definition
class CurrentMetricTypeDef(TypedDict):
Name: NotRequired[CurrentMetricNameType], # (1)
Unit: NotRequired[UnitType], # (2)- See CurrentMetricNameType
- See UnitType
CurrentMetricSortCriteriaTypeDef#
# CurrentMetricSortCriteriaTypeDef definition
class CurrentMetricSortCriteriaTypeDef(TypedDict):
SortByMetric: NotRequired[CurrentMetricNameType], # (1)
SortOrder: NotRequired[SortOrderType], # (2)- See CurrentMetricNameType
- See SortOrderType
DateReferenceTypeDef#
# DateReferenceTypeDef definition
class DateReferenceTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],DeactivateEvaluationFormRequestRequestTypeDef#
# DeactivateEvaluationFormRequestRequestTypeDef definition
class DeactivateEvaluationFormRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: int,DefaultVocabularyTypeDef#
# DefaultVocabularyTypeDef definition
class DefaultVocabularyTypeDef(TypedDict):
InstanceId: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
VocabularyId: str,
VocabularyName: str,DeleteContactEvaluationRequestRequestTypeDef#
# DeleteContactEvaluationRequestRequestTypeDef definition
class DeleteContactEvaluationRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationId: str,DeleteContactFlowModuleRequestRequestTypeDef#
# DeleteContactFlowModuleRequestRequestTypeDef definition
class DeleteContactFlowModuleRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleId: str,DeleteContactFlowRequestRequestTypeDef#
# DeleteContactFlowRequestRequestTypeDef definition
class DeleteContactFlowRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,DeleteEvaluationFormRequestRequestTypeDef#
# DeleteEvaluationFormRequestRequestTypeDef definition
class DeleteEvaluationFormRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: NotRequired[int],DeleteHoursOfOperationRequestRequestTypeDef#
# DeleteHoursOfOperationRequestRequestTypeDef definition
class DeleteHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,DeleteInstanceRequestRequestTypeDef#
# DeleteInstanceRequestRequestTypeDef definition
class DeleteInstanceRequestRequestTypeDef(TypedDict):
InstanceId: str,DeleteIntegrationAssociationRequestRequestTypeDef#
# DeleteIntegrationAssociationRequestRequestTypeDef definition
class DeleteIntegrationAssociationRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,DeletePromptRequestRequestTypeDef#
# DeletePromptRequestRequestTypeDef definition
class DeletePromptRequestRequestTypeDef(TypedDict):
InstanceId: str,
PromptId: str,DeleteQueueRequestRequestTypeDef#
# DeleteQueueRequestRequestTypeDef definition
class DeleteQueueRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,DeleteQuickConnectRequestRequestTypeDef#
# DeleteQuickConnectRequestRequestTypeDef definition
class DeleteQuickConnectRequestRequestTypeDef(TypedDict):
InstanceId: str,
QuickConnectId: str,DeleteRoutingProfileRequestRequestTypeDef#
# DeleteRoutingProfileRequestRequestTypeDef definition
class DeleteRoutingProfileRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,DeleteRuleRequestRequestTypeDef#
# DeleteRuleRequestRequestTypeDef definition
class DeleteRuleRequestRequestTypeDef(TypedDict):
InstanceId: str,
RuleId: str,DeleteSecurityProfileRequestRequestTypeDef#
# DeleteSecurityProfileRequestRequestTypeDef definition
class DeleteSecurityProfileRequestRequestTypeDef(TypedDict):
InstanceId: str,
SecurityProfileId: str,DeleteTaskTemplateRequestRequestTypeDef#
# DeleteTaskTemplateRequestRequestTypeDef definition
class DeleteTaskTemplateRequestRequestTypeDef(TypedDict):
InstanceId: str,
TaskTemplateId: str,DeleteTrafficDistributionGroupRequestRequestTypeDef#
# DeleteTrafficDistributionGroupRequestRequestTypeDef definition
class DeleteTrafficDistributionGroupRequestRequestTypeDef(TypedDict):
TrafficDistributionGroupId: str,DeleteUseCaseRequestRequestTypeDef#
# DeleteUseCaseRequestRequestTypeDef definition
class DeleteUseCaseRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
UseCaseId: str,DeleteUserHierarchyGroupRequestRequestTypeDef#
# DeleteUserHierarchyGroupRequestRequestTypeDef definition
class DeleteUserHierarchyGroupRequestRequestTypeDef(TypedDict):
HierarchyGroupId: str,
InstanceId: str,DeleteUserRequestRequestTypeDef#
# DeleteUserRequestRequestTypeDef definition
class DeleteUserRequestRequestTypeDef(TypedDict):
InstanceId: str,
UserId: str,DeleteVocabularyRequestRequestTypeDef#
# DeleteVocabularyRequestRequestTypeDef definition
class DeleteVocabularyRequestRequestTypeDef(TypedDict):
InstanceId: str,
VocabularyId: str,DescribeAgentStatusRequestRequestTypeDef#
# DescribeAgentStatusRequestRequestTypeDef definition
class DescribeAgentStatusRequestRequestTypeDef(TypedDict):
InstanceId: str,
AgentStatusId: str,DescribeContactEvaluationRequestRequestTypeDef#
# DescribeContactEvaluationRequestRequestTypeDef definition
class DescribeContactEvaluationRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationId: str,DescribeContactFlowModuleRequestRequestTypeDef#
# DescribeContactFlowModuleRequestRequestTypeDef definition
class DescribeContactFlowModuleRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleId: str,DescribeContactFlowRequestRequestTypeDef#
# DescribeContactFlowRequestRequestTypeDef definition
class DescribeContactFlowRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,DescribeContactRequestRequestTypeDef#
# DescribeContactRequestRequestTypeDef definition
class DescribeContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,DescribeEvaluationFormRequestRequestTypeDef#
# DescribeEvaluationFormRequestRequestTypeDef definition
class DescribeEvaluationFormRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: NotRequired[int],DescribeHoursOfOperationRequestRequestTypeDef#
# DescribeHoursOfOperationRequestRequestTypeDef definition
class DescribeHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,DescribeInstanceAttributeRequestRequestTypeDef#
# DescribeInstanceAttributeRequestRequestTypeDef definition
class DescribeInstanceAttributeRequestRequestTypeDef(TypedDict):
InstanceId: str,
AttributeType: InstanceAttributeTypeType, # (1)DescribeInstanceRequestRequestTypeDef#
# DescribeInstanceRequestRequestTypeDef definition
class DescribeInstanceRequestRequestTypeDef(TypedDict):
InstanceId: str,DescribeInstanceStorageConfigRequestRequestTypeDef#
# DescribeInstanceStorageConfigRequestRequestTypeDef definition
class DescribeInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)DescribePhoneNumberRequestRequestTypeDef#
# DescribePhoneNumberRequestRequestTypeDef definition
class DescribePhoneNumberRequestRequestTypeDef(TypedDict):
PhoneNumberId: str,DescribePromptRequestRequestTypeDef#
# DescribePromptRequestRequestTypeDef definition
class DescribePromptRequestRequestTypeDef(TypedDict):
InstanceId: str,
PromptId: str,PromptTypeDef#
# PromptTypeDef definition
class PromptTypeDef(TypedDict):
PromptARN: NotRequired[str],
PromptId: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
Tags: NotRequired[Dict[str, str]],DescribeQueueRequestRequestTypeDef#
# DescribeQueueRequestRequestTypeDef definition
class DescribeQueueRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,DescribeQuickConnectRequestRequestTypeDef#
# DescribeQuickConnectRequestRequestTypeDef definition
class DescribeQuickConnectRequestRequestTypeDef(TypedDict):
InstanceId: str,
QuickConnectId: str,DescribeRoutingProfileRequestRequestTypeDef#
# DescribeRoutingProfileRequestRequestTypeDef definition
class DescribeRoutingProfileRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,DescribeRuleRequestRequestTypeDef#
# DescribeRuleRequestRequestTypeDef definition
class DescribeRuleRequestRequestTypeDef(TypedDict):
InstanceId: str,
RuleId: str,DescribeSecurityProfileRequestRequestTypeDef#
# DescribeSecurityProfileRequestRequestTypeDef definition
class DescribeSecurityProfileRequestRequestTypeDef(TypedDict):
SecurityProfileId: str,
InstanceId: str,SecurityProfileTypeDef#
# SecurityProfileTypeDef definition
class SecurityProfileTypeDef(TypedDict):
Id: NotRequired[str],
OrganizationResourceId: NotRequired[str],
Arn: NotRequired[str],
SecurityProfileName: NotRequired[str],
Description: NotRequired[str],
Tags: NotRequired[Dict[str, str]],
AllowedAccessControlTags: NotRequired[Dict[str, str]],
TagRestrictedResources: NotRequired[List[str]],DescribeTrafficDistributionGroupRequestRequestTypeDef#
# DescribeTrafficDistributionGroupRequestRequestTypeDef definition
class DescribeTrafficDistributionGroupRequestRequestTypeDef(TypedDict):
TrafficDistributionGroupId: str,TrafficDistributionGroupTypeDef#
# TrafficDistributionGroupTypeDef definition
class TrafficDistributionGroupTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
InstanceArn: NotRequired[str],
Status: NotRequired[TrafficDistributionGroupStatusType], # (1)
Tags: NotRequired[Dict[str, str]],
IsDefault: NotRequired[bool],DescribeUserHierarchyGroupRequestRequestTypeDef#
# DescribeUserHierarchyGroupRequestRequestTypeDef definition
class DescribeUserHierarchyGroupRequestRequestTypeDef(TypedDict):
HierarchyGroupId: str,
InstanceId: str,DescribeUserHierarchyStructureRequestRequestTypeDef#
# DescribeUserHierarchyStructureRequestRequestTypeDef definition
class DescribeUserHierarchyStructureRequestRequestTypeDef(TypedDict):
InstanceId: str,DescribeUserRequestRequestTypeDef#
# DescribeUserRequestRequestTypeDef definition
class DescribeUserRequestRequestTypeDef(TypedDict):
UserId: str,
InstanceId: str,DescribeVocabularyRequestRequestTypeDef#
# DescribeVocabularyRequestRequestTypeDef definition
class DescribeVocabularyRequestRequestTypeDef(TypedDict):
InstanceId: str,
VocabularyId: str,VocabularyTypeDef#
# VocabularyTypeDef definition
class VocabularyTypeDef(TypedDict):
Name: str,
Id: str,
Arn: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
State: VocabularyStateType, # (2)
LastModifiedTime: datetime,
FailureReason: NotRequired[str],
Content: NotRequired[str],
Tags: NotRequired[Dict[str, str]],RoutingProfileReferenceTypeDef#
# RoutingProfileReferenceTypeDef definition
class RoutingProfileReferenceTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],DisassociateApprovedOriginRequestRequestTypeDef#
# DisassociateApprovedOriginRequestRequestTypeDef definition
class DisassociateApprovedOriginRequestRequestTypeDef(TypedDict):
InstanceId: str,
Origin: str,DisassociateInstanceStorageConfigRequestRequestTypeDef#
# DisassociateInstanceStorageConfigRequestRequestTypeDef definition
class DisassociateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)DisassociateLambdaFunctionRequestRequestTypeDef#
# DisassociateLambdaFunctionRequestRequestTypeDef definition
class DisassociateLambdaFunctionRequestRequestTypeDef(TypedDict):
InstanceId: str,
FunctionArn: str,DisassociateLexBotRequestRequestTypeDef#
# DisassociateLexBotRequestRequestTypeDef definition
class DisassociateLexBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
BotName: str,
LexRegion: str,DisassociatePhoneNumberContactFlowRequestRequestTypeDef#
# DisassociatePhoneNumberContactFlowRequestRequestTypeDef definition
class DisassociatePhoneNumberContactFlowRequestRequestTypeDef(TypedDict):
PhoneNumberId: str,
InstanceId: str,DisassociateQueueQuickConnectsRequestRequestTypeDef#
# DisassociateQueueQuickConnectsRequestRequestTypeDef definition
class DisassociateQueueQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
QuickConnectIds: Sequence[str],RoutingProfileQueueReferenceTypeDef#
# RoutingProfileQueueReferenceTypeDef definition
class RoutingProfileQueueReferenceTypeDef(TypedDict):
QueueId: str,
Channel: ChannelType, # (1)- See ChannelType
DisassociateSecurityKeyRequestRequestTypeDef#
# DisassociateSecurityKeyRequestRequestTypeDef definition
class DisassociateSecurityKeyRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,DisassociateTrafficDistributionGroupUserRequestRequestTypeDef#
# DisassociateTrafficDistributionGroupUserRequestRequestTypeDef definition
class DisassociateTrafficDistributionGroupUserRequestRequestTypeDef(TypedDict):
TrafficDistributionGroupId: str,
UserId: str,
InstanceId: str,DismissUserContactRequestRequestTypeDef#
# DismissUserContactRequestRequestTypeDef definition
class DismissUserContactRequestRequestTypeDef(TypedDict):
UserId: str,
InstanceId: str,
ContactId: str,EmailReferenceTypeDef#
# EmailReferenceTypeDef definition
class EmailReferenceTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],EncryptionConfigTypeDef#
# EncryptionConfigTypeDef definition
class EncryptionConfigTypeDef(TypedDict):
EncryptionType: EncryptionTypeType, # (1)
KeyId: str,EvaluationAnswerDataTypeDef#
# EvaluationAnswerDataTypeDef definition
class EvaluationAnswerDataTypeDef(TypedDict):
StringValue: NotRequired[str],
NumericValue: NotRequired[float],
NotApplicable: NotRequired[bool],NumericQuestionPropertyValueAutomationTypeDef#
# NumericQuestionPropertyValueAutomationTypeDef definition
class NumericQuestionPropertyValueAutomationTypeDef(TypedDict):
Label: NumericQuestionPropertyAutomationLabelType, # (1)EvaluationFormNumericQuestionOptionTypeDef#
# EvaluationFormNumericQuestionOptionTypeDef definition
class EvaluationFormNumericQuestionOptionTypeDef(TypedDict):
MinValue: int,
MaxValue: int,
Score: NotRequired[int],
AutomaticFail: NotRequired[bool],EvaluationFormSectionTypeDef#
# EvaluationFormSectionTypeDef definition
class EvaluationFormSectionTypeDef(TypedDict):
Title: str,
RefId: str,
Items: Sequence[EvaluationFormItemTypeDef], # (1)
Instructions: NotRequired[str],
Weight: NotRequired[float],SingleSelectQuestionRuleCategoryAutomationTypeDef#
# SingleSelectQuestionRuleCategoryAutomationTypeDef definition
class SingleSelectQuestionRuleCategoryAutomationTypeDef(TypedDict):
Category: str,
Condition: SingleSelectQuestionRuleCategoryAutomationConditionType, # (1)
OptionRefId: str,EvaluationFormSingleSelectQuestionOptionTypeDef#
# EvaluationFormSingleSelectQuestionOptionTypeDef definition
class EvaluationFormSingleSelectQuestionOptionTypeDef(TypedDict):
RefId: str,
Text: str,
Score: NotRequired[int],
AutomaticFail: NotRequired[bool],EvaluationFormSummaryTypeDef#
# EvaluationFormSummaryTypeDef definition
class EvaluationFormSummaryTypeDef(TypedDict):
EvaluationFormId: str,
EvaluationFormArn: str,
Title: str,
CreatedTime: datetime,
CreatedBy: str,
LastModifiedTime: datetime,
LastModifiedBy: str,
LatestVersion: int,
LastActivatedTime: NotRequired[datetime],
LastActivatedBy: NotRequired[str],
ActiveVersion: NotRequired[int],EvaluationFormVersionSummaryTypeDef#
# EvaluationFormVersionSummaryTypeDef definition
class EvaluationFormVersionSummaryTypeDef(TypedDict):
EvaluationFormArn: str,
EvaluationFormId: str,
EvaluationFormVersion: int,
Locked: bool,
Status: EvaluationFormVersionStatusType, # (1)
CreatedTime: datetime,
CreatedBy: str,
LastModifiedTime: datetime,
LastModifiedBy: str,EvaluationScoreTypeDef#
# EvaluationScoreTypeDef definition
class EvaluationScoreTypeDef(TypedDict):
Percentage: NotRequired[float],
NotApplicable: NotRequired[bool],
AutomaticFail: NotRequired[bool],EvaluationNoteTypeDef#
# EvaluationNoteTypeDef definition
class EvaluationNoteTypeDef(TypedDict):
Value: NotRequired[str],EventBridgeActionDefinitionTypeDef#
# EventBridgeActionDefinitionTypeDef definition
class EventBridgeActionDefinitionTypeDef(TypedDict):
Name: str,FilterV2TypeDef#
# FilterV2TypeDef definition
class FilterV2TypeDef(TypedDict):
FilterKey: NotRequired[str],
FilterValues: NotRequired[Sequence[str]],FiltersTypeDef#
# FiltersTypeDef definition
class FiltersTypeDef(TypedDict):
Queues: NotRequired[Sequence[str]],
Channels: NotRequired[Sequence[ChannelType]], # (1)
RoutingProfiles: NotRequired[Sequence[str]],- See ChannelType
GetContactAttributesRequestRequestTypeDef#
# GetContactAttributesRequestRequestTypeDef definition
class GetContactAttributesRequestRequestTypeDef(TypedDict):
InstanceId: str,
InitialContactId: str,GetFederationTokenRequestRequestTypeDef#
# GetFederationTokenRequestRequestTypeDef definition
class GetFederationTokenRequestRequestTypeDef(TypedDict):
InstanceId: str,PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],GetPromptFileRequestRequestTypeDef#
# GetPromptFileRequestRequestTypeDef definition
class GetPromptFileRequestRequestTypeDef(TypedDict):
InstanceId: str,
PromptId: str,GetTaskTemplateRequestRequestTypeDef#
# GetTaskTemplateRequestRequestTypeDef definition
class GetTaskTemplateRequestRequestTypeDef(TypedDict):
InstanceId: str,
TaskTemplateId: str,
SnapshotVersion: NotRequired[str],GetTrafficDistributionRequestRequestTypeDef#
# GetTrafficDistributionRequestRequestTypeDef definition
class GetTrafficDistributionRequestRequestTypeDef(TypedDict):
Id: str,HierarchyGroupConditionTypeDef#
# HierarchyGroupConditionTypeDef definition
class HierarchyGroupConditionTypeDef(TypedDict):
Value: NotRequired[str],
HierarchyGroupMatchType: NotRequired[HierarchyGroupMatchTypeType], # (1)HierarchyGroupSummaryReferenceTypeDef#
# HierarchyGroupSummaryReferenceTypeDef definition
class HierarchyGroupSummaryReferenceTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],HierarchyGroupSummaryTypeDef#
# HierarchyGroupSummaryTypeDef definition
class HierarchyGroupSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],HierarchyLevelTypeDef#
# HierarchyLevelTypeDef definition
class HierarchyLevelTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],HierarchyLevelUpdateTypeDef#
# HierarchyLevelUpdateTypeDef definition
class HierarchyLevelUpdateTypeDef(TypedDict):
Name: str,ThresholdTypeDef#
# ThresholdTypeDef definition
class ThresholdTypeDef(TypedDict):
Comparison: NotRequired[ComparisonType], # (1)
ThresholdValue: NotRequired[float],- See ComparisonType
HoursOfOperationTimeSliceTypeDef#
# HoursOfOperationTimeSliceTypeDef definition
class HoursOfOperationTimeSliceTypeDef(TypedDict):
Hours: int,
Minutes: int,StringConditionTypeDef#
# StringConditionTypeDef definition
class StringConditionTypeDef(TypedDict):
FieldName: NotRequired[str],
Value: NotRequired[str],
ComparisonType: NotRequired[StringComparisonTypeType], # (1)HoursOfOperationSummaryTypeDef#
# HoursOfOperationSummaryTypeDef definition
class HoursOfOperationSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],InstanceStatusReasonTypeDef#
# InstanceStatusReasonTypeDef definition
class InstanceStatusReasonTypeDef(TypedDict):
Message: NotRequired[str],KinesisFirehoseConfigTypeDef#
# KinesisFirehoseConfigTypeDef definition
class KinesisFirehoseConfigTypeDef(TypedDict):
FirehoseArn: str,KinesisStreamConfigTypeDef#
# KinesisStreamConfigTypeDef definition
class KinesisStreamConfigTypeDef(TypedDict):
StreamArn: str,InstanceSummaryTypeDef#
# InstanceSummaryTypeDef definition
class InstanceSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
IdentityManagementType: NotRequired[DirectoryTypeType], # (1)
InstanceAlias: NotRequired[str],
CreatedTime: NotRequired[datetime],
ServiceRole: NotRequired[str],
InstanceStatus: NotRequired[InstanceStatusType], # (2)
InboundCallsEnabled: NotRequired[bool],
OutboundCallsEnabled: NotRequired[bool],
InstanceAccessUrl: NotRequired[str],- See DirectoryTypeType
- See InstanceStatusType
IntegrationAssociationSummaryTypeDef#
# IntegrationAssociationSummaryTypeDef definition
class IntegrationAssociationSummaryTypeDef(TypedDict):
IntegrationAssociationId: NotRequired[str],
IntegrationAssociationArn: NotRequired[str],
InstanceId: NotRequired[str],
IntegrationType: NotRequired[IntegrationTypeType], # (1)
IntegrationArn: NotRequired[str],
SourceApplicationUrl: NotRequired[str],
SourceApplicationName: NotRequired[str],
SourceType: NotRequired[SourceTypeType], # (2)- See IntegrationTypeType
- See SourceTypeType
TaskTemplateFieldIdentifierTypeDef#
# TaskTemplateFieldIdentifierTypeDef definition
class TaskTemplateFieldIdentifierTypeDef(TypedDict):
Name: NotRequired[str],ListAgentStatusRequestRequestTypeDef#
# ListAgentStatusRequestRequestTypeDef definition
class ListAgentStatusRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
AgentStatusTypes: NotRequired[Sequence[AgentStatusTypeType]], # (1)ListApprovedOriginsRequestRequestTypeDef#
# ListApprovedOriginsRequestRequestTypeDef definition
class ListApprovedOriginsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListBotsRequestRequestTypeDef#
# ListBotsRequestRequestTypeDef definition
class ListBotsRequestRequestTypeDef(TypedDict):
InstanceId: str,
LexVersion: LexVersionType, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],- See LexVersionType
ListContactEvaluationsRequestRequestTypeDef#
# ListContactEvaluationsRequestRequestTypeDef definition
class ListContactEvaluationsRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
NextToken: NotRequired[str],ListContactFlowModulesRequestRequestTypeDef#
# ListContactFlowModulesRequestRequestTypeDef definition
class ListContactFlowModulesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ContactFlowModuleState: NotRequired[ContactFlowModuleStateType], # (1)ListContactFlowsRequestRequestTypeDef#
# ListContactFlowsRequestRequestTypeDef definition
class ListContactFlowsRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowTypes: NotRequired[Sequence[ContactFlowTypeType]], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListContactReferencesRequestRequestTypeDef#
# ListContactReferencesRequestRequestTypeDef definition
class ListContactReferencesRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ReferenceTypes: Sequence[ReferenceTypeType], # (1)
NextToken: NotRequired[str],ListDefaultVocabulariesRequestRequestTypeDef#
# ListDefaultVocabulariesRequestRequestTypeDef definition
class ListDefaultVocabulariesRequestRequestTypeDef(TypedDict):
InstanceId: str,
LanguageCode: NotRequired[VocabularyLanguageCodeType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListEvaluationFormVersionsRequestRequestTypeDef#
# ListEvaluationFormVersionsRequestRequestTypeDef definition
class ListEvaluationFormVersionsRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListEvaluationFormsRequestRequestTypeDef#
# ListEvaluationFormsRequestRequestTypeDef definition
class ListEvaluationFormsRequestRequestTypeDef(TypedDict):
InstanceId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListHoursOfOperationsRequestRequestTypeDef#
# ListHoursOfOperationsRequestRequestTypeDef definition
class ListHoursOfOperationsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListInstanceAttributesRequestRequestTypeDef#
# ListInstanceAttributesRequestRequestTypeDef definition
class ListInstanceAttributesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListInstanceStorageConfigsRequestRequestTypeDef#
# ListInstanceStorageConfigsRequestRequestTypeDef definition
class ListInstanceStorageConfigsRequestRequestTypeDef(TypedDict):
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListInstancesRequestRequestTypeDef#
# ListInstancesRequestRequestTypeDef definition
class ListInstancesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListIntegrationAssociationsRequestRequestTypeDef#
# ListIntegrationAssociationsRequestRequestTypeDef definition
class ListIntegrationAssociationsRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationType: NotRequired[IntegrationTypeType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListLambdaFunctionsRequestRequestTypeDef#
# ListLambdaFunctionsRequestRequestTypeDef definition
class ListLambdaFunctionsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListLexBotsRequestRequestTypeDef#
# ListLexBotsRequestRequestTypeDef definition
class ListLexBotsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListPhoneNumbersRequestRequestTypeDef#
# ListPhoneNumbersRequestRequestTypeDef definition
class ListPhoneNumbersRequestRequestTypeDef(TypedDict):
InstanceId: str,
PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]], # (1)
PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]], # (2)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],PhoneNumberSummaryTypeDef#
# PhoneNumberSummaryTypeDef definition
class PhoneNumberSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
PhoneNumber: NotRequired[str],
PhoneNumberType: NotRequired[PhoneNumberTypeType], # (1)
PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType], # (2)ListPhoneNumbersSummaryTypeDef#
# ListPhoneNumbersSummaryTypeDef definition
class ListPhoneNumbersSummaryTypeDef(TypedDict):
PhoneNumberId: NotRequired[str],
PhoneNumberArn: NotRequired[str],
PhoneNumber: NotRequired[str],
PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType], # (1)
PhoneNumberType: NotRequired[PhoneNumberTypeType], # (2)
TargetArn: NotRequired[str],ListPhoneNumbersV2RequestRequestTypeDef#
# ListPhoneNumbersV2RequestRequestTypeDef definition
class ListPhoneNumbersV2RequestRequestTypeDef(TypedDict):
TargetArn: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]], # (1)
PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]], # (2)
PhoneNumberPrefix: NotRequired[str],ListPromptsRequestRequestTypeDef#
# ListPromptsRequestRequestTypeDef definition
class ListPromptsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],PromptSummaryTypeDef#
# PromptSummaryTypeDef definition
class PromptSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],ListQueueQuickConnectsRequestRequestTypeDef#
# ListQueueQuickConnectsRequestRequestTypeDef definition
class ListQueueQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],QuickConnectSummaryTypeDef#
# QuickConnectSummaryTypeDef definition
class QuickConnectSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
QuickConnectType: NotRequired[QuickConnectTypeType], # (1)ListQueuesRequestRequestTypeDef#
# ListQueuesRequestRequestTypeDef definition
class ListQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueTypes: NotRequired[Sequence[QueueTypeType]], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],- See QueueTypeType
QueueSummaryTypeDef#
# QueueSummaryTypeDef definition
class QueueSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
QueueType: NotRequired[QueueTypeType], # (1)- See QueueTypeType
ListQuickConnectsRequestRequestTypeDef#
# ListQuickConnectsRequestRequestTypeDef definition
class ListQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
QuickConnectTypes: NotRequired[Sequence[QuickConnectTypeType]], # (1)ListRoutingProfileQueuesRequestRequestTypeDef#
# ListRoutingProfileQueuesRequestRequestTypeDef definition
class ListRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],RoutingProfileQueueConfigSummaryTypeDef#
# RoutingProfileQueueConfigSummaryTypeDef definition
class RoutingProfileQueueConfigSummaryTypeDef(TypedDict):
QueueId: str,
QueueArn: str,
QueueName: str,
Priority: int,
Delay: int,
Channel: ChannelType, # (1)- See ChannelType
ListRoutingProfilesRequestRequestTypeDef#
# ListRoutingProfilesRequestRequestTypeDef definition
class ListRoutingProfilesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],RoutingProfileSummaryTypeDef#
# RoutingProfileSummaryTypeDef definition
class RoutingProfileSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],ListRulesRequestRequestTypeDef#
# ListRulesRequestRequestTypeDef definition
class ListRulesRequestRequestTypeDef(TypedDict):
InstanceId: str,
PublishStatus: NotRequired[RulePublishStatusType], # (1)
EventSourceName: NotRequired[EventSourceNameType], # (2)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListSecurityKeysRequestRequestTypeDef#
# ListSecurityKeysRequestRequestTypeDef definition
class ListSecurityKeysRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],SecurityKeyTypeDef#
# SecurityKeyTypeDef definition
class SecurityKeyTypeDef(TypedDict):
AssociationId: NotRequired[str],
Key: NotRequired[str],
CreationTime: NotRequired[datetime],ListSecurityProfilePermissionsRequestRequestTypeDef#
# ListSecurityProfilePermissionsRequestRequestTypeDef definition
class ListSecurityProfilePermissionsRequestRequestTypeDef(TypedDict):
SecurityProfileId: str,
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListSecurityProfilesRequestRequestTypeDef#
# ListSecurityProfilesRequestRequestTypeDef definition
class ListSecurityProfilesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],SecurityProfileSummaryTypeDef#
# SecurityProfileSummaryTypeDef definition
class SecurityProfileSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,ListTaskTemplatesRequestRequestTypeDef#
# ListTaskTemplatesRequestRequestTypeDef definition
class ListTaskTemplatesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Status: NotRequired[TaskTemplateStatusType], # (1)
Name: NotRequired[str],TaskTemplateMetadataTypeDef#
# TaskTemplateMetadataTypeDef definition
class TaskTemplateMetadataTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
Status: NotRequired[TaskTemplateStatusType], # (1)
LastModifiedTime: NotRequired[datetime],
CreatedTime: NotRequired[datetime],ListTrafficDistributionGroupUsersRequestRequestTypeDef#
# ListTrafficDistributionGroupUsersRequestRequestTypeDef definition
class ListTrafficDistributionGroupUsersRequestRequestTypeDef(TypedDict):
TrafficDistributionGroupId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],TrafficDistributionGroupUserSummaryTypeDef#
# TrafficDistributionGroupUserSummaryTypeDef definition
class TrafficDistributionGroupUserSummaryTypeDef(TypedDict):
UserId: NotRequired[str],ListTrafficDistributionGroupsRequestRequestTypeDef#
# ListTrafficDistributionGroupsRequestRequestTypeDef definition
class ListTrafficDistributionGroupsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
InstanceId: NotRequired[str],TrafficDistributionGroupSummaryTypeDef#
# TrafficDistributionGroupSummaryTypeDef definition
class TrafficDistributionGroupSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
InstanceArn: NotRequired[str],
Status: NotRequired[TrafficDistributionGroupStatusType], # (1)
IsDefault: NotRequired[bool],ListUseCasesRequestRequestTypeDef#
# ListUseCasesRequestRequestTypeDef definition
class ListUseCasesRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],UseCaseTypeDef#
# UseCaseTypeDef definition
class UseCaseTypeDef(TypedDict):
UseCaseId: NotRequired[str],
UseCaseArn: NotRequired[str],
UseCaseType: NotRequired[UseCaseTypeType], # (1)- See UseCaseTypeType
ListUserHierarchyGroupsRequestRequestTypeDef#
# ListUserHierarchyGroupsRequestRequestTypeDef definition
class ListUserHierarchyGroupsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListUsersRequestRequestTypeDef#
# ListUsersRequestRequestTypeDef definition
class ListUsersRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],UserSummaryTypeDef#
# UserSummaryTypeDef definition
class UserSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Username: NotRequired[str],MetricFilterV2TypeDef#
# MetricFilterV2TypeDef definition
class MetricFilterV2TypeDef(TypedDict):
MetricFilterKey: NotRequired[str],
MetricFilterValues: NotRequired[Sequence[str]],ThresholdV2TypeDef#
# ThresholdV2TypeDef definition
class ThresholdV2TypeDef(TypedDict):
Comparison: NotRequired[str],
ThresholdValue: NotRequired[float],MonitorContactRequestRequestTypeDef#
# MonitorContactRequestRequestTypeDef definition
class MonitorContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
UserId: str,
AllowedMonitorCapabilities: NotRequired[Sequence[MonitorCapabilityType]], # (1)
ClientToken: NotRequired[str],NotificationRecipientTypeTypeDef#
# NotificationRecipientTypeTypeDef definition
class NotificationRecipientTypeTypeDef(TypedDict):
UserTags: NotRequired[Mapping[str, str]],
UserIds: NotRequired[Sequence[str]],NumberReferenceTypeDef#
# NumberReferenceTypeDef definition
class NumberReferenceTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],ParticipantDetailsTypeDef#
# ParticipantDetailsTypeDef definition
class ParticipantDetailsTypeDef(TypedDict):
DisplayName: str,ParticipantTimerValueTypeDef#
# ParticipantTimerValueTypeDef definition
class ParticipantTimerValueTypeDef(TypedDict):
ParticipantTimerAction: NotRequired[ParticipantTimerActionType], # (1)
ParticipantTimerDurationInMinutes: NotRequired[int],PersistentChatTypeDef#
# PersistentChatTypeDef definition
class PersistentChatTypeDef(TypedDict):
RehydrationType: NotRequired[RehydrationTypeType], # (1)
SourceContactId: NotRequired[str],PhoneNumberQuickConnectConfigTypeDef#
# PhoneNumberQuickConnectConfigTypeDef definition
class PhoneNumberQuickConnectConfigTypeDef(TypedDict):
PhoneNumber: str,PutUserStatusRequestRequestTypeDef#
# PutUserStatusRequestRequestTypeDef definition
class PutUserStatusRequestRequestTypeDef(TypedDict):
UserId: str,
InstanceId: str,
AgentStatusId: str,QueueQuickConnectConfigTypeDef#
# QueueQuickConnectConfigTypeDef definition
class QueueQuickConnectConfigTypeDef(TypedDict):
QueueId: str,
ContactFlowId: str,UserQuickConnectConfigTypeDef#
# UserQuickConnectConfigTypeDef definition
class UserQuickConnectConfigTypeDef(TypedDict):
UserId: str,
ContactFlowId: str,StringReferenceTypeDef#
# StringReferenceTypeDef definition
class StringReferenceTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],UrlReferenceTypeDef#
# UrlReferenceTypeDef definition
class UrlReferenceTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],ReferenceTypeDef#
# ReferenceTypeDef definition
class ReferenceTypeDef(TypedDict):
Value: str,
Type: ReferenceTypeType, # (1)ReleasePhoneNumberRequestRequestTypeDef#
# ReleasePhoneNumberRequestRequestTypeDef definition
class ReleasePhoneNumberRequestRequestTypeDef(TypedDict):
PhoneNumberId: str,
ClientToken: NotRequired[str],ReplicateInstanceRequestRequestTypeDef#
# ReplicateInstanceRequestRequestTypeDef definition
class ReplicateInstanceRequestRequestTypeDef(TypedDict):
InstanceId: str,
ReplicaRegion: str,
ReplicaAlias: str,
ClientToken: NotRequired[str],TagSearchConditionTypeDef#
# TagSearchConditionTypeDef definition
class TagSearchConditionTypeDef(TypedDict):
tagKey: NotRequired[str],
tagValue: NotRequired[str],
tagKeyComparisonType: NotRequired[StringComparisonTypeType], # (1)
tagValueComparisonType: NotRequired[StringComparisonTypeType], # (1)ResumeContactRecordingRequestRequestTypeDef#
# ResumeContactRecordingRequestRequestTypeDef definition
class ResumeContactRecordingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
InitialContactId: str,SearchAvailablePhoneNumbersRequestRequestTypeDef#
# SearchAvailablePhoneNumbersRequestRequestTypeDef definition
class SearchAvailablePhoneNumbersRequestRequestTypeDef(TypedDict):
TargetArn: str,
PhoneNumberCountryCode: PhoneNumberCountryCodeType, # (1)
PhoneNumberType: PhoneNumberTypeType, # (2)
PhoneNumberPrefix: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],TagSetTypeDef#
# TagSetTypeDef definition
class TagSetTypeDef(TypedDict):
key: NotRequired[str],
value: NotRequired[str],SecurityProfileSearchSummaryTypeDef#
# SecurityProfileSearchSummaryTypeDef definition
class SecurityProfileSearchSummaryTypeDef(TypedDict):
Id: NotRequired[str],
OrganizationResourceId: NotRequired[str],
Arn: NotRequired[str],
SecurityProfileName: NotRequired[str],
Description: NotRequired[str],
Tags: NotRequired[Dict[str, str]],SearchVocabulariesRequestRequestTypeDef#
# SearchVocabulariesRequestRequestTypeDef definition
class SearchVocabulariesRequestRequestTypeDef(TypedDict):
InstanceId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
State: NotRequired[VocabularyStateType], # (1)
NameStartsWith: NotRequired[str],
LanguageCode: NotRequired[VocabularyLanguageCodeType], # (2)VocabularySummaryTypeDef#
# VocabularySummaryTypeDef definition
class VocabularySummaryTypeDef(TypedDict):
Name: str,
Id: str,
Arn: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
State: VocabularyStateType, # (2)
LastModifiedTime: datetime,
FailureReason: NotRequired[str],SignInDistributionTypeDef#
# SignInDistributionTypeDef definition
class SignInDistributionTypeDef(TypedDict):
Region: str,
Enabled: bool,StartContactEvaluationRequestRequestTypeDef#
# StartContactEvaluationRequestRequestTypeDef definition
class StartContactEvaluationRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
EvaluationFormId: str,
ClientToken: NotRequired[str],VoiceRecordingConfigurationTypeDef#
# VoiceRecordingConfigurationTypeDef definition
class VoiceRecordingConfigurationTypeDef(TypedDict):
VoiceRecordingTrack: NotRequired[VoiceRecordingTrackType], # (1)StopContactRecordingRequestRequestTypeDef#
# StopContactRecordingRequestRequestTypeDef definition
class StopContactRecordingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
InitialContactId: str,StopContactRequestRequestTypeDef#
# StopContactRequestRequestTypeDef definition
class StopContactRequestRequestTypeDef(TypedDict):
ContactId: str,
InstanceId: str,StopContactStreamingRequestRequestTypeDef#
# StopContactStreamingRequestRequestTypeDef definition
class StopContactStreamingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
StreamingId: str,SuspendContactRecordingRequestRequestTypeDef#
# SuspendContactRecordingRequestRequestTypeDef definition
class SuspendContactRecordingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
InitialContactId: str,TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],TransferContactRequestRequestTypeDef#
# TransferContactRequestRequestTypeDef definition
class TransferContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ContactFlowId: str,
QueueId: NotRequired[str],
UserId: NotRequired[str],
ClientToken: NotRequired[str],UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],UpdateAgentStatusRequestRequestTypeDef#
# UpdateAgentStatusRequestRequestTypeDef definition
class UpdateAgentStatusRequestRequestTypeDef(TypedDict):
InstanceId: str,
AgentStatusId: str,
Name: NotRequired[str],
Description: NotRequired[str],
State: NotRequired[AgentStatusStateType], # (1)
DisplayOrder: NotRequired[int],
ResetOrderNumber: NotRequired[bool],UpdateContactAttributesRequestRequestTypeDef#
# UpdateContactAttributesRequestRequestTypeDef definition
class UpdateContactAttributesRequestRequestTypeDef(TypedDict):
InitialContactId: str,
InstanceId: str,
Attributes: Mapping[str, str],UpdateContactFlowContentRequestRequestTypeDef#
# UpdateContactFlowContentRequestRequestTypeDef definition
class UpdateContactFlowContentRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,
Content: str,UpdateContactFlowMetadataRequestRequestTypeDef#
# UpdateContactFlowMetadataRequestRequestTypeDef definition
class UpdateContactFlowMetadataRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,
Name: NotRequired[str],
Description: NotRequired[str],
ContactFlowState: NotRequired[ContactFlowStateType], # (1)UpdateContactFlowModuleContentRequestRequestTypeDef#
# UpdateContactFlowModuleContentRequestRequestTypeDef definition
class UpdateContactFlowModuleContentRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleId: str,
Content: str,UpdateContactFlowModuleMetadataRequestRequestTypeDef#
# UpdateContactFlowModuleMetadataRequestRequestTypeDef definition
class UpdateContactFlowModuleMetadataRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleId: str,
Name: NotRequired[str],
Description: NotRequired[str],
State: NotRequired[ContactFlowModuleStateType], # (1)UpdateContactFlowNameRequestRequestTypeDef#
# UpdateContactFlowNameRequestRequestTypeDef definition
class UpdateContactFlowNameRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,
Name: NotRequired[str],
Description: NotRequired[str],UpdateInstanceAttributeRequestRequestTypeDef#
# UpdateInstanceAttributeRequestRequestTypeDef definition
class UpdateInstanceAttributeRequestRequestTypeDef(TypedDict):
InstanceId: str,
AttributeType: InstanceAttributeTypeType, # (1)
Value: str,UpdatePhoneNumberRequestRequestTypeDef#
# UpdatePhoneNumberRequestRequestTypeDef definition
class UpdatePhoneNumberRequestRequestTypeDef(TypedDict):
PhoneNumberId: str,
TargetArn: str,
ClientToken: NotRequired[str],UpdatePromptRequestRequestTypeDef#
# UpdatePromptRequestRequestTypeDef definition
class UpdatePromptRequestRequestTypeDef(TypedDict):
InstanceId: str,
PromptId: str,
Name: NotRequired[str],
Description: NotRequired[str],
S3Uri: NotRequired[str],UpdateQueueHoursOfOperationRequestRequestTypeDef#
# UpdateQueueHoursOfOperationRequestRequestTypeDef definition
class UpdateQueueHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
HoursOfOperationId: str,UpdateQueueMaxContactsRequestRequestTypeDef#
# UpdateQueueMaxContactsRequestRequestTypeDef definition
class UpdateQueueMaxContactsRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
MaxContacts: NotRequired[int],UpdateQueueNameRequestRequestTypeDef#
# UpdateQueueNameRequestRequestTypeDef definition
class UpdateQueueNameRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
Name: NotRequired[str],
Description: NotRequired[str],UpdateQueueStatusRequestRequestTypeDef#
# UpdateQueueStatusRequestRequestTypeDef definition
class UpdateQueueStatusRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
Status: QueueStatusType, # (1)- See QueueStatusType
UpdateQuickConnectNameRequestRequestTypeDef#
# UpdateQuickConnectNameRequestRequestTypeDef definition
class UpdateQuickConnectNameRequestRequestTypeDef(TypedDict):
InstanceId: str,
QuickConnectId: str,
Name: NotRequired[str],
Description: NotRequired[str],UpdateRoutingProfileAgentAvailabilityTimerRequestRequestTypeDef#
# UpdateRoutingProfileAgentAvailabilityTimerRequestRequestTypeDef definition
class UpdateRoutingProfileAgentAvailabilityTimerRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
AgentAvailabilityTimer: AgentAvailabilityTimerType, # (1)UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef#
# UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef definition
class UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
DefaultOutboundQueueId: str,UpdateRoutingProfileNameRequestRequestTypeDef#
# UpdateRoutingProfileNameRequestRequestTypeDef definition
class UpdateRoutingProfileNameRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
Name: NotRequired[str],
Description: NotRequired[str],UpdateSecurityProfileRequestRequestTypeDef#
# UpdateSecurityProfileRequestRequestTypeDef definition
class UpdateSecurityProfileRequestRequestTypeDef(TypedDict):
SecurityProfileId: str,
InstanceId: str,
Description: NotRequired[str],
Permissions: NotRequired[Sequence[str]],
AllowedAccessControlTags: NotRequired[Mapping[str, str]],
TagRestrictedResources: NotRequired[Sequence[str]],UpdateUserHierarchyGroupNameRequestRequestTypeDef#
# UpdateUserHierarchyGroupNameRequestRequestTypeDef definition
class UpdateUserHierarchyGroupNameRequestRequestTypeDef(TypedDict):
Name: str,
HierarchyGroupId: str,
InstanceId: str,UpdateUserHierarchyRequestRequestTypeDef#
# UpdateUserHierarchyRequestRequestTypeDef definition
class UpdateUserHierarchyRequestRequestTypeDef(TypedDict):
UserId: str,
InstanceId: str,
HierarchyGroupId: NotRequired[str],UpdateUserRoutingProfileRequestRequestTypeDef#
# UpdateUserRoutingProfileRequestRequestTypeDef definition
class UpdateUserRoutingProfileRequestRequestTypeDef(TypedDict):
RoutingProfileId: str,
UserId: str,
InstanceId: str,UpdateUserSecurityProfilesRequestRequestTypeDef#
# UpdateUserSecurityProfilesRequestRequestTypeDef definition
class UpdateUserSecurityProfilesRequestRequestTypeDef(TypedDict):
SecurityProfileIds: Sequence[str],
UserId: str,
InstanceId: str,UserReferenceTypeDef#
# UserReferenceTypeDef definition
class UserReferenceTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],UserIdentityInfoLiteTypeDef#
# UserIdentityInfoLiteTypeDef definition
class UserIdentityInfoLiteTypeDef(TypedDict):
FirstName: NotRequired[str],
LastName: NotRequired[str],RuleSummaryTypeDef#
# RuleSummaryTypeDef definition
class RuleSummaryTypeDef(TypedDict):
Name: str,
RuleId: str,
RuleArn: str,
EventSourceName: EventSourceNameType, # (1)
PublishStatus: RulePublishStatusType, # (2)
ActionSummaries: List[ActionSummaryTypeDef], # (3)
CreatedTime: datetime,
LastUpdatedTime: datetime,ActivateEvaluationFormResponseTypeDef#
# ActivateEvaluationFormResponseTypeDef definition
class ActivateEvaluationFormResponseTypeDef(TypedDict):
EvaluationFormId: str,
EvaluationFormArn: str,
EvaluationFormVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociateInstanceStorageConfigResponseTypeDef#
# AssociateInstanceStorageConfigResponseTypeDef definition
class AssociateInstanceStorageConfigResponseTypeDef(TypedDict):
AssociationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociateSecurityKeyResponseTypeDef#
# AssociateSecurityKeyResponseTypeDef definition
class AssociateSecurityKeyResponseTypeDef(TypedDict):
AssociationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ClaimPhoneNumberResponseTypeDef#
# ClaimPhoneNumberResponseTypeDef definition
class ClaimPhoneNumberResponseTypeDef(TypedDict):
PhoneNumberId: str,
PhoneNumberArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateAgentStatusResponseTypeDef#
# CreateAgentStatusResponseTypeDef definition
class CreateAgentStatusResponseTypeDef(TypedDict):
AgentStatusARN: str,
AgentStatusId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateContactFlowModuleResponseTypeDef#
# CreateContactFlowModuleResponseTypeDef definition
class CreateContactFlowModuleResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateContactFlowResponseTypeDef#
# CreateContactFlowResponseTypeDef definition
class CreateContactFlowResponseTypeDef(TypedDict):
ContactFlowId: str,
ContactFlowArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateEvaluationFormResponseTypeDef#
# CreateEvaluationFormResponseTypeDef definition
class CreateEvaluationFormResponseTypeDef(TypedDict):
EvaluationFormId: str,
EvaluationFormArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateHoursOfOperationResponseTypeDef#
# CreateHoursOfOperationResponseTypeDef definition
class CreateHoursOfOperationResponseTypeDef(TypedDict):
HoursOfOperationId: str,
HoursOfOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateInstanceResponseTypeDef#
# CreateInstanceResponseTypeDef definition
class CreateInstanceResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateIntegrationAssociationResponseTypeDef#
# CreateIntegrationAssociationResponseTypeDef definition
class CreateIntegrationAssociationResponseTypeDef(TypedDict):
IntegrationAssociationId: str,
IntegrationAssociationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreatePromptResponseTypeDef#
# CreatePromptResponseTypeDef definition
class CreatePromptResponseTypeDef(TypedDict):
PromptARN: str,
PromptId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateQueueResponseTypeDef#
# CreateQueueResponseTypeDef definition
class CreateQueueResponseTypeDef(TypedDict):
QueueArn: str,
QueueId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateQuickConnectResponseTypeDef#
# CreateQuickConnectResponseTypeDef definition
class CreateQuickConnectResponseTypeDef(TypedDict):
QuickConnectARN: str,
QuickConnectId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateRoutingProfileResponseTypeDef#
# CreateRoutingProfileResponseTypeDef definition
class CreateRoutingProfileResponseTypeDef(TypedDict):
RoutingProfileArn: str,
RoutingProfileId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateRuleResponseTypeDef#
# CreateRuleResponseTypeDef definition
class CreateRuleResponseTypeDef(TypedDict):
RuleArn: str,
RuleId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateSecurityProfileResponseTypeDef#
# CreateSecurityProfileResponseTypeDef definition
class CreateSecurityProfileResponseTypeDef(TypedDict):
SecurityProfileId: str,
SecurityProfileArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateTaskTemplateResponseTypeDef#
# CreateTaskTemplateResponseTypeDef definition
class CreateTaskTemplateResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateTrafficDistributionGroupResponseTypeDef#
# CreateTrafficDistributionGroupResponseTypeDef definition
class CreateTrafficDistributionGroupResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateUseCaseResponseTypeDef#
# CreateUseCaseResponseTypeDef definition
class CreateUseCaseResponseTypeDef(TypedDict):
UseCaseId: str,
UseCaseArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateUserHierarchyGroupResponseTypeDef#
# CreateUserHierarchyGroupResponseTypeDef definition
class CreateUserHierarchyGroupResponseTypeDef(TypedDict):
HierarchyGroupId: str,
HierarchyGroupArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateUserResponseTypeDef#
# CreateUserResponseTypeDef definition
class CreateUserResponseTypeDef(TypedDict):
UserId: str,
UserArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateVocabularyResponseTypeDef#
# CreateVocabularyResponseTypeDef definition
class CreateVocabularyResponseTypeDef(TypedDict):
VocabularyArn: str,
VocabularyId: str,
State: VocabularyStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeactivateEvaluationFormResponseTypeDef#
# DeactivateEvaluationFormResponseTypeDef definition
class DeactivateEvaluationFormResponseTypeDef(TypedDict):
EvaluationFormId: str,
EvaluationFormArn: str,
EvaluationFormVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DeleteVocabularyResponseTypeDef#
# DeleteVocabularyResponseTypeDef definition
class DeleteVocabularyResponseTypeDef(TypedDict):
VocabularyArn: str,
VocabularyId: str,
State: VocabularyStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetContactAttributesResponseTypeDef#
# GetContactAttributesResponseTypeDef definition
class GetContactAttributesResponseTypeDef(TypedDict):
Attributes: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetPromptFileResponseTypeDef#
# GetPromptFileResponseTypeDef definition
class GetPromptFileResponseTypeDef(TypedDict):
PromptPresignedUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListApprovedOriginsResponseTypeDef#
# ListApprovedOriginsResponseTypeDef definition
class ListApprovedOriginsResponseTypeDef(TypedDict):
Origins: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListLambdaFunctionsResponseTypeDef#
# ListLambdaFunctionsResponseTypeDef definition
class ListLambdaFunctionsResponseTypeDef(TypedDict):
LambdaFunctions: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListSecurityProfilePermissionsResponseTypeDef#
# ListSecurityProfilePermissionsResponseTypeDef definition
class ListSecurityProfilePermissionsResponseTypeDef(TypedDict):
Permissions: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)MonitorContactResponseTypeDef#
# MonitorContactResponseTypeDef definition
class MonitorContactResponseTypeDef(TypedDict):
ContactId: str,
ContactArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ReplicateInstanceResponseTypeDef#
# ReplicateInstanceResponseTypeDef definition
class ReplicateInstanceResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartChatContactResponseTypeDef#
# StartChatContactResponseTypeDef definition
class StartChatContactResponseTypeDef(TypedDict):
ContactId: str,
ParticipantId: str,
ParticipantToken: str,
ContinuedFromContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartContactEvaluationResponseTypeDef#
# StartContactEvaluationResponseTypeDef definition
class StartContactEvaluationResponseTypeDef(TypedDict):
EvaluationId: str,
EvaluationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartContactStreamingResponseTypeDef#
# StartContactStreamingResponseTypeDef definition
class StartContactStreamingResponseTypeDef(TypedDict):
StreamingId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartOutboundVoiceContactResponseTypeDef#
# StartOutboundVoiceContactResponseTypeDef definition
class StartOutboundVoiceContactResponseTypeDef(TypedDict):
ContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartTaskContactResponseTypeDef#
# StartTaskContactResponseTypeDef definition
class StartTaskContactResponseTypeDef(TypedDict):
ContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)SubmitContactEvaluationResponseTypeDef#
# SubmitContactEvaluationResponseTypeDef definition
class SubmitContactEvaluationResponseTypeDef(TypedDict):
EvaluationId: str,
EvaluationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)TransferContactResponseTypeDef#
# TransferContactResponseTypeDef definition
class TransferContactResponseTypeDef(TypedDict):
ContactId: str,
ContactArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateContactEvaluationResponseTypeDef#
# UpdateContactEvaluationResponseTypeDef definition
class UpdateContactEvaluationResponseTypeDef(TypedDict):
EvaluationId: str,
EvaluationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateEvaluationFormResponseTypeDef#
# UpdateEvaluationFormResponseTypeDef definition
class UpdateEvaluationFormResponseTypeDef(TypedDict):
EvaluationFormId: str,
EvaluationFormArn: str,
EvaluationFormVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdatePhoneNumberResponseTypeDef#
# UpdatePhoneNumberResponseTypeDef definition
class UpdatePhoneNumberResponseTypeDef(TypedDict):
PhoneNumberId: str,
PhoneNumberArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdatePromptResponseTypeDef#
# UpdatePromptResponseTypeDef definition
class UpdatePromptResponseTypeDef(TypedDict):
PromptARN: str,
PromptId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AgentConfigTypeDef#
# AgentConfigTypeDef definition
class AgentConfigTypeDef(TypedDict):
Distributions: List[DistributionTypeDef], # (1)TelephonyConfigTypeDef#
# TelephonyConfigTypeDef definition
class TelephonyConfigTypeDef(TypedDict):
Distributions: List[DistributionTypeDef], # (1)AgentContactReferenceTypeDef#
# AgentContactReferenceTypeDef definition
class AgentContactReferenceTypeDef(TypedDict):
ContactId: NotRequired[str],
Channel: NotRequired[ChannelType], # (1)
InitiationMethod: NotRequired[ContactInitiationMethodType], # (2)
AgentContactState: NotRequired[ContactStateType], # (3)
StateStartTimestamp: NotRequired[datetime],
ConnectedToAgentTimestamp: NotRequired[datetime],
Queue: NotRequired[QueueReferenceTypeDef], # (4)- See ChannelType
- See ContactInitiationMethodType
- See ContactStateType
- See QueueReferenceTypeDef
ListAgentStatusResponseTypeDef#
# ListAgentStatusResponseTypeDef definition
class ListAgentStatusResponseTypeDef(TypedDict):
NextToken: str,
AgentStatusSummaryList: List[AgentStatusSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeAgentStatusResponseTypeDef#
# DescribeAgentStatusResponseTypeDef definition
class DescribeAgentStatusResponseTypeDef(TypedDict):
AgentStatus: AgentStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)StartOutboundVoiceContactRequestRequestTypeDef#
# StartOutboundVoiceContactRequestRequestTypeDef definition
class StartOutboundVoiceContactRequestRequestTypeDef(TypedDict):
DestinationPhoneNumber: str,
ContactFlowId: str,
InstanceId: str,
ClientToken: NotRequired[str],
SourcePhoneNumber: NotRequired[str],
QueueId: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
AnswerMachineDetectionConfig: NotRequired[AnswerMachineDetectionConfigTypeDef], # (1)
CampaignId: NotRequired[str],
TrafficType: NotRequired[TrafficTypeType], # (2)AssociateLexBotRequestRequestTypeDef#
# AssociateLexBotRequestRequestTypeDef definition
class AssociateLexBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
LexBot: LexBotTypeDef, # (1)- See LexBotTypeDef
ListLexBotsResponseTypeDef#
# ListLexBotsResponseTypeDef definition
class ListLexBotsResponseTypeDef(TypedDict):
LexBots: List[LexBotTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See LexBotTypeDef
- See ResponseMetadataTypeDef
AssociateBotRequestRequestTypeDef#
# AssociateBotRequestRequestTypeDef definition
class AssociateBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
LexBot: NotRequired[LexBotTypeDef], # (1)
LexV2Bot: NotRequired[LexV2BotTypeDef], # (2)- See LexBotTypeDef
- See LexV2BotTypeDef
DisassociateBotRequestRequestTypeDef#
# DisassociateBotRequestRequestTypeDef definition
class DisassociateBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
LexBot: NotRequired[LexBotTypeDef], # (1)
LexV2Bot: NotRequired[LexV2BotTypeDef], # (2)- See LexBotTypeDef
- See LexV2BotTypeDef
LexBotConfigTypeDef#
# LexBotConfigTypeDef definition
class LexBotConfigTypeDef(TypedDict):
LexBot: NotRequired[LexBotTypeDef], # (1)
LexV2Bot: NotRequired[LexV2BotTypeDef], # (2)- See LexBotTypeDef
- See LexV2BotTypeDef
DescribeInstanceAttributeResponseTypeDef#
# DescribeInstanceAttributeResponseTypeDef definition
class DescribeInstanceAttributeResponseTypeDef(TypedDict):
Attribute: AttributeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListInstanceAttributesResponseTypeDef#
# ListInstanceAttributesResponseTypeDef definition
class ListInstanceAttributesResponseTypeDef(TypedDict):
Attributes: List[AttributeTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchAvailablePhoneNumbersResponseTypeDef#
# SearchAvailablePhoneNumbersResponseTypeDef definition
class SearchAvailablePhoneNumbersResponseTypeDef(TypedDict):
NextToken: str,
AvailableNumbersList: List[AvailableNumberSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)StartContactStreamingRequestRequestTypeDef#
# StartContactStreamingRequestRequestTypeDef definition
class StartContactStreamingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ChatStreamingConfiguration: ChatStreamingConfigurationTypeDef, # (1)
ClientToken: str,ClaimedPhoneNumberSummaryTypeDef#
# ClaimedPhoneNumberSummaryTypeDef definition
class ClaimedPhoneNumberSummaryTypeDef(TypedDict):
PhoneNumberId: NotRequired[str],
PhoneNumberArn: NotRequired[str],
PhoneNumber: NotRequired[str],
PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType], # (1)
PhoneNumberType: NotRequired[PhoneNumberTypeType], # (2)
PhoneNumberDescription: NotRequired[str],
TargetArn: NotRequired[str],
Tags: NotRequired[Dict[str, str]],
PhoneNumberStatus: NotRequired[PhoneNumberStatusTypeDef], # (3)UserDataFiltersTypeDef#
# UserDataFiltersTypeDef definition
class UserDataFiltersTypeDef(TypedDict):
Queues: NotRequired[Sequence[str]],
ContactFilter: NotRequired[ContactFilterTypeDef], # (1)
RoutingProfiles: NotRequired[Sequence[str]],
Agents: NotRequired[Sequence[str]],
UserHierarchyGroups: NotRequired[Sequence[str]],ListContactFlowModulesResponseTypeDef#
# ListContactFlowModulesResponseTypeDef definition
class ListContactFlowModulesResponseTypeDef(TypedDict):
ContactFlowModulesSummaryList: List[ContactFlowModuleSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeContactFlowModuleResponseTypeDef#
# DescribeContactFlowModuleResponseTypeDef definition
class DescribeContactFlowModuleResponseTypeDef(TypedDict):
ContactFlowModule: ContactFlowModuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListContactFlowsResponseTypeDef#
# ListContactFlowsResponseTypeDef definition
class ListContactFlowsResponseTypeDef(TypedDict):
ContactFlowSummaryList: List[ContactFlowSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeContactFlowResponseTypeDef#
# DescribeContactFlowResponseTypeDef definition
class DescribeContactFlowResponseTypeDef(TypedDict):
ContactFlow: ContactFlowTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ContactTypeDef#
# ContactTypeDef definition
class ContactTypeDef(TypedDict):
Arn: NotRequired[str],
Id: NotRequired[str],
InitialContactId: NotRequired[str],
PreviousContactId: NotRequired[str],
InitiationMethod: NotRequired[ContactInitiationMethodType], # (1)
Name: NotRequired[str],
Description: NotRequired[str],
Channel: NotRequired[ChannelType], # (2)
QueueInfo: NotRequired[QueueInfoTypeDef], # (3)
AgentInfo: NotRequired[AgentInfoTypeDef], # (4)
InitiationTimestamp: NotRequired[datetime],
DisconnectTimestamp: NotRequired[datetime],
LastUpdateTimestamp: NotRequired[datetime],
ScheduledTimestamp: NotRequired[datetime],
RelatedContactId: NotRequired[str],
WisdomInfo: NotRequired[WisdomInfoTypeDef], # (5)- See ContactInitiationMethodType
- See ChannelType
- See QueueInfoTypeDef
- See AgentInfoTypeDef
- See WisdomInfoTypeDef
ControlPlaneTagFilterTypeDef#
# ControlPlaneTagFilterTypeDef definition
class ControlPlaneTagFilterTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Sequence[TagConditionTypeDef]]], # (1)
AndConditions: NotRequired[Sequence[TagConditionTypeDef]], # (2)
TagCondition: NotRequired[TagConditionTypeDef], # (3)CreateEvaluationFormRequestRequestTypeDef#
# CreateEvaluationFormRequestRequestTypeDef definition
class CreateEvaluationFormRequestRequestTypeDef(TypedDict):
InstanceId: str,
Title: str,
Items: Sequence[EvaluationFormItemTypeDef], # (1)
Description: NotRequired[str],
ScoringStrategy: NotRequired[EvaluationFormScoringStrategyTypeDef], # (2)
ClientToken: NotRequired[str],EvaluationFormContentTypeDef#
# EvaluationFormContentTypeDef definition
class EvaluationFormContentTypeDef(TypedDict):
EvaluationFormVersion: int,
EvaluationFormId: str,
EvaluationFormArn: str,
Title: str,
Items: List[EvaluationFormItemTypeDef], # (1)
Description: NotRequired[str],
ScoringStrategy: NotRequired[EvaluationFormScoringStrategyTypeDef], # (2)EvaluationFormTypeDef#
# EvaluationFormTypeDef definition
class EvaluationFormTypeDef(TypedDict):
EvaluationFormId: str,
EvaluationFormVersion: int,
Locked: bool,
EvaluationFormArn: str,
Title: str,
Status: EvaluationFormVersionStatusType, # (1)
Items: List[EvaluationFormItemTypeDef], # (2)
CreatedTime: datetime,
CreatedBy: str,
LastModifiedTime: datetime,
LastModifiedBy: str,
Description: NotRequired[str],
ScoringStrategy: NotRequired[EvaluationFormScoringStrategyTypeDef], # (3)
Tags: NotRequired[Dict[str, str]],- See EvaluationFormVersionStatusType
- See EvaluationFormItemTypeDef
- See EvaluationFormScoringStrategyTypeDef
UpdateEvaluationFormRequestRequestTypeDef#
# UpdateEvaluationFormRequestRequestTypeDef definition
class UpdateEvaluationFormRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: int,
Title: str,
Items: Sequence[EvaluationFormItemTypeDef], # (1)
CreateNewVersion: NotRequired[bool],
Description: NotRequired[str],
ScoringStrategy: NotRequired[EvaluationFormScoringStrategyTypeDef], # (2)
ClientToken: NotRequired[str],CreateParticipantRequestRequestTypeDef#
# CreateParticipantRequestRequestTypeDef definition
class CreateParticipantRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ParticipantDetails: ParticipantDetailsToAddTypeDef, # (1)
ClientToken: NotRequired[str],CreateParticipantResponseTypeDef#
# CreateParticipantResponseTypeDef definition
class CreateParticipantResponseTypeDef(TypedDict):
ParticipantCredentials: ParticipantTokenCredentialsTypeDef, # (1)
ParticipantId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateQueueRequestRequestTypeDef#
# CreateQueueRequestRequestTypeDef definition
class CreateQueueRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
HoursOfOperationId: str,
Description: NotRequired[str],
OutboundCallerConfig: NotRequired[OutboundCallerConfigTypeDef], # (1)
MaxContacts: NotRequired[int],
QuickConnectIds: NotRequired[Sequence[str]],
Tags: NotRequired[Mapping[str, str]],QueueTypeDef#
# QueueTypeDef definition
class QueueTypeDef(TypedDict):
Name: NotRequired[str],
QueueArn: NotRequired[str],
QueueId: NotRequired[str],
Description: NotRequired[str],
OutboundCallerConfig: NotRequired[OutboundCallerConfigTypeDef], # (1)
HoursOfOperationId: NotRequired[str],
MaxContacts: NotRequired[int],
Status: NotRequired[QueueStatusType], # (2)
Tags: NotRequired[Dict[str, str]],UpdateQueueOutboundCallerConfigRequestRequestTypeDef#
# UpdateQueueOutboundCallerConfigRequestRequestTypeDef definition
class UpdateQueueOutboundCallerConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
OutboundCallerConfig: OutboundCallerConfigTypeDef, # (1)UpdateUserIdentityInfoRequestRequestTypeDef#
# UpdateUserIdentityInfoRequestRequestTypeDef definition
class UpdateUserIdentityInfoRequestRequestTypeDef(TypedDict):
IdentityInfo: UserIdentityInfoTypeDef, # (1)
UserId: str,
InstanceId: str,CreateUserRequestRequestTypeDef#
# CreateUserRequestRequestTypeDef definition
class CreateUserRequestRequestTypeDef(TypedDict):
Username: str,
PhoneConfig: UserPhoneConfigTypeDef, # (1)
SecurityProfileIds: Sequence[str],
RoutingProfileId: str,
InstanceId: str,
Password: NotRequired[str],
IdentityInfo: NotRequired[UserIdentityInfoTypeDef], # (2)
DirectoryUserId: NotRequired[str],
HierarchyGroupId: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],UpdateUserPhoneConfigRequestRequestTypeDef#
# UpdateUserPhoneConfigRequestRequestTypeDef definition
class UpdateUserPhoneConfigRequestRequestTypeDef(TypedDict):
PhoneConfig: UserPhoneConfigTypeDef, # (1)
UserId: str,
InstanceId: str,UserTypeDef#
# UserTypeDef definition
class UserTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Username: NotRequired[str],
IdentityInfo: NotRequired[UserIdentityInfoTypeDef], # (1)
PhoneConfig: NotRequired[UserPhoneConfigTypeDef], # (2)
DirectoryUserId: NotRequired[str],
SecurityProfileIds: NotRequired[List[str]],
RoutingProfileId: NotRequired[str],
HierarchyGroupId: NotRequired[str],
Tags: NotRequired[Dict[str, str]],GetFederationTokenResponseTypeDef#
# GetFederationTokenResponseTypeDef definition
class GetFederationTokenResponseTypeDef(TypedDict):
Credentials: CredentialsTypeDef, # (1)
SignInUrl: str,
UserArn: str,
UserId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)MediaConcurrencyTypeDef#
# MediaConcurrencyTypeDef definition
class MediaConcurrencyTypeDef(TypedDict):
Channel: ChannelType, # (1)
Concurrency: int,
CrossChannelBehavior: NotRequired[CrossChannelBehaviorTypeDef], # (2)CurrentMetricDataTypeDef#
# CurrentMetricDataTypeDef definition
class CurrentMetricDataTypeDef(TypedDict):
Metric: NotRequired[CurrentMetricTypeDef], # (1)
Value: NotRequired[float],ListDefaultVocabulariesResponseTypeDef#
# ListDefaultVocabulariesResponseTypeDef definition
class ListDefaultVocabulariesResponseTypeDef(TypedDict):
DefaultVocabularyList: List[DefaultVocabularyTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribePromptResponseTypeDef#
# DescribePromptResponseTypeDef definition
class DescribePromptResponseTypeDef(TypedDict):
Prompt: PromptTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See PromptTypeDef
- See ResponseMetadataTypeDef
SearchPromptsResponseTypeDef#
# SearchPromptsResponseTypeDef definition
class SearchPromptsResponseTypeDef(TypedDict):
Prompts: List[PromptTypeDef], # (1)
NextToken: str,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See PromptTypeDef
- See ResponseMetadataTypeDef
DescribeSecurityProfileResponseTypeDef#
# DescribeSecurityProfileResponseTypeDef definition
class DescribeSecurityProfileResponseTypeDef(TypedDict):
SecurityProfile: SecurityProfileTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeTrafficDistributionGroupResponseTypeDef#
# DescribeTrafficDistributionGroupResponseTypeDef definition
class DescribeTrafficDistributionGroupResponseTypeDef(TypedDict):
TrafficDistributionGroup: TrafficDistributionGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeVocabularyResponseTypeDef#
# DescribeVocabularyResponseTypeDef definition
class DescribeVocabularyResponseTypeDef(TypedDict):
Vocabulary: VocabularyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DimensionsTypeDef#
# DimensionsTypeDef definition
class DimensionsTypeDef(TypedDict):
Queue: NotRequired[QueueReferenceTypeDef], # (1)
Channel: NotRequired[ChannelType], # (2)
RoutingProfile: NotRequired[RoutingProfileReferenceTypeDef], # (3)DisassociateRoutingProfileQueuesRequestRequestTypeDef#
# DisassociateRoutingProfileQueuesRequestRequestTypeDef definition
class DisassociateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
QueueReferences: Sequence[RoutingProfileQueueReferenceTypeDef], # (1)RoutingProfileQueueConfigTypeDef#
# RoutingProfileQueueConfigTypeDef definition
class RoutingProfileQueueConfigTypeDef(TypedDict):
QueueReference: RoutingProfileQueueReferenceTypeDef, # (1)
Priority: int,
Delay: int,KinesisVideoStreamConfigTypeDef#
# KinesisVideoStreamConfigTypeDef definition
class KinesisVideoStreamConfigTypeDef(TypedDict):
Prefix: str,
RetentionPeriodHours: int,
EncryptionConfig: EncryptionConfigTypeDef, # (1)S3ConfigTypeDef#
# S3ConfigTypeDef definition
class S3ConfigTypeDef(TypedDict):
BucketName: str,
BucketPrefix: str,
EncryptionConfig: NotRequired[EncryptionConfigTypeDef], # (1)EvaluationAnswerInputTypeDef#
# EvaluationAnswerInputTypeDef definition
class EvaluationAnswerInputTypeDef(TypedDict):
Value: NotRequired[EvaluationAnswerDataTypeDef], # (1)EvaluationAnswerOutputTypeDef#
# EvaluationAnswerOutputTypeDef definition
class EvaluationAnswerOutputTypeDef(TypedDict):
Value: NotRequired[EvaluationAnswerDataTypeDef], # (1)
SystemSuggestedValue: NotRequired[EvaluationAnswerDataTypeDef], # (1)EvaluationFormNumericQuestionAutomationTypeDef#
# EvaluationFormNumericQuestionAutomationTypeDef definition
class EvaluationFormNumericQuestionAutomationTypeDef(TypedDict):
PropertyValue: NotRequired[NumericQuestionPropertyValueAutomationTypeDef], # (1)EvaluationFormSingleSelectQuestionAutomationOptionTypeDef#
# EvaluationFormSingleSelectQuestionAutomationOptionTypeDef definition
class EvaluationFormSingleSelectQuestionAutomationOptionTypeDef(TypedDict):
RuleCategory: NotRequired[SingleSelectQuestionRuleCategoryAutomationTypeDef], # (1)ListEvaluationFormsResponseTypeDef#
# ListEvaluationFormsResponseTypeDef definition
class ListEvaluationFormsResponseTypeDef(TypedDict):
EvaluationFormSummaryList: List[EvaluationFormSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListEvaluationFormVersionsResponseTypeDef#
# ListEvaluationFormVersionsResponseTypeDef definition
class ListEvaluationFormVersionsResponseTypeDef(TypedDict):
EvaluationFormVersionSummaryList: List[EvaluationFormVersionSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)EvaluationMetadataTypeDef#
# EvaluationMetadataTypeDef definition
class EvaluationMetadataTypeDef(TypedDict):
ContactId: str,
EvaluatorArn: str,
ContactAgentId: NotRequired[str],
Score: NotRequired[EvaluationScoreTypeDef], # (1)EvaluationSummaryTypeDef#
# EvaluationSummaryTypeDef definition
class EvaluationSummaryTypeDef(TypedDict):
EvaluationId: str,
EvaluationArn: str,
EvaluationFormTitle: str,
EvaluationFormId: str,
Status: EvaluationStatusType, # (1)
EvaluatorArn: str,
CreatedTime: datetime,
LastModifiedTime: datetime,
Score: NotRequired[EvaluationScoreTypeDef], # (2)GetCurrentMetricDataRequestRequestTypeDef#
# GetCurrentMetricDataRequestRequestTypeDef definition
class GetCurrentMetricDataRequestRequestTypeDef(TypedDict):
InstanceId: str,
Filters: FiltersTypeDef, # (1)
CurrentMetrics: Sequence[CurrentMetricTypeDef], # (2)
Groupings: NotRequired[Sequence[GroupingType]], # (3)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SortCriteria: NotRequired[Sequence[CurrentMetricSortCriteriaTypeDef]], # (4)ListAgentStatusRequestListAgentStatusesPaginateTypeDef#
# ListAgentStatusRequestListAgentStatusesPaginateTypeDef definition
class ListAgentStatusRequestListAgentStatusesPaginateTypeDef(TypedDict):
InstanceId: str,
AgentStatusTypes: NotRequired[Sequence[AgentStatusTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListApprovedOriginsRequestListApprovedOriginsPaginateTypeDef#
# ListApprovedOriginsRequestListApprovedOriginsPaginateTypeDef definition
class ListApprovedOriginsRequestListApprovedOriginsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListBotsRequestListBotsPaginateTypeDef#
# ListBotsRequestListBotsPaginateTypeDef definition
class ListBotsRequestListBotsPaginateTypeDef(TypedDict):
InstanceId: str,
LexVersion: LexVersionType, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See LexVersionType
- See PaginatorConfigTypeDef
ListContactEvaluationsRequestListContactEvaluationsPaginateTypeDef#
# ListContactEvaluationsRequestListContactEvaluationsPaginateTypeDef definition
class ListContactEvaluationsRequestListContactEvaluationsPaginateTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListContactFlowModulesRequestListContactFlowModulesPaginateTypeDef#
# ListContactFlowModulesRequestListContactFlowModulesPaginateTypeDef definition
class ListContactFlowModulesRequestListContactFlowModulesPaginateTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleState: NotRequired[ContactFlowModuleStateType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListContactFlowsRequestListContactFlowsPaginateTypeDef#
# ListContactFlowsRequestListContactFlowsPaginateTypeDef definition
class ListContactFlowsRequestListContactFlowsPaginateTypeDef(TypedDict):
InstanceId: str,
ContactFlowTypes: NotRequired[Sequence[ContactFlowTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListContactReferencesRequestListContactReferencesPaginateTypeDef#
# ListContactReferencesRequestListContactReferencesPaginateTypeDef definition
class ListContactReferencesRequestListContactReferencesPaginateTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ReferenceTypes: Sequence[ReferenceTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateTypeDef#
# ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateTypeDef definition
class ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateTypeDef(TypedDict):
InstanceId: str,
LanguageCode: NotRequired[VocabularyLanguageCodeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListEvaluationFormVersionsRequestListEvaluationFormVersionsPaginateTypeDef#
# ListEvaluationFormVersionsRequestListEvaluationFormVersionsPaginateTypeDef definition
class ListEvaluationFormVersionsRequestListEvaluationFormVersionsPaginateTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListEvaluationFormsRequestListEvaluationFormsPaginateTypeDef#
# ListEvaluationFormsRequestListEvaluationFormsPaginateTypeDef definition
class ListEvaluationFormsRequestListEvaluationFormsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListHoursOfOperationsRequestListHoursOfOperationsPaginateTypeDef#
# ListHoursOfOperationsRequestListHoursOfOperationsPaginateTypeDef definition
class ListHoursOfOperationsRequestListHoursOfOperationsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListInstanceAttributesRequestListInstanceAttributesPaginateTypeDef#
# ListInstanceAttributesRequestListInstanceAttributesPaginateTypeDef definition
class ListInstanceAttributesRequestListInstanceAttributesPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateTypeDef#
# ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateTypeDef definition
class ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateTypeDef(TypedDict):
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListInstancesRequestListInstancesPaginateTypeDef#
# ListInstancesRequestListInstancesPaginateTypeDef definition
class ListInstancesRequestListInstancesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateTypeDef#
# ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateTypeDef definition
class ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateTypeDef(TypedDict):
InstanceId: str,
IntegrationType: NotRequired[IntegrationTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListLambdaFunctionsRequestListLambdaFunctionsPaginateTypeDef#
# ListLambdaFunctionsRequestListLambdaFunctionsPaginateTypeDef definition
class ListLambdaFunctionsRequestListLambdaFunctionsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListLexBotsRequestListLexBotsPaginateTypeDef#
# ListLexBotsRequestListLexBotsPaginateTypeDef definition
class ListLexBotsRequestListLexBotsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPhoneNumbersRequestListPhoneNumbersPaginateTypeDef#
# ListPhoneNumbersRequestListPhoneNumbersPaginateTypeDef definition
class ListPhoneNumbersRequestListPhoneNumbersPaginateTypeDef(TypedDict):
InstanceId: str,
PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]], # (1)
PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateTypeDef#
# ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateTypeDef definition
class ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateTypeDef(TypedDict):
TargetArn: NotRequired[str],
PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]], # (1)
PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]], # (2)
PhoneNumberPrefix: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)ListPromptsRequestListPromptsPaginateTypeDef#
# ListPromptsRequestListPromptsPaginateTypeDef definition
class ListPromptsRequestListPromptsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateTypeDef#
# ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateTypeDef definition
class ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListQueuesRequestListQueuesPaginateTypeDef#
# ListQueuesRequestListQueuesPaginateTypeDef definition
class ListQueuesRequestListQueuesPaginateTypeDef(TypedDict):
InstanceId: str,
QueueTypes: NotRequired[Sequence[QueueTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See QueueTypeType
- See PaginatorConfigTypeDef
ListQuickConnectsRequestListQuickConnectsPaginateTypeDef#
# ListQuickConnectsRequestListQuickConnectsPaginateTypeDef definition
class ListQuickConnectsRequestListQuickConnectsPaginateTypeDef(TypedDict):
InstanceId: str,
QuickConnectTypes: NotRequired[Sequence[QuickConnectTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateTypeDef#
# ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateTypeDef definition
class ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListRoutingProfilesRequestListRoutingProfilesPaginateTypeDef#
# ListRoutingProfilesRequestListRoutingProfilesPaginateTypeDef definition
class ListRoutingProfilesRequestListRoutingProfilesPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListRulesRequestListRulesPaginateTypeDef#
# ListRulesRequestListRulesPaginateTypeDef definition
class ListRulesRequestListRulesPaginateTypeDef(TypedDict):
InstanceId: str,
PublishStatus: NotRequired[RulePublishStatusType], # (1)
EventSourceName: NotRequired[EventSourceNameType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)ListSecurityKeysRequestListSecurityKeysPaginateTypeDef#
# ListSecurityKeysRequestListSecurityKeysPaginateTypeDef definition
class ListSecurityKeysRequestListSecurityKeysPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateTypeDef#
# ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateTypeDef definition
class ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateTypeDef(TypedDict):
SecurityProfileId: str,
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef#
# ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef definition
class ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListTaskTemplatesRequestListTaskTemplatesPaginateTypeDef#
# ListTaskTemplatesRequestListTaskTemplatesPaginateTypeDef definition
class ListTaskTemplatesRequestListTaskTemplatesPaginateTypeDef(TypedDict):
InstanceId: str,
Status: NotRequired[TaskTemplateStatusType], # (1)
Name: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListTrafficDistributionGroupUsersRequestListTrafficDistributionGroupUsersPaginateTypeDef#
# ListTrafficDistributionGroupUsersRequestListTrafficDistributionGroupUsersPaginateTypeDef definition
class ListTrafficDistributionGroupUsersRequestListTrafficDistributionGroupUsersPaginateTypeDef(TypedDict):
TrafficDistributionGroupId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateTypeDef#
# ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateTypeDef definition
class ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateTypeDef(TypedDict):
InstanceId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListUseCasesRequestListUseCasesPaginateTypeDef#
# ListUseCasesRequestListUseCasesPaginateTypeDef definition
class ListUseCasesRequestListUseCasesPaginateTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateTypeDef#
# ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateTypeDef definition
class ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListUsersRequestListUsersPaginateTypeDef#
# ListUsersRequestListUsersPaginateTypeDef definition
class ListUsersRequestListUsersPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateTypeDef#
# SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateTypeDef definition
class SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateTypeDef(TypedDict):
TargetArn: str,
PhoneNumberCountryCode: PhoneNumberCountryCodeType, # (1)
PhoneNumberType: PhoneNumberTypeType, # (2)
PhoneNumberPrefix: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)SearchVocabulariesRequestSearchVocabulariesPaginateTypeDef#
# SearchVocabulariesRequestSearchVocabulariesPaginateTypeDef definition
class SearchVocabulariesRequestSearchVocabulariesPaginateTypeDef(TypedDict):
InstanceId: str,
State: NotRequired[VocabularyStateType], # (1)
NameStartsWith: NotRequired[str],
LanguageCode: NotRequired[VocabularyLanguageCodeType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)UpdateContactScheduleRequestRequestTypeDef#
# UpdateContactScheduleRequestRequestTypeDef definition
class UpdateContactScheduleRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ScheduledTime: Union[datetime, str],HierarchyPathReferenceTypeDef#
# HierarchyPathReferenceTypeDef definition
class HierarchyPathReferenceTypeDef(TypedDict):
LevelOne: NotRequired[HierarchyGroupSummaryReferenceTypeDef], # (1)
LevelTwo: NotRequired[HierarchyGroupSummaryReferenceTypeDef], # (1)
LevelThree: NotRequired[HierarchyGroupSummaryReferenceTypeDef], # (1)
LevelFour: NotRequired[HierarchyGroupSummaryReferenceTypeDef], # (1)
LevelFive: NotRequired[HierarchyGroupSummaryReferenceTypeDef], # (1)- See HierarchyGroupSummaryReferenceTypeDef
- See HierarchyGroupSummaryReferenceTypeDef
- See HierarchyGroupSummaryReferenceTypeDef
- See HierarchyGroupSummaryReferenceTypeDef
- See HierarchyGroupSummaryReferenceTypeDef
HierarchyPathTypeDef#
# HierarchyPathTypeDef definition
class HierarchyPathTypeDef(TypedDict):
LevelOne: NotRequired[HierarchyGroupSummaryTypeDef], # (1)
LevelTwo: NotRequired[HierarchyGroupSummaryTypeDef], # (1)
LevelThree: NotRequired[HierarchyGroupSummaryTypeDef], # (1)
LevelFour: NotRequired[HierarchyGroupSummaryTypeDef], # (1)
LevelFive: NotRequired[HierarchyGroupSummaryTypeDef], # (1)- See HierarchyGroupSummaryTypeDef
- See HierarchyGroupSummaryTypeDef
- See HierarchyGroupSummaryTypeDef
- See HierarchyGroupSummaryTypeDef
- See HierarchyGroupSummaryTypeDef
ListUserHierarchyGroupsResponseTypeDef#
# ListUserHierarchyGroupsResponseTypeDef definition
class ListUserHierarchyGroupsResponseTypeDef(TypedDict):
UserHierarchyGroupSummaryList: List[HierarchyGroupSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)HierarchyStructureTypeDef#
# HierarchyStructureTypeDef definition
class HierarchyStructureTypeDef(TypedDict):
LevelOne: NotRequired[HierarchyLevelTypeDef], # (1)
LevelTwo: NotRequired[HierarchyLevelTypeDef], # (1)
LevelThree: NotRequired[HierarchyLevelTypeDef], # (1)
LevelFour: NotRequired[HierarchyLevelTypeDef], # (1)
LevelFive: NotRequired[HierarchyLevelTypeDef], # (1)- See HierarchyLevelTypeDef
- See HierarchyLevelTypeDef
- See HierarchyLevelTypeDef
- See HierarchyLevelTypeDef
- See HierarchyLevelTypeDef
HierarchyStructureUpdateTypeDef#
# HierarchyStructureUpdateTypeDef definition
class HierarchyStructureUpdateTypeDef(TypedDict):
LevelOne: NotRequired[HierarchyLevelUpdateTypeDef], # (1)
LevelTwo: NotRequired[HierarchyLevelUpdateTypeDef], # (1)
LevelThree: NotRequired[HierarchyLevelUpdateTypeDef], # (1)
LevelFour: NotRequired[HierarchyLevelUpdateTypeDef], # (1)
LevelFive: NotRequired[HierarchyLevelUpdateTypeDef], # (1)- See HierarchyLevelUpdateTypeDef
- See HierarchyLevelUpdateTypeDef
- See HierarchyLevelUpdateTypeDef
- See HierarchyLevelUpdateTypeDef
- See HierarchyLevelUpdateTypeDef
HistoricalMetricTypeDef#
# HistoricalMetricTypeDef definition
class HistoricalMetricTypeDef(TypedDict):
Name: NotRequired[HistoricalMetricNameType], # (1)
Threshold: NotRequired[ThresholdTypeDef], # (2)
Statistic: NotRequired[StatisticType], # (3)
Unit: NotRequired[UnitType], # (4)- See HistoricalMetricNameType
- See ThresholdTypeDef
- See StatisticType
- See UnitType
HoursOfOperationConfigTypeDef#
# HoursOfOperationConfigTypeDef definition
class HoursOfOperationConfigTypeDef(TypedDict):
Day: HoursOfOperationDaysType, # (1)
StartTime: HoursOfOperationTimeSliceTypeDef, # (2)
EndTime: HoursOfOperationTimeSliceTypeDef, # (2)- See HoursOfOperationDaysType
- See HoursOfOperationTimeSliceTypeDef
- See HoursOfOperationTimeSliceTypeDef
HoursOfOperationSearchCriteriaTypeDef#
# HoursOfOperationSearchCriteriaTypeDef definition
class HoursOfOperationSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[HoursOfOperationSearchCriteriaTypeDef]], # (1)
AndConditions: NotRequired[Sequence[HoursOfOperationSearchCriteriaTypeDef]], # (1)
StringCondition: NotRequired[StringConditionTypeDef], # (3)- See HoursOfOperationSearchCriteriaTypeDef
- See HoursOfOperationSearchCriteriaTypeDef
- See StringConditionTypeDef
PromptSearchCriteriaTypeDef#
# PromptSearchCriteriaTypeDef definition
class PromptSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[PromptSearchCriteriaTypeDef]], # (1)
AndConditions: NotRequired[Sequence[PromptSearchCriteriaTypeDef]], # (1)
StringCondition: NotRequired[StringConditionTypeDef], # (3)QueueSearchCriteriaTypeDef#
# QueueSearchCriteriaTypeDef definition
class QueueSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[QueueSearchCriteriaTypeDef]], # (1)
AndConditions: NotRequired[Sequence[QueueSearchCriteriaTypeDef]], # (1)
StringCondition: NotRequired[StringConditionTypeDef], # (3)
QueueTypeCondition: NotRequired[SearchableQueueTypeType], # (4)- See QueueSearchCriteriaTypeDef
- See QueueSearchCriteriaTypeDef
- See StringConditionTypeDef
- See SearchableQueueTypeType
QuickConnectSearchCriteriaTypeDef#
# QuickConnectSearchCriteriaTypeDef definition
class QuickConnectSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[QuickConnectSearchCriteriaTypeDef]], # (1)
AndConditions: NotRequired[Sequence[QuickConnectSearchCriteriaTypeDef]], # (1)
StringCondition: NotRequired[StringConditionTypeDef], # (3)- See QuickConnectSearchCriteriaTypeDef
- See QuickConnectSearchCriteriaTypeDef
- See StringConditionTypeDef
RoutingProfileSearchCriteriaTypeDef#
# RoutingProfileSearchCriteriaTypeDef definition
class RoutingProfileSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[RoutingProfileSearchCriteriaTypeDef]], # (1)
AndConditions: NotRequired[Sequence[RoutingProfileSearchCriteriaTypeDef]], # (1)
StringCondition: NotRequired[StringConditionTypeDef], # (3)- See RoutingProfileSearchCriteriaTypeDef
- See RoutingProfileSearchCriteriaTypeDef
- See StringConditionTypeDef
SecurityProfileSearchCriteriaTypeDef#
# SecurityProfileSearchCriteriaTypeDef definition
class SecurityProfileSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[SecurityProfileSearchCriteriaTypeDef]], # (1)
AndConditions: NotRequired[Sequence[SecurityProfileSearchCriteriaTypeDef]], # (1)
StringCondition: NotRequired[StringConditionTypeDef], # (3)- See SecurityProfileSearchCriteriaTypeDef
- See SecurityProfileSearchCriteriaTypeDef
- See StringConditionTypeDef
UserSearchCriteriaTypeDef#
# UserSearchCriteriaTypeDef definition
class UserSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[UserSearchCriteriaTypeDef]], # (1)
AndConditions: NotRequired[Sequence[UserSearchCriteriaTypeDef]], # (1)
StringCondition: NotRequired[StringConditionTypeDef], # (3)
HierarchyGroupCondition: NotRequired[HierarchyGroupConditionTypeDef], # (4)- See UserSearchCriteriaTypeDef
- See UserSearchCriteriaTypeDef
- See StringConditionTypeDef
- See HierarchyGroupConditionTypeDef
ListHoursOfOperationsResponseTypeDef#
# ListHoursOfOperationsResponseTypeDef definition
class ListHoursOfOperationsResponseTypeDef(TypedDict):
HoursOfOperationSummaryList: List[HoursOfOperationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)InstanceTypeDef#
# InstanceTypeDef definition
class InstanceTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
IdentityManagementType: NotRequired[DirectoryTypeType], # (1)
InstanceAlias: NotRequired[str],
CreatedTime: NotRequired[datetime],
ServiceRole: NotRequired[str],
InstanceStatus: NotRequired[InstanceStatusType], # (2)
StatusReason: NotRequired[InstanceStatusReasonTypeDef], # (3)
InboundCallsEnabled: NotRequired[bool],
OutboundCallsEnabled: NotRequired[bool],
InstanceAccessUrl: NotRequired[str],ListInstancesResponseTypeDef#
# ListInstancesResponseTypeDef definition
class ListInstancesResponseTypeDef(TypedDict):
InstanceSummaryList: List[InstanceSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListIntegrationAssociationsResponseTypeDef#
# ListIntegrationAssociationsResponseTypeDef definition
class ListIntegrationAssociationsResponseTypeDef(TypedDict):
IntegrationAssociationSummaryList: List[IntegrationAssociationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)InvisibleFieldInfoTypeDef#
# InvisibleFieldInfoTypeDef definition
class InvisibleFieldInfoTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)ReadOnlyFieldInfoTypeDef#
# ReadOnlyFieldInfoTypeDef definition
class ReadOnlyFieldInfoTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)RequiredFieldInfoTypeDef#
# RequiredFieldInfoTypeDef definition
class RequiredFieldInfoTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)TaskTemplateDefaultFieldValueTypeDef#
# TaskTemplateDefaultFieldValueTypeDef definition
class TaskTemplateDefaultFieldValueTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)
DefaultValue: NotRequired[str],TaskTemplateFieldTypeDef#
# TaskTemplateFieldTypeDef definition
class TaskTemplateFieldTypeDef(TypedDict):
Id: TaskTemplateFieldIdentifierTypeDef, # (1)
Description: NotRequired[str],
Type: NotRequired[TaskTemplateFieldTypeType], # (2)
SingleSelectOptions: NotRequired[Sequence[str]],ListPhoneNumbersResponseTypeDef#
# ListPhoneNumbersResponseTypeDef definition
class ListPhoneNumbersResponseTypeDef(TypedDict):
PhoneNumberSummaryList: List[PhoneNumberSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListPhoneNumbersV2ResponseTypeDef#
# ListPhoneNumbersV2ResponseTypeDef definition
class ListPhoneNumbersV2ResponseTypeDef(TypedDict):
NextToken: str,
ListPhoneNumbersSummaryList: List[ListPhoneNumbersSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListPromptsResponseTypeDef#
# ListPromptsResponseTypeDef definition
class ListPromptsResponseTypeDef(TypedDict):
PromptSummaryList: List[PromptSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListQueueQuickConnectsResponseTypeDef#
# ListQueueQuickConnectsResponseTypeDef definition
class ListQueueQuickConnectsResponseTypeDef(TypedDict):
NextToken: str,
QuickConnectSummaryList: List[QuickConnectSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListQuickConnectsResponseTypeDef#
# ListQuickConnectsResponseTypeDef definition
class ListQuickConnectsResponseTypeDef(TypedDict):
QuickConnectSummaryList: List[QuickConnectSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListQueuesResponseTypeDef#
# ListQueuesResponseTypeDef definition
class ListQueuesResponseTypeDef(TypedDict):
QueueSummaryList: List[QueueSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListRoutingProfileQueuesResponseTypeDef#
# ListRoutingProfileQueuesResponseTypeDef definition
class ListRoutingProfileQueuesResponseTypeDef(TypedDict):
NextToken: str,
RoutingProfileQueueConfigSummaryList: List[RoutingProfileQueueConfigSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListRoutingProfilesResponseTypeDef#
# ListRoutingProfilesResponseTypeDef definition
class ListRoutingProfilesResponseTypeDef(TypedDict):
RoutingProfileSummaryList: List[RoutingProfileSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListSecurityKeysResponseTypeDef#
# ListSecurityKeysResponseTypeDef definition
class ListSecurityKeysResponseTypeDef(TypedDict):
SecurityKeys: List[SecurityKeyTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListSecurityProfilesResponseTypeDef#
# ListSecurityProfilesResponseTypeDef definition
class ListSecurityProfilesResponseTypeDef(TypedDict):
SecurityProfileSummaryList: List[SecurityProfileSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListTaskTemplatesResponseTypeDef#
# ListTaskTemplatesResponseTypeDef definition
class ListTaskTemplatesResponseTypeDef(TypedDict):
TaskTemplates: List[TaskTemplateMetadataTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListTrafficDistributionGroupUsersResponseTypeDef#
# ListTrafficDistributionGroupUsersResponseTypeDef definition
class ListTrafficDistributionGroupUsersResponseTypeDef(TypedDict):
NextToken: str,
TrafficDistributionGroupUserSummaryList: List[TrafficDistributionGroupUserSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListTrafficDistributionGroupsResponseTypeDef#
# ListTrafficDistributionGroupsResponseTypeDef definition
class ListTrafficDistributionGroupsResponseTypeDef(TypedDict):
NextToken: str,
TrafficDistributionGroupSummaryList: List[TrafficDistributionGroupSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListUseCasesResponseTypeDef#
# ListUseCasesResponseTypeDef definition
class ListUseCasesResponseTypeDef(TypedDict):
UseCaseSummaryList: List[UseCaseTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListUsersResponseTypeDef#
# ListUsersResponseTypeDef definition
class ListUsersResponseTypeDef(TypedDict):
UserSummaryList: List[UserSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)MetricV2TypeDef#
# MetricV2TypeDef definition
class MetricV2TypeDef(TypedDict):
Name: NotRequired[str],
Threshold: NotRequired[Sequence[ThresholdV2TypeDef]], # (1)
MetricFilters: NotRequired[Sequence[MetricFilterV2TypeDef]], # (2)SendNotificationActionDefinitionTypeDef#
# SendNotificationActionDefinitionTypeDef definition
class SendNotificationActionDefinitionTypeDef(TypedDict):
DeliveryMethod: NotificationDeliveryTypeType, # (1)
Content: str,
ContentType: NotificationContentTypeType, # (2)
Recipient: NotificationRecipientTypeTypeDef, # (3)
Subject: NotRequired[str],- See NotificationDeliveryTypeType
- See NotificationContentTypeType
- See NotificationRecipientTypeTypeDef
ParticipantTimerConfigurationTypeDef#
# ParticipantTimerConfigurationTypeDef definition
class ParticipantTimerConfigurationTypeDef(TypedDict):
ParticipantRole: TimerEligibleParticipantRolesType, # (1)
TimerType: ParticipantTimerTypeType, # (2)
TimerValue: ParticipantTimerValueTypeDef, # (3)StartChatContactRequestRequestTypeDef#
# StartChatContactRequestRequestTypeDef definition
class StartChatContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,
ParticipantDetails: ParticipantDetailsTypeDef, # (1)
Attributes: NotRequired[Mapping[str, str]],
InitialMessage: NotRequired[ChatMessageTypeDef], # (2)
ClientToken: NotRequired[str],
ChatDurationInMinutes: NotRequired[int],
SupportedMessagingContentTypes: NotRequired[Sequence[str]],
PersistentChat: NotRequired[PersistentChatTypeDef], # (3)
RelatedContactId: NotRequired[str],QuickConnectConfigTypeDef#
# QuickConnectConfigTypeDef definition
class QuickConnectConfigTypeDef(TypedDict):
QuickConnectType: QuickConnectTypeType, # (1)
UserConfig: NotRequired[UserQuickConnectConfigTypeDef], # (2)
QueueConfig: NotRequired[QueueQuickConnectConfigTypeDef], # (3)
PhoneConfig: NotRequired[PhoneNumberQuickConnectConfigTypeDef], # (4)- See QuickConnectTypeType
- See UserQuickConnectConfigTypeDef
- See QueueQuickConnectConfigTypeDef
- See PhoneNumberQuickConnectConfigTypeDef
ReferenceSummaryTypeDef#
# ReferenceSummaryTypeDef definition
class ReferenceSummaryTypeDef(TypedDict):
Url: NotRequired[UrlReferenceTypeDef], # (1)
Attachment: NotRequired[AttachmentReferenceTypeDef], # (2)
String: NotRequired[StringReferenceTypeDef], # (3)
Number: NotRequired[NumberReferenceTypeDef], # (4)
Date: NotRequired[DateReferenceTypeDef], # (5)
Email: NotRequired[EmailReferenceTypeDef], # (6)- See UrlReferenceTypeDef
- See AttachmentReferenceTypeDef
- See StringReferenceTypeDef
- See NumberReferenceTypeDef
- See DateReferenceTypeDef
- See EmailReferenceTypeDef
StartTaskContactRequestRequestTypeDef#
# StartTaskContactRequestRequestTypeDef definition
class StartTaskContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
PreviousContactId: NotRequired[str],
ContactFlowId: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
References: NotRequired[Mapping[str, ReferenceTypeDef]], # (1)
Description: NotRequired[str],
ClientToken: NotRequired[str],
ScheduledTime: NotRequired[Union[datetime, str]],
TaskTemplateId: NotRequired[str],
QuickConnectId: NotRequired[str],
RelatedContactId: NotRequired[str],- See ReferenceTypeDef
TaskActionDefinitionTypeDef#
# TaskActionDefinitionTypeDef definition
class TaskActionDefinitionTypeDef(TypedDict):
Name: str,
ContactFlowId: str,
Description: NotRequired[str],
References: NotRequired[Mapping[str, ReferenceTypeDef]], # (1)- See ReferenceTypeDef
UpdateContactRequestRequestTypeDef#
# UpdateContactRequestRequestTypeDef definition
class UpdateContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
Name: NotRequired[str],
Description: NotRequired[str],
References: NotRequired[Mapping[str, ReferenceTypeDef]], # (1)- See ReferenceTypeDef
ResourceTagsSearchCriteriaTypeDef#
# ResourceTagsSearchCriteriaTypeDef definition
class ResourceTagsSearchCriteriaTypeDef(TypedDict):
TagSearchCondition: NotRequired[TagSearchConditionTypeDef], # (1)SearchResourceTagsResponseTypeDef#
# SearchResourceTagsResponseTypeDef definition
class SearchResourceTagsResponseTypeDef(TypedDict):
Tags: List[TagSetTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See TagSetTypeDef
- See ResponseMetadataTypeDef
SearchSecurityProfilesResponseTypeDef#
# SearchSecurityProfilesResponseTypeDef definition
class SearchSecurityProfilesResponseTypeDef(TypedDict):
SecurityProfiles: List[SecurityProfileSearchSummaryTypeDef], # (1)
NextToken: str,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchVocabulariesResponseTypeDef#
# SearchVocabulariesResponseTypeDef definition
class SearchVocabulariesResponseTypeDef(TypedDict):
VocabularySummaryList: List[VocabularySummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)SignInConfigTypeDef#
# SignInConfigTypeDef definition
class SignInConfigTypeDef(TypedDict):
Distributions: List[SignInDistributionTypeDef], # (1)StartContactRecordingRequestRequestTypeDef#
# StartContactRecordingRequestRequestTypeDef definition
class StartContactRecordingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
InitialContactId: str,
VoiceRecordingConfiguration: VoiceRecordingConfigurationTypeDef, # (1)UserSearchSummaryTypeDef#
# UserSearchSummaryTypeDef definition
class UserSearchSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
DirectoryUserId: NotRequired[str],
HierarchyGroupId: NotRequired[str],
Id: NotRequired[str],
IdentityInfo: NotRequired[UserIdentityInfoLiteTypeDef], # (1)
PhoneConfig: NotRequired[UserPhoneConfigTypeDef], # (2)
RoutingProfileId: NotRequired[str],
SecurityProfileIds: NotRequired[List[str]],
Tags: NotRequired[Dict[str, str]],
Username: NotRequired[str],ListRulesResponseTypeDef#
# ListRulesResponseTypeDef definition
class ListRulesResponseTypeDef(TypedDict):
RuleSummaryList: List[RuleSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListBotsResponseTypeDef#
# ListBotsResponseTypeDef definition
class ListBotsResponseTypeDef(TypedDict):
LexBots: List[LexBotConfigTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribePhoneNumberResponseTypeDef#
# DescribePhoneNumberResponseTypeDef definition
class DescribePhoneNumberResponseTypeDef(TypedDict):
ClaimedPhoneNumberSummary: ClaimedPhoneNumberSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetCurrentUserDataRequestRequestTypeDef#
# GetCurrentUserDataRequestRequestTypeDef definition
class GetCurrentUserDataRequestRequestTypeDef(TypedDict):
InstanceId: str,
Filters: UserDataFiltersTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],DescribeContactResponseTypeDef#
# DescribeContactResponseTypeDef definition
class DescribeContactResponseTypeDef(TypedDict):
Contact: ContactTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)HoursOfOperationSearchFilterTypeDef#
# HoursOfOperationSearchFilterTypeDef definition
class HoursOfOperationSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)PromptSearchFilterTypeDef#
# PromptSearchFilterTypeDef definition
class PromptSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)QueueSearchFilterTypeDef#
# QueueSearchFilterTypeDef definition
class QueueSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)QuickConnectSearchFilterTypeDef#
# QuickConnectSearchFilterTypeDef definition
class QuickConnectSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)RoutingProfileSearchFilterTypeDef#
# RoutingProfileSearchFilterTypeDef definition
class RoutingProfileSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)SecurityProfilesSearchFilterTypeDef#
# SecurityProfilesSearchFilterTypeDef definition
class SecurityProfilesSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)UserSearchFilterTypeDef#
# UserSearchFilterTypeDef definition
class UserSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)DescribeEvaluationFormResponseTypeDef#
# DescribeEvaluationFormResponseTypeDef definition
class DescribeEvaluationFormResponseTypeDef(TypedDict):
EvaluationForm: EvaluationFormTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeQueueResponseTypeDef#
# DescribeQueueResponseTypeDef definition
class DescribeQueueResponseTypeDef(TypedDict):
Queue: QueueTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See QueueTypeDef
- See ResponseMetadataTypeDef
SearchQueuesResponseTypeDef#
# SearchQueuesResponseTypeDef definition
class SearchQueuesResponseTypeDef(TypedDict):
Queues: List[QueueTypeDef], # (1)
NextToken: str,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See QueueTypeDef
- See ResponseMetadataTypeDef
DescribeUserResponseTypeDef#
# DescribeUserResponseTypeDef definition
class DescribeUserResponseTypeDef(TypedDict):
User: UserTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See UserTypeDef
- See ResponseMetadataTypeDef
RoutingProfileTypeDef#
# RoutingProfileTypeDef definition
class RoutingProfileTypeDef(TypedDict):
InstanceId: NotRequired[str],
Name: NotRequired[str],
RoutingProfileArn: NotRequired[str],
RoutingProfileId: NotRequired[str],
Description: NotRequired[str],
MediaConcurrencies: NotRequired[List[MediaConcurrencyTypeDef]], # (1)
DefaultOutboundQueueId: NotRequired[str],
Tags: NotRequired[Dict[str, str]],
NumberOfAssociatedQueues: NotRequired[int],
NumberOfAssociatedUsers: NotRequired[int],
AgentAvailabilityTimer: NotRequired[AgentAvailabilityTimerType], # (2)UpdateRoutingProfileConcurrencyRequestRequestTypeDef#
# UpdateRoutingProfileConcurrencyRequestRequestTypeDef definition
class UpdateRoutingProfileConcurrencyRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
MediaConcurrencies: Sequence[MediaConcurrencyTypeDef], # (1)CurrentMetricResultTypeDef#
# CurrentMetricResultTypeDef definition
class CurrentMetricResultTypeDef(TypedDict):
Dimensions: NotRequired[DimensionsTypeDef], # (1)
Collections: NotRequired[List[CurrentMetricDataTypeDef]], # (2)AssociateRoutingProfileQueuesRequestRequestTypeDef#
# AssociateRoutingProfileQueuesRequestRequestTypeDef definition
class AssociateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef], # (1)CreateRoutingProfileRequestRequestTypeDef#
# CreateRoutingProfileRequestRequestTypeDef definition
class CreateRoutingProfileRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
Description: str,
DefaultOutboundQueueId: str,
MediaConcurrencies: Sequence[MediaConcurrencyTypeDef], # (1)
QueueConfigs: NotRequired[Sequence[RoutingProfileQueueConfigTypeDef]], # (2)
Tags: NotRequired[Mapping[str, str]],
AgentAvailabilityTimer: NotRequired[AgentAvailabilityTimerType], # (3)UpdateRoutingProfileQueuesRequestRequestTypeDef#
# UpdateRoutingProfileQueuesRequestRequestTypeDef definition
class UpdateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef], # (1)InstanceStorageConfigTypeDef#
# InstanceStorageConfigTypeDef definition
class InstanceStorageConfigTypeDef(TypedDict):
StorageType: StorageTypeType, # (1)
AssociationId: NotRequired[str],
S3Config: NotRequired[S3ConfigTypeDef], # (2)
KinesisVideoStreamConfig: NotRequired[KinesisVideoStreamConfigTypeDef], # (3)
KinesisStreamConfig: NotRequired[KinesisStreamConfigTypeDef], # (4)
KinesisFirehoseConfig: NotRequired[KinesisFirehoseConfigTypeDef], # (5)- See StorageTypeType
- See S3ConfigTypeDef
- See KinesisVideoStreamConfigTypeDef
- See KinesisStreamConfigTypeDef
- See KinesisFirehoseConfigTypeDef
SubmitContactEvaluationRequestRequestTypeDef#
# SubmitContactEvaluationRequestRequestTypeDef definition
class SubmitContactEvaluationRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationId: str,
Answers: NotRequired[Mapping[str, EvaluationAnswerInputTypeDef]], # (1)
Notes: NotRequired[Mapping[str, EvaluationNoteTypeDef]], # (2)UpdateContactEvaluationRequestRequestTypeDef#
# UpdateContactEvaluationRequestRequestTypeDef definition
class UpdateContactEvaluationRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationId: str,
Answers: NotRequired[Mapping[str, EvaluationAnswerInputTypeDef]], # (1)
Notes: NotRequired[Mapping[str, EvaluationNoteTypeDef]], # (2)EvaluationFormNumericQuestionPropertiesTypeDef#
# EvaluationFormNumericQuestionPropertiesTypeDef definition
class EvaluationFormNumericQuestionPropertiesTypeDef(TypedDict):
MinValue: int,
MaxValue: int,
Options: NotRequired[Sequence[EvaluationFormNumericQuestionOptionTypeDef]], # (1)
Automation: NotRequired[EvaluationFormNumericQuestionAutomationTypeDef], # (2)EvaluationFormSingleSelectQuestionAutomationTypeDef#
# EvaluationFormSingleSelectQuestionAutomationTypeDef definition
class EvaluationFormSingleSelectQuestionAutomationTypeDef(TypedDict):
Options: Sequence[EvaluationFormSingleSelectQuestionAutomationOptionTypeDef], # (1)
DefaultOptionRefId: NotRequired[str],EvaluationTypeDef#
# EvaluationTypeDef definition
class EvaluationTypeDef(TypedDict):
EvaluationId: str,
EvaluationArn: str,
Metadata: EvaluationMetadataTypeDef, # (1)
Answers: Dict[str, EvaluationAnswerOutputTypeDef], # (2)
Notes: Dict[str, EvaluationNoteTypeDef], # (3)
Status: EvaluationStatusType, # (4)
CreatedTime: datetime,
LastModifiedTime: datetime,
Scores: NotRequired[Dict[str, EvaluationScoreTypeDef]], # (5)
Tags: NotRequired[Dict[str, str]],- See EvaluationMetadataTypeDef
- See EvaluationAnswerOutputTypeDef
- See EvaluationNoteTypeDef
- See EvaluationStatusType
- See EvaluationScoreTypeDef
ListContactEvaluationsResponseTypeDef#
# ListContactEvaluationsResponseTypeDef definition
class ListContactEvaluationsResponseTypeDef(TypedDict):
EvaluationSummaryList: List[EvaluationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UserDataTypeDef#
# UserDataTypeDef definition
class UserDataTypeDef(TypedDict):
User: NotRequired[UserReferenceTypeDef], # (1)
RoutingProfile: NotRequired[RoutingProfileReferenceTypeDef], # (2)
HierarchyPath: NotRequired[HierarchyPathReferenceTypeDef], # (3)
Status: NotRequired[AgentStatusReferenceTypeDef], # (4)
AvailableSlotsByChannel: NotRequired[Dict[ChannelType, int]], # (5)
MaxSlotsByChannel: NotRequired[Dict[ChannelType, int]], # (5)
ActiveSlotsByChannel: NotRequired[Dict[ChannelType, int]], # (5)
Contacts: NotRequired[List[AgentContactReferenceTypeDef]], # (8)
NextStatus: NotRequired[str],- See UserReferenceTypeDef
- See RoutingProfileReferenceTypeDef
- See HierarchyPathReferenceTypeDef
- See AgentStatusReferenceTypeDef
- See ChannelType
- See ChannelType
- See ChannelType
- See AgentContactReferenceTypeDef
HierarchyGroupTypeDef#
# HierarchyGroupTypeDef definition
class HierarchyGroupTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
LevelId: NotRequired[str],
HierarchyPath: NotRequired[HierarchyPathTypeDef], # (1)
Tags: NotRequired[Dict[str, str]],DescribeUserHierarchyStructureResponseTypeDef#
# DescribeUserHierarchyStructureResponseTypeDef definition
class DescribeUserHierarchyStructureResponseTypeDef(TypedDict):
HierarchyStructure: HierarchyStructureTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateUserHierarchyStructureRequestRequestTypeDef#
# UpdateUserHierarchyStructureRequestRequestTypeDef definition
class UpdateUserHierarchyStructureRequestRequestTypeDef(TypedDict):
HierarchyStructure: HierarchyStructureUpdateTypeDef, # (1)
InstanceId: str,GetMetricDataRequestGetMetricDataPaginateTypeDef#
# GetMetricDataRequestGetMetricDataPaginateTypeDef definition
class GetMetricDataRequestGetMetricDataPaginateTypeDef(TypedDict):
InstanceId: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
Filters: FiltersTypeDef, # (1)
HistoricalMetrics: Sequence[HistoricalMetricTypeDef], # (2)
Groupings: NotRequired[Sequence[GroupingType]], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)- See FiltersTypeDef
- See HistoricalMetricTypeDef
- See GroupingType
- See PaginatorConfigTypeDef
GetMetricDataRequestRequestTypeDef#
# GetMetricDataRequestRequestTypeDef definition
class GetMetricDataRequestRequestTypeDef(TypedDict):
InstanceId: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
Filters: FiltersTypeDef, # (1)
HistoricalMetrics: Sequence[HistoricalMetricTypeDef], # (2)
Groupings: NotRequired[Sequence[GroupingType]], # (3)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],- See FiltersTypeDef
- See HistoricalMetricTypeDef
- See GroupingType
HistoricalMetricDataTypeDef#
# HistoricalMetricDataTypeDef definition
class HistoricalMetricDataTypeDef(TypedDict):
Metric: NotRequired[HistoricalMetricTypeDef], # (1)
Value: NotRequired[float],CreateHoursOfOperationRequestRequestTypeDef#
# CreateHoursOfOperationRequestRequestTypeDef definition
class CreateHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
TimeZone: str,
Config: Sequence[HoursOfOperationConfigTypeDef], # (1)
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],HoursOfOperationTypeDef#
# HoursOfOperationTypeDef definition
class HoursOfOperationTypeDef(TypedDict):
HoursOfOperationId: NotRequired[str],
HoursOfOperationArn: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
TimeZone: NotRequired[str],
Config: NotRequired[List[HoursOfOperationConfigTypeDef]], # (1)
Tags: NotRequired[Dict[str, str]],UpdateHoursOfOperationRequestRequestTypeDef#
# UpdateHoursOfOperationRequestRequestTypeDef definition
class UpdateHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
Name: NotRequired[str],
Description: NotRequired[str],
TimeZone: NotRequired[str],
Config: NotRequired[Sequence[HoursOfOperationConfigTypeDef]], # (1)DescribeInstanceResponseTypeDef#
# DescribeInstanceResponseTypeDef definition
class DescribeInstanceResponseTypeDef(TypedDict):
Instance: InstanceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)TaskTemplateConstraintsTypeDef#
# TaskTemplateConstraintsTypeDef definition
class TaskTemplateConstraintsTypeDef(TypedDict):
RequiredFields: NotRequired[Sequence[RequiredFieldInfoTypeDef]], # (1)
ReadOnlyFields: NotRequired[Sequence[ReadOnlyFieldInfoTypeDef]], # (2)
InvisibleFields: NotRequired[Sequence[InvisibleFieldInfoTypeDef]], # (3)TaskTemplateDefaultsTypeDef#
# TaskTemplateDefaultsTypeDef definition
class TaskTemplateDefaultsTypeDef(TypedDict):
DefaultFieldValues: NotRequired[Sequence[TaskTemplateDefaultFieldValueTypeDef]], # (1)GetMetricDataV2RequestRequestTypeDef#
# GetMetricDataV2RequestRequestTypeDef definition
class GetMetricDataV2RequestRequestTypeDef(TypedDict):
ResourceArn: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
Filters: Sequence[FilterV2TypeDef], # (1)
Metrics: Sequence[MetricV2TypeDef], # (2)
Groupings: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],- See FilterV2TypeDef
- See MetricV2TypeDef
MetricDataV2TypeDef#
# MetricDataV2TypeDef definition
class MetricDataV2TypeDef(TypedDict):
Metric: NotRequired[MetricV2TypeDef], # (1)
Value: NotRequired[float],- See MetricV2TypeDef
ChatParticipantRoleConfigTypeDef#
# ChatParticipantRoleConfigTypeDef definition
class ChatParticipantRoleConfigTypeDef(TypedDict):
ParticipantTimerConfigList: Sequence[ParticipantTimerConfigurationTypeDef], # (1)CreateQuickConnectRequestRequestTypeDef#
# CreateQuickConnectRequestRequestTypeDef definition
class CreateQuickConnectRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
QuickConnectConfig: QuickConnectConfigTypeDef, # (1)
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],QuickConnectTypeDef#
# QuickConnectTypeDef definition
class QuickConnectTypeDef(TypedDict):
QuickConnectARN: NotRequired[str],
QuickConnectId: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
QuickConnectConfig: NotRequired[QuickConnectConfigTypeDef], # (1)
Tags: NotRequired[Dict[str, str]],UpdateQuickConnectConfigRequestRequestTypeDef#
# UpdateQuickConnectConfigRequestRequestTypeDef definition
class UpdateQuickConnectConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
QuickConnectId: str,
QuickConnectConfig: QuickConnectConfigTypeDef, # (1)ListContactReferencesResponseTypeDef#
# ListContactReferencesResponseTypeDef definition
class ListContactReferencesResponseTypeDef(TypedDict):
ReferenceSummaryList: List[ReferenceSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)RuleActionTypeDef#
# RuleActionTypeDef definition
class RuleActionTypeDef(TypedDict):
ActionType: ActionTypeType, # (1)
TaskAction: NotRequired[TaskActionDefinitionTypeDef], # (2)
EventBridgeAction: NotRequired[EventBridgeActionDefinitionTypeDef], # (3)
AssignContactCategoryAction: NotRequired[Mapping[str, Any]],
SendNotificationAction: NotRequired[SendNotificationActionDefinitionTypeDef], # (4)- See ActionTypeType
- See TaskActionDefinitionTypeDef
- See EventBridgeActionDefinitionTypeDef
- See SendNotificationActionDefinitionTypeDef
SearchResourceTagsRequestRequestTypeDef#
# SearchResourceTagsRequestRequestTypeDef definition
class SearchResourceTagsRequestRequestTypeDef(TypedDict):
InstanceId: str,
ResourceTypes: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchCriteria: NotRequired[ResourceTagsSearchCriteriaTypeDef], # (1)SearchResourceTagsRequestSearchResourceTagsPaginateTypeDef#
# SearchResourceTagsRequestSearchResourceTagsPaginateTypeDef definition
class SearchResourceTagsRequestSearchResourceTagsPaginateTypeDef(TypedDict):
InstanceId: str,
ResourceTypes: NotRequired[Sequence[str]],
SearchCriteria: NotRequired[ResourceTagsSearchCriteriaTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)GetTrafficDistributionResponseTypeDef#
# GetTrafficDistributionResponseTypeDef definition
class GetTrafficDistributionResponseTypeDef(TypedDict):
TelephonyConfig: TelephonyConfigTypeDef, # (1)
Id: str,
Arn: str,
SignInConfig: SignInConfigTypeDef, # (2)
AgentConfig: AgentConfigTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See TelephonyConfigTypeDef
- See SignInConfigTypeDef
- See AgentConfigTypeDef
- See ResponseMetadataTypeDef
UpdateTrafficDistributionRequestRequestTypeDef#
# UpdateTrafficDistributionRequestRequestTypeDef definition
class UpdateTrafficDistributionRequestRequestTypeDef(TypedDict):
Id: str,
TelephonyConfig: NotRequired[TelephonyConfigTypeDef], # (1)
SignInConfig: NotRequired[SignInConfigTypeDef], # (2)
AgentConfig: NotRequired[AgentConfigTypeDef], # (3)SearchUsersResponseTypeDef#
# SearchUsersResponseTypeDef definition
class SearchUsersResponseTypeDef(TypedDict):
Users: List[UserSearchSummaryTypeDef], # (1)
NextToken: str,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchHoursOfOperationsRequestRequestTypeDef#
# SearchHoursOfOperationsRequestRequestTypeDef definition
class SearchHoursOfOperationsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[HoursOfOperationSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[HoursOfOperationSearchCriteriaTypeDef], # (2)SearchHoursOfOperationsRequestSearchHoursOfOperationsPaginateTypeDef#
# SearchHoursOfOperationsRequestSearchHoursOfOperationsPaginateTypeDef definition
class SearchHoursOfOperationsRequestSearchHoursOfOperationsPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[HoursOfOperationSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[HoursOfOperationSearchCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See HoursOfOperationSearchFilterTypeDef
- See HoursOfOperationSearchCriteriaTypeDef
- See PaginatorConfigTypeDef
SearchPromptsRequestRequestTypeDef#
# SearchPromptsRequestRequestTypeDef definition
class SearchPromptsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[PromptSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[PromptSearchCriteriaTypeDef], # (2)SearchPromptsRequestSearchPromptsPaginateTypeDef#
# SearchPromptsRequestSearchPromptsPaginateTypeDef definition
class SearchPromptsRequestSearchPromptsPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[PromptSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[PromptSearchCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)SearchQueuesRequestRequestTypeDef#
# SearchQueuesRequestRequestTypeDef definition
class SearchQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[QueueSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[QueueSearchCriteriaTypeDef], # (2)SearchQueuesRequestSearchQueuesPaginateTypeDef#
# SearchQueuesRequestSearchQueuesPaginateTypeDef definition
class SearchQueuesRequestSearchQueuesPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[QueueSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[QueueSearchCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)SearchQuickConnectsRequestRequestTypeDef#
# SearchQuickConnectsRequestRequestTypeDef definition
class SearchQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[QuickConnectSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[QuickConnectSearchCriteriaTypeDef], # (2)SearchQuickConnectsRequestSearchQuickConnectsPaginateTypeDef#
# SearchQuickConnectsRequestSearchQuickConnectsPaginateTypeDef definition
class SearchQuickConnectsRequestSearchQuickConnectsPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[QuickConnectSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[QuickConnectSearchCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See QuickConnectSearchFilterTypeDef
- See QuickConnectSearchCriteriaTypeDef
- See PaginatorConfigTypeDef
SearchRoutingProfilesRequestRequestTypeDef#
# SearchRoutingProfilesRequestRequestTypeDef definition
class SearchRoutingProfilesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[RoutingProfileSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[RoutingProfileSearchCriteriaTypeDef], # (2)SearchRoutingProfilesRequestSearchRoutingProfilesPaginateTypeDef#
# SearchRoutingProfilesRequestSearchRoutingProfilesPaginateTypeDef definition
class SearchRoutingProfilesRequestSearchRoutingProfilesPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[RoutingProfileSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[RoutingProfileSearchCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See RoutingProfileSearchFilterTypeDef
- See RoutingProfileSearchCriteriaTypeDef
- See PaginatorConfigTypeDef
SearchSecurityProfilesRequestRequestTypeDef#
# SearchSecurityProfilesRequestRequestTypeDef definition
class SearchSecurityProfilesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchCriteria: NotRequired[SecurityProfileSearchCriteriaTypeDef], # (1)
SearchFilter: NotRequired[SecurityProfilesSearchFilterTypeDef], # (2)SearchSecurityProfilesRequestSearchSecurityProfilesPaginateTypeDef#
# SearchSecurityProfilesRequestSearchSecurityProfilesPaginateTypeDef definition
class SearchSecurityProfilesRequestSearchSecurityProfilesPaginateTypeDef(TypedDict):
InstanceId: str,
SearchCriteria: NotRequired[SecurityProfileSearchCriteriaTypeDef], # (1)
SearchFilter: NotRequired[SecurityProfilesSearchFilterTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See SecurityProfileSearchCriteriaTypeDef
- See SecurityProfilesSearchFilterTypeDef
- See PaginatorConfigTypeDef
SearchUsersRequestRequestTypeDef#
# SearchUsersRequestRequestTypeDef definition
class SearchUsersRequestRequestTypeDef(TypedDict):
InstanceId: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[UserSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[UserSearchCriteriaTypeDef], # (2)SearchUsersRequestSearchUsersPaginateTypeDef#
# SearchUsersRequestSearchUsersPaginateTypeDef definition
class SearchUsersRequestSearchUsersPaginateTypeDef(TypedDict):
InstanceId: NotRequired[str],
SearchFilter: NotRequired[UserSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[UserSearchCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)DescribeRoutingProfileResponseTypeDef#
# DescribeRoutingProfileResponseTypeDef definition
class DescribeRoutingProfileResponseTypeDef(TypedDict):
RoutingProfile: RoutingProfileTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchRoutingProfilesResponseTypeDef#
# SearchRoutingProfilesResponseTypeDef definition
class SearchRoutingProfilesResponseTypeDef(TypedDict):
RoutingProfiles: List[RoutingProfileTypeDef], # (1)
NextToken: str,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetCurrentMetricDataResponseTypeDef#
# GetCurrentMetricDataResponseTypeDef definition
class GetCurrentMetricDataResponseTypeDef(TypedDict):
NextToken: str,
MetricResults: List[CurrentMetricResultTypeDef], # (1)
DataSnapshotTime: datetime,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)AssociateInstanceStorageConfigRequestRequestTypeDef#
# AssociateInstanceStorageConfigRequestRequestTypeDef definition
class AssociateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
StorageConfig: InstanceStorageConfigTypeDef, # (2)DescribeInstanceStorageConfigResponseTypeDef#
# DescribeInstanceStorageConfigResponseTypeDef definition
class DescribeInstanceStorageConfigResponseTypeDef(TypedDict):
StorageConfig: InstanceStorageConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListInstanceStorageConfigsResponseTypeDef#
# ListInstanceStorageConfigsResponseTypeDef definition
class ListInstanceStorageConfigsResponseTypeDef(TypedDict):
StorageConfigs: List[InstanceStorageConfigTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateInstanceStorageConfigRequestRequestTypeDef#
# UpdateInstanceStorageConfigRequestRequestTypeDef definition
class UpdateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
StorageConfig: InstanceStorageConfigTypeDef, # (2)EvaluationFormSingleSelectQuestionPropertiesTypeDef#
# EvaluationFormSingleSelectQuestionPropertiesTypeDef definition
class EvaluationFormSingleSelectQuestionPropertiesTypeDef(TypedDict):
Options: Sequence[EvaluationFormSingleSelectQuestionOptionTypeDef], # (1)
DisplayAs: NotRequired[EvaluationFormSingleSelectQuestionDisplayModeType], # (2)
Automation: NotRequired[EvaluationFormSingleSelectQuestionAutomationTypeDef], # (3)- See EvaluationFormSingleSelectQuestionOptionTypeDef
- See EvaluationFormSingleSelectQuestionDisplayModeType
- See EvaluationFormSingleSelectQuestionAutomationTypeDef
DescribeContactEvaluationResponseTypeDef#
# DescribeContactEvaluationResponseTypeDef definition
class DescribeContactEvaluationResponseTypeDef(TypedDict):
Evaluation: EvaluationTypeDef, # (1)
EvaluationForm: EvaluationFormContentTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)GetCurrentUserDataResponseTypeDef#
# GetCurrentUserDataResponseTypeDef definition
class GetCurrentUserDataResponseTypeDef(TypedDict):
NextToken: str,
UserDataList: List[UserDataTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeUserHierarchyGroupResponseTypeDef#
# DescribeUserHierarchyGroupResponseTypeDef definition
class DescribeUserHierarchyGroupResponseTypeDef(TypedDict):
HierarchyGroup: HierarchyGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)HistoricalMetricResultTypeDef#
# HistoricalMetricResultTypeDef definition
class HistoricalMetricResultTypeDef(TypedDict):
Dimensions: NotRequired[DimensionsTypeDef], # (1)
Collections: NotRequired[List[HistoricalMetricDataTypeDef]], # (2)DescribeHoursOfOperationResponseTypeDef#
# DescribeHoursOfOperationResponseTypeDef definition
class DescribeHoursOfOperationResponseTypeDef(TypedDict):
HoursOfOperation: HoursOfOperationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchHoursOfOperationsResponseTypeDef#
# SearchHoursOfOperationsResponseTypeDef definition
class SearchHoursOfOperationsResponseTypeDef(TypedDict):
HoursOfOperations: List[HoursOfOperationTypeDef], # (1)
NextToken: str,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateTaskTemplateRequestRequestTypeDef#
# CreateTaskTemplateRequestRequestTypeDef definition
class CreateTaskTemplateRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
Fields: Sequence[TaskTemplateFieldTypeDef], # (1)
Description: NotRequired[str],
ContactFlowId: NotRequired[str],
Constraints: NotRequired[TaskTemplateConstraintsTypeDef], # (2)
Defaults: NotRequired[TaskTemplateDefaultsTypeDef], # (3)
Status: NotRequired[TaskTemplateStatusType], # (4)
ClientToken: NotRequired[str],- See TaskTemplateFieldTypeDef
- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateStatusType
GetTaskTemplateResponseTypeDef#
# GetTaskTemplateResponseTypeDef definition
class GetTaskTemplateResponseTypeDef(TypedDict):
InstanceId: str,
Id: str,
Arn: str,
Name: str,
Description: str,
ContactFlowId: str,
Constraints: TaskTemplateConstraintsTypeDef, # (1)
Defaults: TaskTemplateDefaultsTypeDef, # (2)
Fields: List[TaskTemplateFieldTypeDef], # (3)
Status: TaskTemplateStatusType, # (4)
LastModifiedTime: datetime,
CreatedTime: datetime,
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateFieldTypeDef
- See TaskTemplateStatusType
- See ResponseMetadataTypeDef
UpdateTaskTemplateRequestRequestTypeDef#
# UpdateTaskTemplateRequestRequestTypeDef definition
class UpdateTaskTemplateRequestRequestTypeDef(TypedDict):
TaskTemplateId: str,
InstanceId: str,
Name: NotRequired[str],
Description: NotRequired[str],
ContactFlowId: NotRequired[str],
Constraints: NotRequired[TaskTemplateConstraintsTypeDef], # (1)
Defaults: NotRequired[TaskTemplateDefaultsTypeDef], # (2)
Status: NotRequired[TaskTemplateStatusType], # (3)
Fields: NotRequired[Sequence[TaskTemplateFieldTypeDef]], # (4)- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateStatusType
- See TaskTemplateFieldTypeDef
UpdateTaskTemplateResponseTypeDef#
# UpdateTaskTemplateResponseTypeDef definition
class UpdateTaskTemplateResponseTypeDef(TypedDict):
InstanceId: str,
Id: str,
Arn: str,
Name: str,
Description: str,
ContactFlowId: str,
Constraints: TaskTemplateConstraintsTypeDef, # (1)
Defaults: TaskTemplateDefaultsTypeDef, # (2)
Fields: List[TaskTemplateFieldTypeDef], # (3)
Status: TaskTemplateStatusType, # (4)
LastModifiedTime: datetime,
CreatedTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateFieldTypeDef
- See TaskTemplateStatusType
- See ResponseMetadataTypeDef
MetricResultV2TypeDef#
# MetricResultV2TypeDef definition
class MetricResultV2TypeDef(TypedDict):
Dimensions: NotRequired[Dict[str, str]],
Collections: NotRequired[List[MetricDataV2TypeDef]], # (1)UpdateParticipantRoleConfigChannelInfoTypeDef#
# UpdateParticipantRoleConfigChannelInfoTypeDef definition
class UpdateParticipantRoleConfigChannelInfoTypeDef(TypedDict):
Chat: NotRequired[ChatParticipantRoleConfigTypeDef], # (1)DescribeQuickConnectResponseTypeDef#
# DescribeQuickConnectResponseTypeDef definition
class DescribeQuickConnectResponseTypeDef(TypedDict):
QuickConnect: QuickConnectTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchQuickConnectsResponseTypeDef#
# SearchQuickConnectsResponseTypeDef definition
class SearchQuickConnectsResponseTypeDef(TypedDict):
QuickConnects: List[QuickConnectTypeDef], # (1)
NextToken: str,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateRuleRequestRequestTypeDef#
# CreateRuleRequestRequestTypeDef definition
class CreateRuleRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
TriggerEventSource: RuleTriggerEventSourceTypeDef, # (1)
Function: str,
Actions: Sequence[RuleActionTypeDef], # (2)
PublishStatus: RulePublishStatusType, # (3)
ClientToken: NotRequired[str],RuleTypeDef#
# RuleTypeDef definition
class RuleTypeDef(TypedDict):
Name: str,
RuleId: str,
RuleArn: str,
TriggerEventSource: RuleTriggerEventSourceTypeDef, # (1)
Function: str,
Actions: List[RuleActionTypeDef], # (2)
PublishStatus: RulePublishStatusType, # (3)
CreatedTime: datetime,
LastUpdatedTime: datetime,
LastUpdatedBy: str,
Tags: NotRequired[Dict[str, str]],UpdateRuleRequestRequestTypeDef#
# UpdateRuleRequestRequestTypeDef definition
class UpdateRuleRequestRequestTypeDef(TypedDict):
RuleId: str,
InstanceId: str,
Name: str,
Function: str,
Actions: Sequence[RuleActionTypeDef], # (1)
PublishStatus: RulePublishStatusType, # (2)EvaluationFormQuestionTypePropertiesTypeDef#
# EvaluationFormQuestionTypePropertiesTypeDef definition
class EvaluationFormQuestionTypePropertiesTypeDef(TypedDict):
Numeric: NotRequired[EvaluationFormNumericQuestionPropertiesTypeDef], # (1)
SingleSelect: NotRequired[EvaluationFormSingleSelectQuestionPropertiesTypeDef], # (2)- See EvaluationFormNumericQuestionPropertiesTypeDef
- See EvaluationFormSingleSelectQuestionPropertiesTypeDef
GetMetricDataResponseTypeDef#
# GetMetricDataResponseTypeDef definition
class GetMetricDataResponseTypeDef(TypedDict):
NextToken: str,
MetricResults: List[HistoricalMetricResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetMetricDataV2ResponseTypeDef#
# GetMetricDataV2ResponseTypeDef definition
class GetMetricDataV2ResponseTypeDef(TypedDict):
NextToken: str,
MetricResults: List[MetricResultV2TypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateParticipantRoleConfigRequestRequestTypeDef#
# UpdateParticipantRoleConfigRequestRequestTypeDef definition
class UpdateParticipantRoleConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ChannelConfiguration: UpdateParticipantRoleConfigChannelInfoTypeDef, # (1)DescribeRuleResponseTypeDef#
# DescribeRuleResponseTypeDef definition
class DescribeRuleResponseTypeDef(TypedDict):
Rule: RuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See RuleTypeDef
- See ResponseMetadataTypeDef
EvaluationFormQuestionTypeDef#
# EvaluationFormQuestionTypeDef definition
class EvaluationFormQuestionTypeDef(TypedDict):
Title: str,
RefId: str,
QuestionType: EvaluationFormQuestionTypeType, # (1)
Instructions: NotRequired[str],
NotApplicableEnabled: NotRequired[bool],
QuestionTypeProperties: NotRequired[EvaluationFormQuestionTypePropertiesTypeDef], # (2)
Weight: NotRequired[float],EvaluationFormItemTypeDef#
# EvaluationFormItemTypeDef definition
class EvaluationFormItemTypeDef(TypedDict):
Section: NotRequired[EvaluationFormSectionTypeDef], # (1)
Question: NotRequired[EvaluationFormQuestionTypeDef], # (2)