Skip to content

Type definitions#

Index > Connect > Type definitions

Auto-generated documentation for Connect type annotations stubs module mypy-boto3-connect.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AgentsCriteriaUnionTypeDef#

# AgentsCriteriaUnionTypeDef definition

AgentsCriteriaUnionTypeDef = Union[
    AgentsCriteriaTypeDef,  # (1)
    AgentsCriteriaOutputTypeDef,  # (2)
]
  1. See AgentsCriteriaTypeDef
  2. See AgentsCriteriaOutputTypeDef

ApplicationUnionTypeDef#

# ApplicationUnionTypeDef definition

ApplicationUnionTypeDef = Union[
    ApplicationTypeDef,  # (1)
    ApplicationOutputTypeDef,  # (2)
]
  1. See ApplicationTypeDef
  2. See ApplicationOutputTypeDef

EvaluationFormSectionUnionTypeDef#

# EvaluationFormSectionUnionTypeDef definition

EvaluationFormSectionUnionTypeDef = Union[
    EvaluationFormSectionTypeDef,  # (1)
    EvaluationFormSectionOutputTypeDef,  # (2)
]
  1. See EvaluationFormSectionTypeDef
  2. See EvaluationFormSectionOutputTypeDef

FieldValueUnionUnionTypeDef#

# FieldValueUnionUnionTypeDef definition

FieldValueUnionUnionTypeDef = Union[
    FieldValueUnionTypeDef,  # (1)
    FieldValueUnionOutputTypeDef,  # (2)
]
  1. See FieldValueUnionTypeDef
  2. See FieldValueUnionOutputTypeDef

MetricFilterV2UnionTypeDef#

# MetricFilterV2UnionTypeDef definition

MetricFilterV2UnionTypeDef = Union[
    MetricFilterV2TypeDef,  # (1)
    MetricFilterV2OutputTypeDef,  # (2)
]
  1. See MetricFilterV2TypeDef
  2. See MetricFilterV2OutputTypeDef

NotificationRecipientTypeUnionTypeDef#

# NotificationRecipientTypeUnionTypeDef definition

NotificationRecipientTypeUnionTypeDef = Union[
    NotificationRecipientTypeTypeDef,  # (1)
    NotificationRecipientTypeOutputTypeDef,  # (2)
]
  1. See NotificationRecipientTypeTypeDef
  2. See NotificationRecipientTypeOutputTypeDef

TaskTemplateFieldUnionTypeDef#

# TaskTemplateFieldUnionTypeDef definition

TaskTemplateFieldUnionTypeDef = Union[
    TaskTemplateFieldTypeDef,  # (1)
    TaskTemplateFieldOutputTypeDef,  # (2)
]
  1. See TaskTemplateFieldTypeDef
  2. See TaskTemplateFieldOutputTypeDef

TaskActionDefinitionUnionTypeDef#

# TaskActionDefinitionUnionTypeDef definition

TaskActionDefinitionUnionTypeDef = Union[
    TaskActionDefinitionTypeDef,  # (1)
    TaskActionDefinitionOutputTypeDef,  # (2)
]
  1. See TaskActionDefinitionTypeDef
  2. See TaskActionDefinitionOutputTypeDef

MatchCriteriaUnionTypeDef#

# MatchCriteriaUnionTypeDef definition

MatchCriteriaUnionTypeDef = Union[
    MatchCriteriaTypeDef,  # (1)
    MatchCriteriaOutputTypeDef,  # (2)
]
  1. See MatchCriteriaTypeDef
  2. See MatchCriteriaOutputTypeDef

EvaluationFormNumericQuestionPropertiesUnionTypeDef#

# EvaluationFormNumericQuestionPropertiesUnionTypeDef definition

EvaluationFormNumericQuestionPropertiesUnionTypeDef = Union[
    EvaluationFormNumericQuestionPropertiesTypeDef,  # (1)
    EvaluationFormNumericQuestionPropertiesOutputTypeDef,  # (2)
]
  1. See EvaluationFormNumericQuestionPropertiesTypeDef
  2. See EvaluationFormNumericQuestionPropertiesOutputTypeDef

EvaluationFormSingleSelectQuestionAutomationUnionTypeDef#

# EvaluationFormSingleSelectQuestionAutomationUnionTypeDef definition

EvaluationFormSingleSelectQuestionAutomationUnionTypeDef = Union[
    EvaluationFormSingleSelectQuestionAutomationTypeDef,  # (1)
    EvaluationFormSingleSelectQuestionAutomationOutputTypeDef,  # (2)
]
  1. See EvaluationFormSingleSelectQuestionAutomationTypeDef
  2. See EvaluationFormSingleSelectQuestionAutomationOutputTypeDef

FieldValueExtraUnionTypeDef#

# FieldValueExtraUnionTypeDef definition

FieldValueExtraUnionTypeDef = Union[
    FieldValueTypeDef,  # (1)
    FieldValueOutputTypeDef,  # (2)
]
  1. See FieldValueTypeDef
  2. See FieldValueOutputTypeDef

MetricV2UnionTypeDef#

# MetricV2UnionTypeDef definition

MetricV2UnionTypeDef = Union[
    MetricV2TypeDef,  # (1)
    MetricV2OutputTypeDef,  # (2)
]
  1. See MetricV2TypeDef
  2. See MetricV2OutputTypeDef

SendNotificationActionDefinitionUnionTypeDef#

# SendNotificationActionDefinitionUnionTypeDef definition

SendNotificationActionDefinitionUnionTypeDef = Union[
    SendNotificationActionDefinitionTypeDef,  # (1)
    SendNotificationActionDefinitionOutputTypeDef,  # (2)
]
  1. See SendNotificationActionDefinitionTypeDef
  2. See SendNotificationActionDefinitionOutputTypeDef

UpdateCaseActionDefinitionUnionTypeDef#

# UpdateCaseActionDefinitionUnionTypeDef definition

UpdateCaseActionDefinitionUnionTypeDef = Union[
    UpdateCaseActionDefinitionTypeDef,  # (1)
    UpdateCaseActionDefinitionOutputTypeDef,  # (2)
]
  1. See UpdateCaseActionDefinitionTypeDef
  2. See UpdateCaseActionDefinitionOutputTypeDef

AttributeConditionUnionTypeDef#

# AttributeConditionUnionTypeDef definition

AttributeConditionUnionTypeDef = Union[
    AttributeConditionTypeDef,  # (1)
    AttributeConditionOutputTypeDef,  # (2)
]
  1. See AttributeConditionTypeDef
  2. See AttributeConditionOutputTypeDef

EvaluationFormSingleSelectQuestionPropertiesUnionTypeDef#

# EvaluationFormSingleSelectQuestionPropertiesUnionTypeDef definition

EvaluationFormSingleSelectQuestionPropertiesUnionTypeDef = Union[
    EvaluationFormSingleSelectQuestionPropertiesTypeDef,  # (1)
    EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef,  # (2)
]
  1. See EvaluationFormSingleSelectQuestionPropertiesTypeDef
  2. See EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef

CreateCaseActionDefinitionUnionTypeDef#

# CreateCaseActionDefinitionUnionTypeDef definition

CreateCaseActionDefinitionUnionTypeDef = Union[
    CreateCaseActionDefinitionTypeDef,  # (1)
    CreateCaseActionDefinitionOutputTypeDef,  # (2)
]
  1. See CreateCaseActionDefinitionTypeDef
  2. See CreateCaseActionDefinitionOutputTypeDef

ExpressionUnionTypeDef#

# ExpressionUnionTypeDef definition

ExpressionUnionTypeDef = Union[
    ExpressionTypeDef,  # (1)
    ExpressionOutputTypeDef,  # (2)
]
  1. See ExpressionTypeDef
  2. See ExpressionOutputTypeDef

EvaluationFormQuestionTypePropertiesUnionTypeDef#

# EvaluationFormQuestionTypePropertiesUnionTypeDef definition

EvaluationFormQuestionTypePropertiesUnionTypeDef = Union[
    EvaluationFormQuestionTypePropertiesTypeDef,  # (1)
    EvaluationFormQuestionTypePropertiesOutputTypeDef,  # (2)
]
  1. See EvaluationFormQuestionTypePropertiesTypeDef
  2. See EvaluationFormQuestionTypePropertiesOutputTypeDef

RuleActionUnionTypeDef#

# RuleActionUnionTypeDef definition

RuleActionUnionTypeDef = Union[
    RuleActionTypeDef,  # (1)
    RuleActionOutputTypeDef,  # (2)
]
  1. See RuleActionTypeDef
  2. See RuleActionOutputTypeDef

EvaluationFormQuestionUnionTypeDef#

# EvaluationFormQuestionUnionTypeDef definition

EvaluationFormQuestionUnionTypeDef = Union[
    EvaluationFormQuestionTypeDef,  # (1)
    EvaluationFormQuestionOutputTypeDef,  # (2)
]
  1. See EvaluationFormQuestionTypeDef
  2. See EvaluationFormQuestionOutputTypeDef

EvaluationFormItemUnionTypeDef#

# EvaluationFormItemUnionTypeDef definition

EvaluationFormItemUnionTypeDef = Union[
    EvaluationFormItemTypeDef,  # (1)
    EvaluationFormItemOutputTypeDef,  # (2)
]
  1. See EvaluationFormItemTypeDef
  2. See EvaluationFormItemOutputTypeDef

ActionSummaryTypeDef#

# ActionSummaryTypeDef definition

class ActionSummaryTypeDef(TypedDict):
    ActionType: ActionTypeType,  # (1)
  1. See ActionTypeType

ActivateEvaluationFormRequestRequestTypeDef#

# ActivateEvaluationFormRequestRequestTypeDef definition

class ActivateEvaluationFormRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    EvaluationFormId: str,
    EvaluationFormVersion: int,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DistributionTypeDef#

# DistributionTypeDef definition

class DistributionTypeDef(TypedDict):
    Region: str,
    Percentage: int,

QueueReferenceTypeDef#

# QueueReferenceTypeDef definition

class QueueReferenceTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],

AgentHierarchyGroupTypeDef#

# AgentHierarchyGroupTypeDef definition

class AgentHierarchyGroupTypeDef(TypedDict):
    Arn: NotRequired[str],

AgentHierarchyGroupsTypeDef#

# AgentHierarchyGroupsTypeDef definition

class AgentHierarchyGroupsTypeDef(TypedDict):
    L1Ids: NotRequired[Sequence[str]],
    L2Ids: NotRequired[Sequence[str]],
    L3Ids: NotRequired[Sequence[str]],
    L4Ids: NotRequired[Sequence[str]],
    L5Ids: NotRequired[Sequence[str]],

DeviceInfoTypeDef#

# DeviceInfoTypeDef definition

class DeviceInfoTypeDef(TypedDict):
    PlatformName: NotRequired[str],
    PlatformVersion: NotRequired[str],
    OperatingSystem: NotRequired[str],

ParticipantCapabilitiesTypeDef#

# ParticipantCapabilitiesTypeDef definition

class ParticipantCapabilitiesTypeDef(TypedDict):
    Video: NotRequired[VideoCapabilityType],  # (1)
    ScreenShare: NotRequired[ScreenShareCapabilityType],  # (2)
  1. See VideoCapabilityType
  2. See ScreenShareCapabilityType

AudioQualityMetricsInfoTypeDef#

# AudioQualityMetricsInfoTypeDef definition

class AudioQualityMetricsInfoTypeDef(TypedDict):
    QualityScore: NotRequired[float],
    PotentialQualityIssues: NotRequired[List[str]],

AgentStatusReferenceTypeDef#

# AgentStatusReferenceTypeDef definition

class AgentStatusReferenceTypeDef(TypedDict):
    StatusStartTimestamp: NotRequired[datetime],
    StatusArn: NotRequired[str],
    StatusName: NotRequired[str],

StringConditionTypeDef#

# StringConditionTypeDef definition

class StringConditionTypeDef(TypedDict):
    FieldName: NotRequired[str],
    Value: NotRequired[str],
    ComparisonType: NotRequired[StringComparisonTypeType],  # (1)
  1. See StringComparisonTypeType

AgentStatusSummaryTypeDef#

# AgentStatusSummaryTypeDef definition

class AgentStatusSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Type: NotRequired[AgentStatusTypeType],  # (1)
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
  1. See AgentStatusTypeType

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]],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
  1. See AgentStatusTypeType
  2. See AgentStatusStateType

AgentsCriteriaOutputTypeDef#

# AgentsCriteriaOutputTypeDef definition

class AgentsCriteriaOutputTypeDef(TypedDict):
    AgentIds: NotRequired[List[str]],

AgentsCriteriaTypeDef#

# AgentsCriteriaTypeDef definition

class AgentsCriteriaTypeDef(TypedDict):
    AgentIds: NotRequired[Sequence[str]],

AnalyticsDataAssociationResultTypeDef#

# AnalyticsDataAssociationResultTypeDef definition

class AnalyticsDataAssociationResultTypeDef(TypedDict):
    DataSetId: NotRequired[str],
    TargetAccountId: NotRequired[str],
    ResourceShareId: NotRequired[str],
    ResourceShareArn: NotRequired[str],

AnswerMachineDetectionConfigTypeDef#

# AnswerMachineDetectionConfigTypeDef definition

class AnswerMachineDetectionConfigTypeDef(TypedDict):
    EnableAnswerMachineDetection: NotRequired[bool],
    AwaitAnswerMachinePrompt: NotRequired[bool],

ApplicationOutputTypeDef#

# ApplicationOutputTypeDef definition

class ApplicationOutputTypeDef(TypedDict):
    Namespace: NotRequired[str],
    ApplicationPermissions: NotRequired[List[str]],

ApplicationTypeDef#

# ApplicationTypeDef definition

class ApplicationTypeDef(TypedDict):
    Namespace: NotRequired[str],
    ApplicationPermissions: NotRequired[Sequence[str]],

AssociateAnalyticsDataSetRequestRequestTypeDef#

# AssociateAnalyticsDataSetRequestRequestTypeDef definition

class AssociateAnalyticsDataSetRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    DataSetId: str,
    TargetAccountId: NotRequired[str],

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],
  1. See VocabularyLanguageCodeType

AssociateFlowRequestRequestTypeDef#

# AssociateFlowRequestRequestTypeDef definition

class AssociateFlowRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ResourceId: str,
    FlowId: str,
    ResourceType: FlowAssociationResourceTypeType,  # (1)
  1. See FlowAssociationResourceTypeType

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,

UserProficiencyTypeDef#

# UserProficiencyTypeDef definition

class UserProficiencyTypeDef(TypedDict):
    AttributeName: str,
    AttributeValue: str,
    Level: float,

AttachedFileErrorTypeDef#

# AttachedFileErrorTypeDef definition

class AttachedFileErrorTypeDef(TypedDict):
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],
    FileId: NotRequired[str],

CreatedByInfoTypeDef#

# CreatedByInfoTypeDef definition

class CreatedByInfoTypeDef(TypedDict):
    ConnectUserArn: NotRequired[str],
    AWSIdentityArn: NotRequired[str],

AttachmentReferenceTypeDef#

# AttachmentReferenceTypeDef definition

class AttachmentReferenceTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],
    Status: NotRequired[ReferenceStatusType],  # (1)
  1. See ReferenceStatusType

AttendeeTypeDef#

# AttendeeTypeDef definition

class AttendeeTypeDef(TypedDict):
    AttendeeId: NotRequired[str],
    JoinToken: NotRequired[str],

HierarchyGroupConditionTypeDef#

# HierarchyGroupConditionTypeDef definition

class HierarchyGroupConditionTypeDef(TypedDict):
    Value: NotRequired[str],
    HierarchyGroupMatchType: NotRequired[HierarchyGroupMatchTypeType],  # (1)
  1. See HierarchyGroupMatchTypeType

TagConditionTypeDef#

# TagConditionTypeDef definition

class TagConditionTypeDef(TypedDict):
    TagKey: NotRequired[str],
    TagValue: NotRequired[str],

AttributeTypeDef#

# AttributeTypeDef definition

class AttributeTypeDef(TypedDict):
    AttributeType: NotRequired[InstanceAttributeTypeType],  # (1)
    Value: NotRequired[str],
  1. See InstanceAttributeTypeType

AudioFeaturesTypeDef#

# AudioFeaturesTypeDef definition

class AudioFeaturesTypeDef(TypedDict):
    EchoReduction: NotRequired[MeetingFeatureStatusType],  # (1)
  1. See MeetingFeatureStatusType

AuthenticationProfileSummaryTypeDef#

# AuthenticationProfileSummaryTypeDef definition

class AuthenticationProfileSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    IsDefault: NotRequired[bool],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],

AuthenticationProfileTypeDef#

# AuthenticationProfileTypeDef definition

class AuthenticationProfileTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    AllowedIps: NotRequired[List[str]],
    BlockedIps: NotRequired[List[str]],
    IsDefault: NotRequired[bool],
    CreatedTime: NotRequired[datetime],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
    PeriodicSessionDuration: NotRequired[int],
    MaxSessionDuration: NotRequired[int],

AvailableNumberSummaryTypeDef#

# AvailableNumberSummaryTypeDef definition

class AvailableNumberSummaryTypeDef(TypedDict):
    PhoneNumber: NotRequired[str],
    PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType],  # (1)
    PhoneNumberType: NotRequired[PhoneNumberTypeType],  # (2)
  1. See PhoneNumberCountryCodeType
  2. See PhoneNumberTypeType

BatchAssociateAnalyticsDataSetRequestRequestTypeDef#

# BatchAssociateAnalyticsDataSetRequestRequestTypeDef definition

class BatchAssociateAnalyticsDataSetRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    DataSetIds: Sequence[str],
    TargetAccountId: NotRequired[str],

ErrorResultTypeDef#

# ErrorResultTypeDef definition

class ErrorResultTypeDef(TypedDict):
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

BatchDisassociateAnalyticsDataSetRequestRequestTypeDef#

# BatchDisassociateAnalyticsDataSetRequestRequestTypeDef definition

class BatchDisassociateAnalyticsDataSetRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    DataSetIds: Sequence[str],
    TargetAccountId: NotRequired[str],

BatchGetAttachedFileMetadataRequestRequestTypeDef#

# BatchGetAttachedFileMetadataRequestRequestTypeDef definition

class BatchGetAttachedFileMetadataRequestRequestTypeDef(TypedDict):
    FileIds: Sequence[str],
    InstanceId: str,
    AssociatedResourceArn: str,

BatchGetFlowAssociationRequestRequestTypeDef#

# BatchGetFlowAssociationRequestRequestTypeDef definition

class BatchGetFlowAssociationRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ResourceIds: Sequence[str],
    ResourceType: NotRequired[ListFlowAssociationResourceTypeType],  # (1)
  1. See ListFlowAssociationResourceTypeType

FlowAssociationSummaryTypeDef#

# FlowAssociationSummaryTypeDef definition

class FlowAssociationSummaryTypeDef(TypedDict):
    ResourceId: NotRequired[str],
    FlowId: NotRequired[str],
    ResourceType: NotRequired[ListFlowAssociationResourceTypeType],  # (1)
  1. See ListFlowAssociationResourceTypeType

FailedRequestTypeDef#

# FailedRequestTypeDef definition

class FailedRequestTypeDef(TypedDict):
    RequestIdentifier: NotRequired[str],
    FailureReasonCode: NotRequired[FailureReasonCodeType],  # (1)
    FailureReasonMessage: NotRequired[str],
  1. See FailureReasonCodeType

SuccessfulRequestTypeDef#

# SuccessfulRequestTypeDef definition

class SuccessfulRequestTypeDef(TypedDict):
    RequestIdentifier: NotRequired[str],
    ContactId: NotRequired[str],

CampaignTypeDef#

# CampaignTypeDef definition

class CampaignTypeDef(TypedDict):
    CampaignId: NotRequired[str],

ChatEventTypeDef#

# ChatEventTypeDef definition

class ChatEventTypeDef(TypedDict):
    Type: ChatEventTypeType,  # (1)
    ContentType: NotRequired[str],
    Content: NotRequired[str],
  1. See ChatEventTypeType

ChatMessageTypeDef#

# ChatMessageTypeDef definition

class ChatMessageTypeDef(TypedDict):
    ContentType: str,
    Content: str,

ChatStreamingConfigurationTypeDef#

# ChatStreamingConfigurationTypeDef definition

class ChatStreamingConfigurationTypeDef(TypedDict):
    StreamingEndpointArn: str,

ClaimPhoneNumberRequestRequestTypeDef#

# ClaimPhoneNumberRequestRequestTypeDef definition

class ClaimPhoneNumberRequestRequestTypeDef(TypedDict):
    PhoneNumber: str,
    TargetArn: NotRequired[str],
    InstanceId: NotRequired[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],
  1. See PhoneNumberWorkflowStatusType

CompleteAttachedFileUploadRequestRequestTypeDef#

# CompleteAttachedFileUploadRequestRequestTypeDef definition

class CompleteAttachedFileUploadRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    FileId: str,
    AssociatedResourceArn: str,

NumberConditionTypeDef#

# NumberConditionTypeDef definition

class NumberConditionTypeDef(TypedDict):
    FieldName: NotRequired[str],
    MinValue: NotRequired[int],
    MaxValue: NotRequired[int],
    ComparisonType: NotRequired[NumberComparisonTypeType],  # (1)
  1. See NumberComparisonTypeType

EndpointTypeDef#

# EndpointTypeDef definition

class EndpointTypeDef(TypedDict):
    Type: NotRequired[EndpointTypeType],  # (1)
    Address: NotRequired[str],
  1. See EndpointTypeType

ContactFilterTypeDef#

# ContactFilterTypeDef definition

class ContactFilterTypeDef(TypedDict):
    ContactStates: NotRequired[Sequence[ContactStateType]],  # (1)
  1. See ContactStateType

ContactFlowModuleSummaryTypeDef#

# ContactFlowModuleSummaryTypeDef definition

class ContactFlowModuleSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    State: NotRequired[ContactFlowModuleStateType],  # (1)
  1. See ContactFlowModuleStateType

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]],
  1. See ContactFlowModuleStateType
  2. See ContactFlowModuleStatusType

ContactFlowSummaryTypeDef#

# ContactFlowSummaryTypeDef definition

class ContactFlowSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    ContactFlowType: NotRequired[ContactFlowTypeType],  # (1)
    ContactFlowState: NotRequired[ContactFlowStateType],  # (2)
    ContactFlowStatus: NotRequired[ContactFlowStatusType],  # (3)
  1. See ContactFlowTypeType
  2. See ContactFlowStateType
  3. See ContactFlowStatusType

ContactFlowTypeDef#

# ContactFlowTypeDef definition

class ContactFlowTypeDef(TypedDict):
    Arn: NotRequired[str],
    Id: NotRequired[str],
    Name: NotRequired[str],
    Type: NotRequired[ContactFlowTypeType],  # (1)
    State: NotRequired[ContactFlowStateType],  # (2)
    Status: NotRequired[ContactFlowStatusType],  # (3)
    Description: NotRequired[str],
    Content: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],
    IsDefault: NotRequired[bool],
    FlowContentSha256: NotRequired[str],
    Version: NotRequired[int],
    VersionDescription: NotRequired[str],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
  1. See ContactFlowTypeType
  2. See ContactFlowStateType
  3. See ContactFlowStatusType

ContactFlowVersionSummaryTypeDef#

# ContactFlowVersionSummaryTypeDef definition

class ContactFlowVersionSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    VersionDescription: NotRequired[str],
    Version: NotRequired[int],

ContactSearchSummaryAgentInfoTypeDef#

# ContactSearchSummaryAgentInfoTypeDef definition

class ContactSearchSummaryAgentInfoTypeDef(TypedDict):
    Id: NotRequired[str],
    ConnectedToAgentTimestamp: NotRequired[datetime],

ContactSearchSummaryQueueInfoTypeDef#

# ContactSearchSummaryQueueInfoTypeDef definition

class ContactSearchSummaryQueueInfoTypeDef(TypedDict):
    Id: NotRequired[str],
    EnqueueTimestamp: NotRequired[datetime],

CustomerVoiceActivityTypeDef#

# CustomerVoiceActivityTypeDef definition

class CustomerVoiceActivityTypeDef(TypedDict):
    GreetingStartTimestamp: NotRequired[datetime],
    GreetingEndTimestamp: NotRequired[datetime],

DisconnectDetailsTypeDef#

# DisconnectDetailsTypeDef definition

class DisconnectDetailsTypeDef(TypedDict):
    PotentialDisconnectIssue: NotRequired[str],

QueueInfoTypeDef#

# QueueInfoTypeDef definition

class QueueInfoTypeDef(TypedDict):
    Id: NotRequired[str],
    EnqueueTimestamp: NotRequired[datetime],

SegmentAttributeValueTypeDef#

# SegmentAttributeValueTypeDef definition

class SegmentAttributeValueTypeDef(TypedDict):
    ValueString: NotRequired[str],

WisdomInfoTypeDef#

# WisdomInfoTypeDef definition

class WisdomInfoTypeDef(TypedDict):
    SessionArn: 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]],
  1. See AgentStatusStateType

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],
    Status: NotRequired[ContactFlowStatusType],  # (2)
    Tags: NotRequired[Mapping[str, str]],
  1. See ContactFlowTypeType
  2. See ContactFlowStatusType

EvaluationFormScoringStrategyTypeDef#

# EvaluationFormScoringStrategyTypeDef definition

class EvaluationFormScoringStrategyTypeDef(TypedDict):
    Mode: EvaluationFormScoringModeType,  # (1)
    Status: EvaluationFormScoringStatusType,  # (2)
  1. See EvaluationFormScoringModeType
  2. See EvaluationFormScoringStatusType

CreateInstanceRequestRequestTypeDef#

# CreateInstanceRequestRequestTypeDef definition

class CreateInstanceRequestRequestTypeDef(TypedDict):
    IdentityManagementType: DirectoryTypeType,  # (1)
    InboundCallsEnabled: bool,
    OutboundCallsEnabled: bool,
    ClientToken: NotRequired[str],
    InstanceAlias: NotRequired[str],
    DirectoryId: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See DirectoryTypeType

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]],
  1. See IntegrationTypeType
  2. See SourceTypeType

ParticipantDetailsToAddTypeDef#

# ParticipantDetailsToAddTypeDef definition

class ParticipantDetailsToAddTypeDef(TypedDict):
    ParticipantRole: NotRequired[ParticipantRoleType],  # (1)
    DisplayName: NotRequired[str],
  1. See ParticipantRoleType

ParticipantTokenCredentialsTypeDef#

# ParticipantTokenCredentialsTypeDef definition

class ParticipantTokenCredentialsTypeDef(TypedDict):
    ParticipantToken: NotRequired[str],
    Expiry: NotRequired[str],

CreatePersistentContactAssociationRequestRequestTypeDef#

# CreatePersistentContactAssociationRequestRequestTypeDef definition

class CreatePersistentContactAssociationRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    InitialContactId: str,
    RehydrationType: RehydrationTypeType,  # (1)
    SourceContactId: str,
    ClientToken: NotRequired[str],
  1. See RehydrationTypeType

PredefinedAttributeValuesTypeDef#

# PredefinedAttributeValuesTypeDef definition

class PredefinedAttributeValuesTypeDef(TypedDict):
    StringList: NotRequired[Sequence[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],
  1. See EventSourceNameType

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]],
  1. 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],
  1. See PhoneTypeType

ViewInputContentTypeDef#

# ViewInputContentTypeDef definition

class ViewInputContentTypeDef(TypedDict):
    Template: NotRequired[str],
    Actions: NotRequired[Sequence[str]],

CreateViewVersionRequestRequestTypeDef#

# CreateViewVersionRequestRequestTypeDef definition

class CreateViewVersionRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ViewId: str,
    VersionDescription: NotRequired[str],
    ViewContentSha256: NotRequired[str],

CreateVocabularyRequestRequestTypeDef#

# CreateVocabularyRequestRequestTypeDef definition

class CreateVocabularyRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    VocabularyName: str,
    LanguageCode: VocabularyLanguageCodeType,  # (1)
    Content: str,
    ClientToken: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See VocabularyLanguageCodeType

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)
  1. See BehaviorTypeType

CurrentMetricTypeDef#

# CurrentMetricTypeDef definition

class CurrentMetricTypeDef(TypedDict):
    Name: NotRequired[CurrentMetricNameType],  # (1)
    Unit: NotRequired[UnitType],  # (2)
  1. See CurrentMetricNameType
  2. See UnitType

CurrentMetricSortCriteriaTypeDef#

# CurrentMetricSortCriteriaTypeDef definition

class CurrentMetricSortCriteriaTypeDef(TypedDict):
    SortByMetric: NotRequired[CurrentMetricNameType],  # (1)
    SortOrder: NotRequired[SortOrderType],  # (2)
  1. See CurrentMetricNameType
  2. 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,
  1. See VocabularyLanguageCodeType

DeleteAttachedFileRequestRequestTypeDef#

# DeleteAttachedFileRequestRequestTypeDef definition

class DeleteAttachedFileRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    FileId: str,
    AssociatedResourceArn: 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,

DeletePredefinedAttributeRequestRequestTypeDef#

# DeletePredefinedAttributeRequestRequestTypeDef definition

class DeletePredefinedAttributeRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Name: 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,

DeleteViewRequestRequestTypeDef#

# DeleteViewRequestRequestTypeDef definition

class DeleteViewRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ViewId: str,

DeleteViewVersionRequestRequestTypeDef#

# DeleteViewVersionRequestRequestTypeDef definition

class DeleteViewVersionRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ViewId: str,
    ViewVersion: int,

DeleteVocabularyRequestRequestTypeDef#

# DeleteVocabularyRequestRequestTypeDef definition

class DeleteVocabularyRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    VocabularyId: str,

DescribeAgentStatusRequestRequestTypeDef#

# DescribeAgentStatusRequestRequestTypeDef definition

class DescribeAgentStatusRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    AgentStatusId: str,

DescribeAuthenticationProfileRequestRequestTypeDef#

# DescribeAuthenticationProfileRequestRequestTypeDef definition

class DescribeAuthenticationProfileRequestRequestTypeDef(TypedDict):
    AuthenticationProfileId: str,
    InstanceId: 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)
  1. See InstanceAttributeTypeType

DescribeInstanceRequestRequestTypeDef#

# DescribeInstanceRequestRequestTypeDef definition

class DescribeInstanceRequestRequestTypeDef(TypedDict):
    InstanceId: str,

DescribeInstanceStorageConfigRequestRequestTypeDef#

# DescribeInstanceStorageConfigRequestRequestTypeDef definition

class DescribeInstanceStorageConfigRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    AssociationId: str,
    ResourceType: InstanceStorageResourceTypeType,  # (1)
  1. See InstanceStorageResourceTypeType

DescribePhoneNumberRequestRequestTypeDef#

# DescribePhoneNumberRequestRequestTypeDef definition

class DescribePhoneNumberRequestRequestTypeDef(TypedDict):
    PhoneNumberId: str,

DescribePredefinedAttributeRequestRequestTypeDef#

# DescribePredefinedAttributeRequestRequestTypeDef definition

class DescribePredefinedAttributeRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Name: 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]],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[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]],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
    HierarchyRestrictedResources: NotRequired[List[str]],
    AllowedAccessControlHierarchyGroupId: NotRequired[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],
  1. See TrafficDistributionGroupStatusType

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,

DescribeViewRequestRequestTypeDef#

# DescribeViewRequestRequestTypeDef definition

class DescribeViewRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ViewId: 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]],
  1. See VocabularyLanguageCodeType
  2. See VocabularyStateType

RoutingProfileReferenceTypeDef#

# RoutingProfileReferenceTypeDef definition

class RoutingProfileReferenceTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],

DisassociateAnalyticsDataSetRequestRequestTypeDef#

# DisassociateAnalyticsDataSetRequestRequestTypeDef definition

class DisassociateAnalyticsDataSetRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    DataSetId: str,
    TargetAccountId: NotRequired[str],

DisassociateApprovedOriginRequestRequestTypeDef#

# DisassociateApprovedOriginRequestRequestTypeDef definition

class DisassociateApprovedOriginRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Origin: str,

DisassociateFlowRequestRequestTypeDef#

# DisassociateFlowRequestRequestTypeDef definition

class DisassociateFlowRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ResourceId: str,
    ResourceType: FlowAssociationResourceTypeType,  # (1)
  1. See FlowAssociationResourceTypeType

DisassociateInstanceStorageConfigRequestRequestTypeDef#

# DisassociateInstanceStorageConfigRequestRequestTypeDef definition

class DisassociateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    AssociationId: str,
    ResourceType: InstanceStorageResourceTypeType,  # (1)
  1. See InstanceStorageResourceTypeType

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

UserProficiencyDisassociateTypeDef#

# UserProficiencyDisassociateTypeDef definition

class UserProficiencyDisassociateTypeDef(TypedDict):
    AttributeName: str,
    AttributeValue: str,

DisconnectReasonTypeDef#

# DisconnectReasonTypeDef definition

class DisconnectReasonTypeDef(TypedDict):
    Code: NotRequired[str],

DismissUserContactRequestRequestTypeDef#

# DismissUserContactRequestRequestTypeDef definition

class DismissUserContactRequestRequestTypeDef(TypedDict):
    UserId: str,
    InstanceId: str,
    ContactId: str,

DownloadUrlMetadataTypeDef#

# DownloadUrlMetadataTypeDef definition

class DownloadUrlMetadataTypeDef(TypedDict):
    Url: NotRequired[str],
    UrlExpiry: NotRequired[str],

EmailReferenceTypeDef#

# EmailReferenceTypeDef definition

class EmailReferenceTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],

EncryptionConfigTypeDef#

# EncryptionConfigTypeDef definition

class EncryptionConfigTypeDef(TypedDict):
    EncryptionType: EncryptionTypeType,  # (1)
    KeyId: str,
  1. See EncryptionTypeType

EvaluationAnswerDataTypeDef#

# EvaluationAnswerDataTypeDef definition

class EvaluationAnswerDataTypeDef(TypedDict):
    StringValue: NotRequired[str],
    NumericValue: NotRequired[float],
    NotApplicable: NotRequired[bool],

EvaluationFormSectionOutputTypeDef#

# EvaluationFormSectionOutputTypeDef definition

class EvaluationFormSectionOutputTypeDef(TypedDict):
    Title: str,
    RefId: str,
    Items: List[Dict[str, Any]],
    Instructions: NotRequired[str],
    Weight: NotRequired[float],

NumericQuestionPropertyValueAutomationTypeDef#

# NumericQuestionPropertyValueAutomationTypeDef definition

class NumericQuestionPropertyValueAutomationTypeDef(TypedDict):
    Label: NumericQuestionPropertyAutomationLabelType,  # (1)
  1. See NumericQuestionPropertyAutomationLabelType

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[Mapping[str, Any]],
    Instructions: NotRequired[str],
    Weight: NotRequired[float],

SingleSelectQuestionRuleCategoryAutomationTypeDef#

# SingleSelectQuestionRuleCategoryAutomationTypeDef definition

class SingleSelectQuestionRuleCategoryAutomationTypeDef(TypedDict):
    Category: str,
    Condition: SingleSelectQuestionRuleCategoryAutomationConditionType,  # (1)
    OptionRefId: str,
  1. See SingleSelectQuestionRuleCategoryAutomationConditionType

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,
  1. See EvaluationFormVersionStatusType

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,

ExpiryTypeDef#

# ExpiryTypeDef definition

class ExpiryTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],
    ExpiryTimestamp: NotRequired[datetime],

FieldValueUnionOutputTypeDef#

# FieldValueUnionOutputTypeDef definition

class FieldValueUnionOutputTypeDef(TypedDict):
    BooleanValue: NotRequired[bool],
    DoubleValue: NotRequired[float],
    EmptyValue: NotRequired[Dict[str, Any]],
    StringValue: NotRequired[str],

FieldValueUnionTypeDef#

# FieldValueUnionTypeDef definition

class FieldValueUnionTypeDef(TypedDict):
    BooleanValue: NotRequired[bool],
    DoubleValue: NotRequired[float],
    EmptyValue: NotRequired[Mapping[str, Any]],
    StringValue: NotRequired[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]],
    RoutingStepExpressions: NotRequired[Sequence[str]],
  1. See ChannelType

GetAttachedFileRequestRequestTypeDef#

# GetAttachedFileRequestRequestTypeDef definition

class GetAttachedFileRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    FileId: str,
    AssociatedResourceArn: str,
    UrlExpiryInSeconds: NotRequired[int],

GetContactAttributesRequestRequestTypeDef#

# GetContactAttributesRequestRequestTypeDef definition

class GetContactAttributesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    InitialContactId: str,

GetFederationTokenRequestRequestTypeDef#

# GetFederationTokenRequestRequestTypeDef definition

class GetFederationTokenRequestRequestTypeDef(TypedDict):
    InstanceId: str,

GetFlowAssociationRequestRequestTypeDef#

# GetFlowAssociationRequestRequestTypeDef definition

class GetFlowAssociationRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ResourceId: str,
    ResourceType: FlowAssociationResourceTypeType,  # (1)
  1. See FlowAssociationResourceTypeType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

IntervalDetailsTypeDef#

# IntervalDetailsTypeDef definition

class IntervalDetailsTypeDef(TypedDict):
    TimeZone: NotRequired[str],
    IntervalPeriod: NotRequired[IntervalPeriodType],  # (1)
  1. See IntervalPeriodType

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,

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],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],

HierarchyLevelTypeDef#

# HierarchyLevelTypeDef definition

class HierarchyLevelTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],

HierarchyLevelUpdateTypeDef#

# HierarchyLevelUpdateTypeDef definition

class HierarchyLevelUpdateTypeDef(TypedDict):
    Name: str,

ThresholdTypeDef#

# ThresholdTypeDef definition

class ThresholdTypeDef(TypedDict):
    Comparison: NotRequired[ComparisonType],  # (1)
    ThresholdValue: NotRequired[float],
  1. See ComparisonType

HoursOfOperationTimeSliceTypeDef#

# HoursOfOperationTimeSliceTypeDef definition

class HoursOfOperationTimeSliceTypeDef(TypedDict):
    Hours: int,
    Minutes: int,

HoursOfOperationSummaryTypeDef#

# HoursOfOperationSummaryTypeDef definition

class HoursOfOperationSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],

ImportPhoneNumberRequestRequestTypeDef#

# ImportPhoneNumberRequestRequestTypeDef definition

class ImportPhoneNumberRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    SourcePhoneNumberArn: str,
    PhoneNumberDescription: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
    ClientToken: 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],
  1. See DirectoryTypeType
  2. 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)
  1. See IntegrationTypeType
  2. 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)
  1. See AgentStatusTypeType

ListAnalyticsDataAssociationsRequestRequestTypeDef#

# ListAnalyticsDataAssociationsRequestRequestTypeDef definition

class ListAnalyticsDataAssociationsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    DataSetId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListApprovedOriginsRequestRequestTypeDef#

# ListApprovedOriginsRequestRequestTypeDef definition

class ListApprovedOriginsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListAuthenticationProfilesRequestRequestTypeDef#

# ListAuthenticationProfilesRequestRequestTypeDef definition

class ListAuthenticationProfilesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListBotsRequestRequestTypeDef#

# ListBotsRequestRequestTypeDef definition

class ListBotsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    LexVersion: LexVersionType,  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. 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)
  1. See ContactFlowModuleStateType

ListContactFlowVersionsRequestRequestTypeDef#

# ListContactFlowVersionsRequestRequestTypeDef definition

class ListContactFlowVersionsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactFlowId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListContactFlowsRequestRequestTypeDef#

# ListContactFlowsRequestRequestTypeDef definition

class ListContactFlowsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactFlowTypes: NotRequired[Sequence[ContactFlowTypeType]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ContactFlowTypeType

ListContactReferencesRequestRequestTypeDef#

# ListContactReferencesRequestRequestTypeDef definition

class ListContactReferencesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    ReferenceTypes: Sequence[ReferenceTypeType],  # (1)
    NextToken: NotRequired[str],
  1. See ReferenceTypeType

ListDefaultVocabulariesRequestRequestTypeDef#

# ListDefaultVocabulariesRequestRequestTypeDef definition

class ListDefaultVocabulariesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    LanguageCode: NotRequired[VocabularyLanguageCodeType],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See VocabularyLanguageCodeType

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

ListFlowAssociationsRequestRequestTypeDef#

# ListFlowAssociationsRequestRequestTypeDef definition

class ListFlowAssociationsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ResourceType: NotRequired[ListFlowAssociationResourceTypeType],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ListFlowAssociationResourceTypeType

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],
  1. See InstanceStorageResourceTypeType

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],
    IntegrationArn: NotRequired[str],
  1. See IntegrationTypeType

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],
  1. See PhoneNumberTypeType
  2. See PhoneNumberCountryCodeType

PhoneNumberSummaryTypeDef#

# PhoneNumberSummaryTypeDef definition

class PhoneNumberSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    PhoneNumber: NotRequired[str],
    PhoneNumberType: NotRequired[PhoneNumberTypeType],  # (1)
    PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType],  # (2)
  1. See PhoneNumberTypeType
  2. See PhoneNumberCountryCodeType

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],
    InstanceId: NotRequired[str],
    PhoneNumberDescription: NotRequired[str],
    SourcePhoneNumberArn: NotRequired[str],
  1. See PhoneNumberCountryCodeType
  2. See PhoneNumberTypeType

ListPhoneNumbersV2RequestRequestTypeDef#

# ListPhoneNumbersV2RequestRequestTypeDef definition

class ListPhoneNumbersV2RequestRequestTypeDef(TypedDict):
    TargetArn: NotRequired[str],
    InstanceId: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]],  # (1)
    PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]],  # (2)
    PhoneNumberPrefix: NotRequired[str],
  1. See PhoneNumberCountryCodeType
  2. See PhoneNumberTypeType

ListPredefinedAttributesRequestRequestTypeDef#

# ListPredefinedAttributesRequestRequestTypeDef definition

class ListPredefinedAttributesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PredefinedAttributeSummaryTypeDef#

# PredefinedAttributeSummaryTypeDef definition

class PredefinedAttributeSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: 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],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: 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)
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
  1. See QuickConnectTypeType

ListQueuesRequestRequestTypeDef#

# ListQueuesRequestRequestTypeDef definition

class ListQueuesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    QueueTypes: NotRequired[Sequence[QueueTypeType]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See QueueTypeType

QueueSummaryTypeDef#

# QueueSummaryTypeDef definition

class QueueSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    QueueType: NotRequired[QueueTypeType],  # (1)
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
  1. See QueueTypeType

ListQuickConnectsRequestRequestTypeDef#

# ListQuickConnectsRequestRequestTypeDef definition

class ListQuickConnectsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    QuickConnectTypes: NotRequired[Sequence[QuickConnectTypeType]],  # (1)
  1. See QuickConnectTypeType

ListRealtimeContactAnalysisSegmentsV2RequestRequestTypeDef#

# ListRealtimeContactAnalysisSegmentsV2RequestRequestTypeDef definition

class ListRealtimeContactAnalysisSegmentsV2RequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    OutputType: RealTimeContactAnalysisOutputTypeType,  # (1)
    SegmentTypes: Sequence[RealTimeContactAnalysisSegmentTypeType],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See RealTimeContactAnalysisOutputTypeType
  2. See RealTimeContactAnalysisSegmentTypeType

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)
  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],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],

ListRulesRequestRequestTypeDef#

# ListRulesRequestRequestTypeDef definition

class ListRulesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    PublishStatus: NotRequired[RulePublishStatusType],  # (1)
    EventSourceName: NotRequired[EventSourceNameType],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See RulePublishStatusType
  2. See EventSourceNameType

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

ListSecurityProfileApplicationsRequestRequestTypeDef#

# ListSecurityProfileApplicationsRequestRequestTypeDef definition

class ListSecurityProfileApplicationsRequestRequestTypeDef(TypedDict):
    SecurityProfileId: str,
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

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],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: 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],
  1. See TaskTemplateStatusType

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],
  1. See TaskTemplateStatusType

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],
  1. See TrafficDistributionGroupStatusType

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)
  1. See UseCaseTypeType

ListUserHierarchyGroupsRequestRequestTypeDef#

# ListUserHierarchyGroupsRequestRequestTypeDef definition

class ListUserHierarchyGroupsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListUserProficienciesRequestRequestTypeDef#

# ListUserProficienciesRequestRequestTypeDef definition

class ListUserProficienciesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    UserId: 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],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],

ListViewVersionsRequestRequestTypeDef#

# ListViewVersionsRequestRequestTypeDef definition

class ListViewVersionsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ViewId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ViewVersionSummaryTypeDef#

# ViewVersionSummaryTypeDef definition

class ViewVersionSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Description: NotRequired[str],
    Name: NotRequired[str],
    Type: NotRequired[ViewTypeType],  # (1)
    Version: NotRequired[int],
    VersionDescription: NotRequired[str],
  1. See ViewTypeType

ListViewsRequestRequestTypeDef#

# ListViewsRequestRequestTypeDef definition

class ListViewsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Type: NotRequired[ViewTypeType],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ViewTypeType

ViewSummaryTypeDef#

# ViewSummaryTypeDef definition

class ViewSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Type: NotRequired[ViewTypeType],  # (1)
    Status: NotRequired[ViewStatusType],  # (2)
    Description: NotRequired[str],
  1. See ViewTypeType
  2. See ViewStatusType

MediaPlacementTypeDef#

# MediaPlacementTypeDef definition

class MediaPlacementTypeDef(TypedDict):
    AudioHostUrl: NotRequired[str],
    AudioFallbackUrl: NotRequired[str],
    SignalingUrl: NotRequired[str],
    TurnControlUrl: NotRequired[str],
    EventIngestionUrl: NotRequired[str],

MetricFilterV2OutputTypeDef#

# MetricFilterV2OutputTypeDef definition

class MetricFilterV2OutputTypeDef(TypedDict):
    MetricFilterKey: NotRequired[str],
    MetricFilterValues: NotRequired[List[str]],
    Negate: NotRequired[bool],

MetricFilterV2TypeDef#

# MetricFilterV2TypeDef definition

class MetricFilterV2TypeDef(TypedDict):
    MetricFilterKey: NotRequired[str],
    MetricFilterValues: NotRequired[Sequence[str]],
    Negate: NotRequired[bool],

MetricIntervalTypeDef#

# MetricIntervalTypeDef definition

class MetricIntervalTypeDef(TypedDict):
    Interval: NotRequired[IntervalPeriodType],  # (1)
    StartTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
  1. See IntervalPeriodType

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],
  1. See MonitorCapabilityType

ParticipantDetailsTypeDef#

# ParticipantDetailsTypeDef definition

class ParticipantDetailsTypeDef(TypedDict):
    DisplayName: str,

NotificationRecipientTypeOutputTypeDef#

# NotificationRecipientTypeOutputTypeDef definition

class NotificationRecipientTypeOutputTypeDef(TypedDict):
    UserTags: NotRequired[Dict[str, str]],
    UserIds: NotRequired[List[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],

ParticipantTimerValueTypeDef#

# ParticipantTimerValueTypeDef definition

class ParticipantTimerValueTypeDef(TypedDict):
    ParticipantTimerAction: NotRequired[ParticipantTimerActionType],  # (1)
    ParticipantTimerDurationInMinutes: NotRequired[int],
  1. See ParticipantTimerActionType

PauseContactRequestRequestTypeDef#

# PauseContactRequestRequestTypeDef definition

class PauseContactRequestRequestTypeDef(TypedDict):
    ContactId: str,
    InstanceId: str,
    ContactFlowId: NotRequired[str],

PersistentChatTypeDef#

# PersistentChatTypeDef definition

class PersistentChatTypeDef(TypedDict):
    RehydrationType: NotRequired[RehydrationTypeType],  # (1)
    SourceContactId: NotRequired[str],
  1. See RehydrationTypeType

PhoneNumberQuickConnectConfigTypeDef#

# PhoneNumberQuickConnectConfigTypeDef definition

class PhoneNumberQuickConnectConfigTypeDef(TypedDict):
    PhoneNumber: str,

PredefinedAttributeValuesOutputTypeDef#

# PredefinedAttributeValuesOutputTypeDef definition

class PredefinedAttributeValuesOutputTypeDef(TypedDict):
    StringList: NotRequired[List[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,

RealTimeContactAnalysisAttachmentTypeDef#

# RealTimeContactAnalysisAttachmentTypeDef definition

class RealTimeContactAnalysisAttachmentTypeDef(TypedDict):
    AttachmentName: str,
    AttachmentId: str,
    ContentType: NotRequired[str],
    Status: NotRequired[ArtifactStatusType],  # (1)
  1. See ArtifactStatusType

RealTimeContactAnalysisCharacterIntervalTypeDef#

# RealTimeContactAnalysisCharacterIntervalTypeDef definition

class RealTimeContactAnalysisCharacterIntervalTypeDef(TypedDict):
    BeginOffsetChar: int,
    EndOffsetChar: int,

RealTimeContactAnalysisTimeDataTypeDef#

# RealTimeContactAnalysisTimeDataTypeDef definition

class RealTimeContactAnalysisTimeDataTypeDef(TypedDict):
    AbsoluteTime: NotRequired[datetime],

RealTimeContactAnalysisSegmentPostContactSummaryTypeDef#

# RealTimeContactAnalysisSegmentPostContactSummaryTypeDef definition

class RealTimeContactAnalysisSegmentPostContactSummaryTypeDef(TypedDict):
    Status: RealTimeContactAnalysisPostContactSummaryStatusType,  # (1)
    Content: NotRequired[str],
    FailureCode: NotRequired[RealTimeContactAnalysisPostContactSummaryFailureCodeType],  # (2)
  1. See RealTimeContactAnalysisPostContactSummaryStatusType
  2. See RealTimeContactAnalysisPostContactSummaryFailureCodeType

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)
  1. See ReferenceTypeType

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

ReplicationStatusSummaryTypeDef#

# ReplicationStatusSummaryTypeDef definition

class ReplicationStatusSummaryTypeDef(TypedDict):
    Region: NotRequired[str],
    ReplicationStatus: NotRequired[InstanceReplicationStatusType],  # (1)
    ReplicationStatusReason: NotRequired[str],
  1. See InstanceReplicationStatusType

TagSearchConditionTypeDef#

# TagSearchConditionTypeDef definition

class TagSearchConditionTypeDef(TypedDict):
    tagKey: NotRequired[str],
    tagValue: NotRequired[str],
    tagKeyComparisonType: NotRequired[StringComparisonTypeType],  # (1)
    tagValueComparisonType: NotRequired[StringComparisonTypeType],  # (1)
  1. See StringComparisonTypeType
  2. See StringComparisonTypeType

ResumeContactRecordingRequestRequestTypeDef#

# ResumeContactRecordingRequestRequestTypeDef definition

class ResumeContactRecordingRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    InitialContactId: str,

ResumeContactRequestRequestTypeDef#

# ResumeContactRequestRequestTypeDef definition

class ResumeContactRequestRequestTypeDef(TypedDict):
    ContactId: str,
    InstanceId: str,
    ContactFlowId: NotRequired[str],

RoutingCriteriaInputStepExpiryTypeDef#

# RoutingCriteriaInputStepExpiryTypeDef definition

class RoutingCriteriaInputStepExpiryTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

SubmitAutoEvaluationActionDefinitionTypeDef#

# SubmitAutoEvaluationActionDefinitionTypeDef definition

class SubmitAutoEvaluationActionDefinitionTypeDef(TypedDict):
    EvaluationFormId: str,

SearchAvailablePhoneNumbersRequestRequestTypeDef#

# SearchAvailablePhoneNumbersRequestRequestTypeDef definition

class SearchAvailablePhoneNumbersRequestRequestTypeDef(TypedDict):
    PhoneNumberCountryCode: PhoneNumberCountryCodeType,  # (1)
    PhoneNumberType: PhoneNumberTypeType,  # (2)
    TargetArn: NotRequired[str],
    InstanceId: NotRequired[str],
    PhoneNumberPrefix: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See PhoneNumberCountryCodeType
  2. See PhoneNumberTypeType

SortTypeDef#

# SortTypeDef definition

class SortTypeDef(TypedDict):
    FieldName: SortableFieldNameType,  # (1)
    Order: SortOrderType,  # (2)
  1. See SortableFieldNameType
  2. See SortOrderType

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)
  1. See VocabularyStateType
  2. See VocabularyLanguageCodeType

VocabularySummaryTypeDef#

# VocabularySummaryTypeDef definition

class VocabularySummaryTypeDef(TypedDict):
    Name: str,
    Id: str,
    Arn: str,
    LanguageCode: VocabularyLanguageCodeType,  # (1)
    State: VocabularyStateType,  # (2)
    LastModifiedTime: datetime,
    FailureReason: NotRequired[str],
  1. See VocabularyLanguageCodeType
  2. See VocabularyStateType

SearchableContactAttributesCriteriaTypeDef#

# SearchableContactAttributesCriteriaTypeDef definition

class SearchableContactAttributesCriteriaTypeDef(TypedDict):
    Key: str,
    Values: Sequence[str],

SignInDistributionTypeDef#

# SignInDistributionTypeDef definition

class SignInDistributionTypeDef(TypedDict):
    Region: str,
    Enabled: bool,

UploadUrlMetadataTypeDef#

# UploadUrlMetadataTypeDef definition

class UploadUrlMetadataTypeDef(TypedDict):
    Url: NotRequired[str],
    UrlExpiry: NotRequired[str],
    HeadersToInclude: NotRequired[Dict[str, str]],

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)
  1. See VoiceRecordingTrackType

StartScreenSharingRequestRequestTypeDef#

# StartScreenSharingRequestRequestTypeDef definition

class StartScreenSharingRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    ClientToken: NotRequired[str],

StopContactRecordingRequestRequestTypeDef#

# StopContactRecordingRequestRequestTypeDef definition

class StopContactRecordingRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    InitialContactId: 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,

TagContactRequestRequestTypeDef#

# TagContactRequestRequestTypeDef definition

class TagContactRequestRequestTypeDef(TypedDict):
    ContactId: str,
    InstanceId: str,
    Tags: Mapping[str, str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

TranscriptCriteriaTypeDef#

# TranscriptCriteriaTypeDef definition

class TranscriptCriteriaTypeDef(TypedDict):
    ParticipantRole: ParticipantRoleType,  # (1)
    SearchText: Sequence[str],
    MatchType: SearchContactsMatchTypeType,  # (2)
  1. See ParticipantRoleType
  2. See SearchContactsMatchTypeType

TransferContactRequestRequestTypeDef#

# TransferContactRequestRequestTypeDef definition

class TransferContactRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    ContactFlowId: str,
    QueueId: NotRequired[str],
    UserId: NotRequired[str],
    ClientToken: NotRequired[str],

UntagContactRequestRequestTypeDef#

# UntagContactRequestRequestTypeDef definition

class UntagContactRequestRequestTypeDef(TypedDict):
    ContactId: str,
    InstanceId: str,
    TagKeys: Sequence[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],
  1. See AgentStatusStateType

UpdateAuthenticationProfileRequestRequestTypeDef#

# UpdateAuthenticationProfileRequestRequestTypeDef definition

class UpdateAuthenticationProfileRequestRequestTypeDef(TypedDict):
    AuthenticationProfileId: str,
    InstanceId: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    AllowedIps: NotRequired[Sequence[str]],
    BlockedIps: NotRequired[Sequence[str]],
    PeriodicSessionDuration: NotRequired[int],

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)
  1. See ContactFlowStateType

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)
  1. See ContactFlowModuleStateType

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,
  1. See InstanceAttributeTypeType

UpdatePhoneNumberMetadataRequestRequestTypeDef#

# UpdatePhoneNumberMetadataRequestRequestTypeDef definition

class UpdatePhoneNumberMetadataRequestRequestTypeDef(TypedDict):
    PhoneNumberId: str,
    PhoneNumberDescription: NotRequired[str],
    ClientToken: NotRequired[str],

UpdatePhoneNumberRequestRequestTypeDef#

# UpdatePhoneNumberRequestRequestTypeDef definition

class UpdatePhoneNumberRequestRequestTypeDef(TypedDict):
    PhoneNumberId: str,
    TargetArn: NotRequired[str],
    InstanceId: NotRequired[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)
  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)
  1. See AgentAvailabilityTimerType

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

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,

UpdateViewMetadataRequestRequestTypeDef#

# UpdateViewMetadataRequestRequestTypeDef definition

class UpdateViewMetadataRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ViewId: str,
    Name: NotRequired[str],
    Description: NotRequired[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],

ViewContentTypeDef#

# ViewContentTypeDef definition

class ViewContentTypeDef(TypedDict):
    InputSchema: NotRequired[str],
    Template: NotRequired[str],
    Actions: NotRequired[List[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,
  1. See EventSourceNameType
  2. See RulePublishStatusType
  3. See ActionSummaryTypeDef

ActivateEvaluationFormResponseTypeDef#

# ActivateEvaluationFormResponseTypeDef definition

class ActivateEvaluationFormResponseTypeDef(TypedDict):
    EvaluationFormId: str,
    EvaluationFormArn: str,
    EvaluationFormVersion: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AssociateAnalyticsDataSetResponseTypeDef#

# AssociateAnalyticsDataSetResponseTypeDef definition

class AssociateAnalyticsDataSetResponseTypeDef(TypedDict):
    DataSetId: str,
    TargetAccountId: str,
    ResourceShareId: str,
    ResourceShareArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AssociateInstanceStorageConfigResponseTypeDef#

# AssociateInstanceStorageConfigResponseTypeDef definition

class AssociateInstanceStorageConfigResponseTypeDef(TypedDict):
    AssociationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AssociateSecurityKeyResponseTypeDef#

# AssociateSecurityKeyResponseTypeDef definition

class AssociateSecurityKeyResponseTypeDef(TypedDict):
    AssociationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ClaimPhoneNumberResponseTypeDef#

# ClaimPhoneNumberResponseTypeDef definition

class ClaimPhoneNumberResponseTypeDef(TypedDict):
    PhoneNumberId: str,
    PhoneNumberArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateAgentStatusResponseTypeDef#

# CreateAgentStatusResponseTypeDef definition

class CreateAgentStatusResponseTypeDef(TypedDict):
    AgentStatusARN: str,
    AgentStatusId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateContactFlowModuleResponseTypeDef#

# CreateContactFlowModuleResponseTypeDef definition

class CreateContactFlowModuleResponseTypeDef(TypedDict):
    Id: str,
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateContactFlowResponseTypeDef#

# CreateContactFlowResponseTypeDef definition

class CreateContactFlowResponseTypeDef(TypedDict):
    ContactFlowId: str,
    ContactFlowArn: str,
    FlowContentSha256: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateContactFlowVersionResponseTypeDef#

# CreateContactFlowVersionResponseTypeDef definition

class CreateContactFlowVersionResponseTypeDef(TypedDict):
    ContactFlowArn: str,
    Version: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateEvaluationFormResponseTypeDef#

# CreateEvaluationFormResponseTypeDef definition

class CreateEvaluationFormResponseTypeDef(TypedDict):
    EvaluationFormId: str,
    EvaluationFormArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateHoursOfOperationResponseTypeDef#

# CreateHoursOfOperationResponseTypeDef definition

class CreateHoursOfOperationResponseTypeDef(TypedDict):
    HoursOfOperationId: str,
    HoursOfOperationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateInstanceResponseTypeDef#

# CreateInstanceResponseTypeDef definition

class CreateInstanceResponseTypeDef(TypedDict):
    Id: str,
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateIntegrationAssociationResponseTypeDef#

# CreateIntegrationAssociationResponseTypeDef definition

class CreateIntegrationAssociationResponseTypeDef(TypedDict):
    IntegrationAssociationId: str,
    IntegrationAssociationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePersistentContactAssociationResponseTypeDef#

# CreatePersistentContactAssociationResponseTypeDef definition

class CreatePersistentContactAssociationResponseTypeDef(TypedDict):
    ContinuedFromContactId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePromptResponseTypeDef#

# CreatePromptResponseTypeDef definition

class CreatePromptResponseTypeDef(TypedDict):
    PromptARN: str,
    PromptId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateQueueResponseTypeDef#

# CreateQueueResponseTypeDef definition

class CreateQueueResponseTypeDef(TypedDict):
    QueueArn: str,
    QueueId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateQuickConnectResponseTypeDef#

# CreateQuickConnectResponseTypeDef definition

class CreateQuickConnectResponseTypeDef(TypedDict):
    QuickConnectARN: str,
    QuickConnectId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRoutingProfileResponseTypeDef#

# CreateRoutingProfileResponseTypeDef definition

class CreateRoutingProfileResponseTypeDef(TypedDict):
    RoutingProfileArn: str,
    RoutingProfileId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRuleResponseTypeDef#

# CreateRuleResponseTypeDef definition

class CreateRuleResponseTypeDef(TypedDict):
    RuleArn: str,
    RuleId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSecurityProfileResponseTypeDef#

# CreateSecurityProfileResponseTypeDef definition

class CreateSecurityProfileResponseTypeDef(TypedDict):
    SecurityProfileId: str,
    SecurityProfileArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTaskTemplateResponseTypeDef#

# CreateTaskTemplateResponseTypeDef definition

class CreateTaskTemplateResponseTypeDef(TypedDict):
    Id: str,
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTrafficDistributionGroupResponseTypeDef#

# CreateTrafficDistributionGroupResponseTypeDef definition

class CreateTrafficDistributionGroupResponseTypeDef(TypedDict):
    Id: str,
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUseCaseResponseTypeDef#

# CreateUseCaseResponseTypeDef definition

class CreateUseCaseResponseTypeDef(TypedDict):
    UseCaseId: str,
    UseCaseArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUserHierarchyGroupResponseTypeDef#

# CreateUserHierarchyGroupResponseTypeDef definition

class CreateUserHierarchyGroupResponseTypeDef(TypedDict):
    HierarchyGroupId: str,
    HierarchyGroupArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUserResponseTypeDef#

# CreateUserResponseTypeDef definition

class CreateUserResponseTypeDef(TypedDict):
    UserId: str,
    UserArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateVocabularyResponseTypeDef#

# CreateVocabularyResponseTypeDef definition

class CreateVocabularyResponseTypeDef(TypedDict):
    VocabularyArn: str,
    VocabularyId: str,
    State: VocabularyStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VocabularyStateType
  2. See ResponseMetadataTypeDef

DeactivateEvaluationFormResponseTypeDef#

# DeactivateEvaluationFormResponseTypeDef definition

class DeactivateEvaluationFormResponseTypeDef(TypedDict):
    EvaluationFormId: str,
    EvaluationFormArn: str,
    EvaluationFormVersion: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteVocabularyResponseTypeDef#

# DeleteVocabularyResponseTypeDef definition

class DeleteVocabularyResponseTypeDef(TypedDict):
    VocabularyArn: str,
    VocabularyId: str,
    State: VocabularyStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VocabularyStateType
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetContactAttributesResponseTypeDef#

# GetContactAttributesResponseTypeDef definition

class GetContactAttributesResponseTypeDef(TypedDict):
    Attributes: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetFlowAssociationResponseTypeDef#

# GetFlowAssociationResponseTypeDef definition

class GetFlowAssociationResponseTypeDef(TypedDict):
    ResourceId: str,
    FlowId: str,
    ResourceType: FlowAssociationResourceTypeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowAssociationResourceTypeType
  2. See ResponseMetadataTypeDef

GetPromptFileResponseTypeDef#

# GetPromptFileResponseTypeDef definition

class GetPromptFileResponseTypeDef(TypedDict):
    PromptPresignedUrl: str,
    LastModifiedTime: datetime,
    LastModifiedRegion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ImportPhoneNumberResponseTypeDef#

# ImportPhoneNumberResponseTypeDef definition

class ImportPhoneNumberResponseTypeDef(TypedDict):
    PhoneNumberId: str,
    PhoneNumberArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListApprovedOriginsResponseTypeDef#

# ListApprovedOriginsResponseTypeDef definition

class ListApprovedOriginsResponseTypeDef(TypedDict):
    Origins: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    NextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListLambdaFunctionsResponseTypeDef#

# ListLambdaFunctionsResponseTypeDef definition

class ListLambdaFunctionsResponseTypeDef(TypedDict):
    LambdaFunctions: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    NextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListSecurityProfilePermissionsResponseTypeDef#

# ListSecurityProfilePermissionsResponseTypeDef definition

class ListSecurityProfilePermissionsResponseTypeDef(TypedDict):
    Permissions: List[str],
    LastModifiedTime: datetime,
    LastModifiedRegion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    NextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

MonitorContactResponseTypeDef#

# MonitorContactResponseTypeDef definition

class MonitorContactResponseTypeDef(TypedDict):
    ContactId: str,
    ContactArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ReplicateInstanceResponseTypeDef#

# ReplicateInstanceResponseTypeDef definition

class ReplicateInstanceResponseTypeDef(TypedDict):
    Id: str,
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SendChatIntegrationEventResponseTypeDef#

# SendChatIntegrationEventResponseTypeDef definition

class SendChatIntegrationEventResponseTypeDef(TypedDict):
    InitialContactId: str,
    NewChatCreated: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartChatContactResponseTypeDef#

# StartChatContactResponseTypeDef definition

class StartChatContactResponseTypeDef(TypedDict):
    ContactId: str,
    ParticipantId: str,
    ParticipantToken: str,
    ContinuedFromContactId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartContactEvaluationResponseTypeDef#

# StartContactEvaluationResponseTypeDef definition

class StartContactEvaluationResponseTypeDef(TypedDict):
    EvaluationId: str,
    EvaluationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartContactStreamingResponseTypeDef#

# StartContactStreamingResponseTypeDef definition

class StartContactStreamingResponseTypeDef(TypedDict):
    StreamingId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartOutboundChatContactResponseTypeDef#

# StartOutboundChatContactResponseTypeDef definition

class StartOutboundChatContactResponseTypeDef(TypedDict):
    ContactId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartOutboundVoiceContactResponseTypeDef#

# StartOutboundVoiceContactResponseTypeDef definition

class StartOutboundVoiceContactResponseTypeDef(TypedDict):
    ContactId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartTaskContactResponseTypeDef#

# StartTaskContactResponseTypeDef definition

class StartTaskContactResponseTypeDef(TypedDict):
    ContactId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SubmitContactEvaluationResponseTypeDef#

# SubmitContactEvaluationResponseTypeDef definition

class SubmitContactEvaluationResponseTypeDef(TypedDict):
    EvaluationId: str,
    EvaluationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TransferContactResponseTypeDef#

# TransferContactResponseTypeDef definition

class TransferContactResponseTypeDef(TypedDict):
    ContactId: str,
    ContactArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateContactEvaluationResponseTypeDef#

# UpdateContactEvaluationResponseTypeDef definition

class UpdateContactEvaluationResponseTypeDef(TypedDict):
    EvaluationId: str,
    EvaluationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateEvaluationFormResponseTypeDef#

# UpdateEvaluationFormResponseTypeDef definition

class UpdateEvaluationFormResponseTypeDef(TypedDict):
    EvaluationFormId: str,
    EvaluationFormArn: str,
    EvaluationFormVersion: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdatePhoneNumberResponseTypeDef#

# UpdatePhoneNumberResponseTypeDef definition

class UpdatePhoneNumberResponseTypeDef(TypedDict):
    PhoneNumberId: str,
    PhoneNumberArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdatePromptResponseTypeDef#

# UpdatePromptResponseTypeDef definition

class UpdatePromptResponseTypeDef(TypedDict):
    PromptARN: str,
    PromptId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AgentConfigOutputTypeDef#

# AgentConfigOutputTypeDef definition

class AgentConfigOutputTypeDef(TypedDict):
    Distributions: List[DistributionTypeDef],  # (1)
  1. See DistributionTypeDef

AgentConfigTypeDef#

# AgentConfigTypeDef definition

class AgentConfigTypeDef(TypedDict):
    Distributions: Sequence[DistributionTypeDef],  # (1)
  1. See DistributionTypeDef

TelephonyConfigOutputTypeDef#

# TelephonyConfigOutputTypeDef definition

class TelephonyConfigOutputTypeDef(TypedDict):
    Distributions: List[DistributionTypeDef],  # (1)
  1. See DistributionTypeDef

TelephonyConfigTypeDef#

# TelephonyConfigTypeDef definition

class TelephonyConfigTypeDef(TypedDict):
    Distributions: Sequence[DistributionTypeDef],  # (1)
  1. See DistributionTypeDef

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)
  1. See ChannelType
  2. See ContactInitiationMethodType
  3. See ContactStateType
  4. See QueueReferenceTypeDef

HierarchyGroupsTypeDef#

# HierarchyGroupsTypeDef definition

class HierarchyGroupsTypeDef(TypedDict):
    Level1: NotRequired[AgentHierarchyGroupTypeDef],  # (1)
    Level2: NotRequired[AgentHierarchyGroupTypeDef],  # (1)
    Level3: NotRequired[AgentHierarchyGroupTypeDef],  # (1)
    Level4: NotRequired[AgentHierarchyGroupTypeDef],  # (1)
    Level5: NotRequired[AgentHierarchyGroupTypeDef],  # (1)
  1. See AgentHierarchyGroupTypeDef
  2. See AgentHierarchyGroupTypeDef
  3. See AgentHierarchyGroupTypeDef
  4. See AgentHierarchyGroupTypeDef
  5. See AgentHierarchyGroupTypeDef

AllowedCapabilitiesTypeDef#

# AllowedCapabilitiesTypeDef definition

class AllowedCapabilitiesTypeDef(TypedDict):
    Customer: NotRequired[ParticipantCapabilitiesTypeDef],  # (1)
    Agent: NotRequired[ParticipantCapabilitiesTypeDef],  # (1)
  1. See ParticipantCapabilitiesTypeDef
  2. See ParticipantCapabilitiesTypeDef

CustomerTypeDef#

# CustomerTypeDef definition

class CustomerTypeDef(TypedDict):
    DeviceInfo: NotRequired[DeviceInfoTypeDef],  # (1)
    Capabilities: NotRequired[ParticipantCapabilitiesTypeDef],  # (2)
  1. See DeviceInfoTypeDef
  2. See ParticipantCapabilitiesTypeDef

AgentQualityMetricsTypeDef#

# AgentQualityMetricsTypeDef definition

class AgentQualityMetricsTypeDef(TypedDict):
    Audio: NotRequired[AudioQualityMetricsInfoTypeDef],  # (1)
  1. See AudioQualityMetricsInfoTypeDef

CustomerQualityMetricsTypeDef#

# CustomerQualityMetricsTypeDef definition

class CustomerQualityMetricsTypeDef(TypedDict):
    Audio: NotRequired[AudioQualityMetricsInfoTypeDef],  # (1)
  1. See AudioQualityMetricsInfoTypeDef

AgentStatusSearchCriteriaPaginatorTypeDef#

# AgentStatusSearchCriteriaPaginatorTypeDef definition

class AgentStatusSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

AgentStatusSearchCriteriaTypeDef#

# AgentStatusSearchCriteriaTypeDef definition

class AgentStatusSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

ContactFlowModuleSearchCriteriaPaginatorTypeDef#

# ContactFlowModuleSearchCriteriaPaginatorTypeDef definition

class ContactFlowModuleSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

ContactFlowModuleSearchCriteriaTypeDef#

# ContactFlowModuleSearchCriteriaTypeDef definition

class ContactFlowModuleSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

ContactFlowSearchCriteriaPaginatorTypeDef#

# ContactFlowSearchCriteriaPaginatorTypeDef definition

class ContactFlowSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
    TypeCondition: NotRequired[ContactFlowTypeType],  # (2)
    StateCondition: NotRequired[ContactFlowStateType],  # (3)
    StatusCondition: NotRequired[ContactFlowStatusType],  # (4)
  1. See StringConditionTypeDef
  2. See ContactFlowTypeType
  3. See ContactFlowStateType
  4. See ContactFlowStatusType

ContactFlowSearchCriteriaTypeDef#

# ContactFlowSearchCriteriaTypeDef definition

class ContactFlowSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
    TypeCondition: NotRequired[ContactFlowTypeType],  # (2)
    StateCondition: NotRequired[ContactFlowStateType],  # (3)
    StatusCondition: NotRequired[ContactFlowStatusType],  # (4)
  1. See StringConditionTypeDef
  2. See ContactFlowTypeType
  3. See ContactFlowStateType
  4. See ContactFlowStatusType

HoursOfOperationSearchCriteriaPaginatorTypeDef#

# HoursOfOperationSearchCriteriaPaginatorTypeDef definition

class HoursOfOperationSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

HoursOfOperationSearchCriteriaTypeDef#

# HoursOfOperationSearchCriteriaTypeDef definition

class HoursOfOperationSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

PredefinedAttributeSearchCriteriaPaginatorTypeDef#

# PredefinedAttributeSearchCriteriaPaginatorTypeDef definition

class PredefinedAttributeSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

PredefinedAttributeSearchCriteriaTypeDef#

# PredefinedAttributeSearchCriteriaTypeDef definition

class PredefinedAttributeSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

PromptSearchCriteriaPaginatorTypeDef#

# PromptSearchCriteriaPaginatorTypeDef definition

class PromptSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

PromptSearchCriteriaTypeDef#

# PromptSearchCriteriaTypeDef definition

class PromptSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

QueueSearchCriteriaPaginatorTypeDef#

# QueueSearchCriteriaPaginatorTypeDef definition

class QueueSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
    QueueTypeCondition: NotRequired[SearchableQueueTypeType],  # (2)
  1. See StringConditionTypeDef
  2. See SearchableQueueTypeType

QueueSearchCriteriaTypeDef#

# QueueSearchCriteriaTypeDef definition

class QueueSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
    QueueTypeCondition: NotRequired[SearchableQueueTypeType],  # (2)
  1. See StringConditionTypeDef
  2. See SearchableQueueTypeType

QuickConnectSearchCriteriaPaginatorTypeDef#

# QuickConnectSearchCriteriaPaginatorTypeDef definition

class QuickConnectSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

QuickConnectSearchCriteriaTypeDef#

# QuickConnectSearchCriteriaTypeDef definition

class QuickConnectSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

RoutingProfileSearchCriteriaPaginatorTypeDef#

# RoutingProfileSearchCriteriaPaginatorTypeDef definition

class RoutingProfileSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

RoutingProfileSearchCriteriaTypeDef#

# RoutingProfileSearchCriteriaTypeDef definition

class RoutingProfileSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

SecurityProfileSearchCriteriaPaginatorTypeDef#

# SecurityProfileSearchCriteriaPaginatorTypeDef definition

class SecurityProfileSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

SecurityProfileSearchCriteriaTypeDef#

# SecurityProfileSearchCriteriaTypeDef definition

class SecurityProfileSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

UserHierarchyGroupSearchCriteriaPaginatorTypeDef#

# UserHierarchyGroupSearchCriteriaPaginatorTypeDef definition

class UserHierarchyGroupSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

UserHierarchyGroupSearchCriteriaTypeDef#

# UserHierarchyGroupSearchCriteriaTypeDef definition

class UserHierarchyGroupSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
  1. See StringConditionTypeDef

ListAgentStatusResponseTypeDef#

# ListAgentStatusResponseTypeDef definition

class ListAgentStatusResponseTypeDef(TypedDict):
    AgentStatusSummaryList: List[AgentStatusSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AgentStatusSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeAgentStatusResponseTypeDef#

# DescribeAgentStatusResponseTypeDef definition

class DescribeAgentStatusResponseTypeDef(TypedDict):
    AgentStatus: AgentStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentStatusTypeDef
  2. See ResponseMetadataTypeDef

SearchAgentStatusesResponseTypeDef#

# SearchAgentStatusesResponseTypeDef definition

class SearchAgentStatusesResponseTypeDef(TypedDict):
    AgentStatuses: List[AgentStatusTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AgentStatusTypeDef
  2. See ResponseMetadataTypeDef

MatchCriteriaOutputTypeDef#

# MatchCriteriaOutputTypeDef definition

class MatchCriteriaOutputTypeDef(TypedDict):
    AgentsCriteria: NotRequired[AgentsCriteriaOutputTypeDef],  # (1)
  1. See AgentsCriteriaOutputTypeDef

ListAnalyticsDataAssociationsResponseTypeDef#

# ListAnalyticsDataAssociationsResponseTypeDef definition

class ListAnalyticsDataAssociationsResponseTypeDef(TypedDict):
    Results: List[AnalyticsDataAssociationResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AnalyticsDataAssociationResultTypeDef
  2. See ResponseMetadataTypeDef

ListSecurityProfileApplicationsResponseTypeDef#

# ListSecurityProfileApplicationsResponseTypeDef definition

class ListSecurityProfileApplicationsResponseTypeDef(TypedDict):
    Applications: List[ApplicationOutputTypeDef],  # (1)
    LastModifiedTime: datetime,
    LastModifiedRegion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ApplicationOutputTypeDef
  2. See ResponseMetadataTypeDef

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]],
    Applications: NotRequired[Sequence[ApplicationTypeDef]],  # (1)
    HierarchyRestrictedResources: NotRequired[Sequence[str]],
    AllowedAccessControlHierarchyGroupId: NotRequired[str],
  1. See ApplicationTypeDef

AssociateLexBotRequestRequestTypeDef#

# AssociateLexBotRequestRequestTypeDef definition

class AssociateLexBotRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    LexBot: LexBotTypeDef,  # (1)
  1. See LexBotTypeDef

ListLexBotsResponseTypeDef#

# ListLexBotsResponseTypeDef definition

class ListLexBotsResponseTypeDef(TypedDict):
    LexBots: List[LexBotTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See LexBotTypeDef
  2. See ResponseMetadataTypeDef

AssociateBotRequestRequestTypeDef#

# AssociateBotRequestRequestTypeDef definition

class AssociateBotRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    LexBot: NotRequired[LexBotTypeDef],  # (1)
    LexV2Bot: NotRequired[LexV2BotTypeDef],  # (2)
  1. See LexBotTypeDef
  2. See LexV2BotTypeDef

DisassociateBotRequestRequestTypeDef#

# DisassociateBotRequestRequestTypeDef definition

class DisassociateBotRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    LexBot: NotRequired[LexBotTypeDef],  # (1)
    LexV2Bot: NotRequired[LexV2BotTypeDef],  # (2)
  1. See LexBotTypeDef
  2. See LexV2BotTypeDef

LexBotConfigTypeDef#

# LexBotConfigTypeDef definition

class LexBotConfigTypeDef(TypedDict):
    LexBot: NotRequired[LexBotTypeDef],  # (1)
    LexV2Bot: NotRequired[LexV2BotTypeDef],  # (2)
  1. See LexBotTypeDef
  2. See LexV2BotTypeDef

AssociateUserProficienciesRequestRequestTypeDef#

# AssociateUserProficienciesRequestRequestTypeDef definition

class AssociateUserProficienciesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    UserId: str,
    UserProficiencies: Sequence[UserProficiencyTypeDef],  # (1)
  1. See UserProficiencyTypeDef

ListUserProficienciesResponseTypeDef#

# ListUserProficienciesResponseTypeDef definition

class ListUserProficienciesResponseTypeDef(TypedDict):
    UserProficiencyList: List[UserProficiencyTypeDef],  # (1)
    LastModifiedTime: datetime,
    LastModifiedRegion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See UserProficiencyTypeDef
  2. See ResponseMetadataTypeDef

UpdateUserProficienciesRequestRequestTypeDef#

# UpdateUserProficienciesRequestRequestTypeDef definition

class UpdateUserProficienciesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    UserId: str,
    UserProficiencies: Sequence[UserProficiencyTypeDef],  # (1)
  1. See UserProficiencyTypeDef

AttachedFileTypeDef#

# AttachedFileTypeDef definition

class AttachedFileTypeDef(TypedDict):
    CreationTime: str,
    FileArn: str,
    FileId: str,
    FileName: str,
    FileSizeInBytes: int,
    FileStatus: FileStatusTypeType,  # (1)
    CreatedBy: NotRequired[CreatedByInfoTypeDef],  # (2)
    FileUseCaseType: NotRequired[FileUseCaseTypeType],  # (3)
    AssociatedResourceArn: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],
  1. See FileStatusTypeType
  2. See CreatedByInfoTypeDef
  3. See FileUseCaseTypeType

StartAttachedFileUploadRequestRequestTypeDef#

# StartAttachedFileUploadRequestRequestTypeDef definition

class StartAttachedFileUploadRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    FileName: str,
    FileSizeInBytes: int,
    FileUseCaseType: FileUseCaseTypeType,  # (1)
    AssociatedResourceArn: str,
    ClientToken: NotRequired[str],
    UrlExpiryInSeconds: NotRequired[int],
    CreatedBy: NotRequired[CreatedByInfoTypeDef],  # (2)
    Tags: NotRequired[Mapping[str, str]],
  1. See FileUseCaseTypeType
  2. See CreatedByInfoTypeDef

AttributeAndConditionTypeDef#

# AttributeAndConditionTypeDef definition

class AttributeAndConditionTypeDef(TypedDict):
    TagConditions: NotRequired[Sequence[TagConditionTypeDef]],  # (1)
    HierarchyGroupCondition: NotRequired[HierarchyGroupConditionTypeDef],  # (2)
  1. See TagConditionTypeDef
  2. See HierarchyGroupConditionTypeDef

CommonAttributeAndConditionTypeDef#

# CommonAttributeAndConditionTypeDef definition

class CommonAttributeAndConditionTypeDef(TypedDict):
    TagConditions: NotRequired[Sequence[TagConditionTypeDef]],  # (1)
  1. See TagConditionTypeDef

ControlPlaneTagFilterTypeDef#

# ControlPlaneTagFilterTypeDef definition

class ControlPlaneTagFilterTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Sequence[TagConditionTypeDef]]],  # (1)
    AndConditions: NotRequired[Sequence[TagConditionTypeDef]],  # (2)
    TagCondition: NotRequired[TagConditionTypeDef],  # (3)
  1. See TagConditionTypeDef
  2. See TagConditionTypeDef
  3. See TagConditionTypeDef

DescribeInstanceAttributeResponseTypeDef#

# DescribeInstanceAttributeResponseTypeDef definition

class DescribeInstanceAttributeResponseTypeDef(TypedDict):
    Attribute: AttributeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AttributeTypeDef
  2. See ResponseMetadataTypeDef

ListInstanceAttributesResponseTypeDef#

# ListInstanceAttributesResponseTypeDef definition

class ListInstanceAttributesResponseTypeDef(TypedDict):
    Attributes: List[AttributeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AttributeTypeDef
  2. See ResponseMetadataTypeDef

MeetingFeaturesConfigurationTypeDef#

# MeetingFeaturesConfigurationTypeDef definition

class MeetingFeaturesConfigurationTypeDef(TypedDict):
    Audio: NotRequired[AudioFeaturesTypeDef],  # (1)
  1. See AudioFeaturesTypeDef

ListAuthenticationProfilesResponseTypeDef#

# ListAuthenticationProfilesResponseTypeDef definition

class ListAuthenticationProfilesResponseTypeDef(TypedDict):
    AuthenticationProfileSummaryList: List[AuthenticationProfileSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AuthenticationProfileSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeAuthenticationProfileResponseTypeDef#

# DescribeAuthenticationProfileResponseTypeDef definition

class DescribeAuthenticationProfileResponseTypeDef(TypedDict):
    AuthenticationProfile: AuthenticationProfileTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AuthenticationProfileTypeDef
  2. See ResponseMetadataTypeDef

SearchAvailablePhoneNumbersResponseTypeDef#

# SearchAvailablePhoneNumbersResponseTypeDef definition

class SearchAvailablePhoneNumbersResponseTypeDef(TypedDict):
    AvailableNumbersList: List[AvailableNumberSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AvailableNumberSummaryTypeDef
  2. See ResponseMetadataTypeDef

BatchAssociateAnalyticsDataSetResponseTypeDef#

# BatchAssociateAnalyticsDataSetResponseTypeDef definition

class BatchAssociateAnalyticsDataSetResponseTypeDef(TypedDict):
    Created: List[AnalyticsDataAssociationResultTypeDef],  # (1)
    Errors: List[ErrorResultTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AnalyticsDataAssociationResultTypeDef
  2. See ErrorResultTypeDef
  3. See ResponseMetadataTypeDef

BatchDisassociateAnalyticsDataSetResponseTypeDef#

# BatchDisassociateAnalyticsDataSetResponseTypeDef definition

class BatchDisassociateAnalyticsDataSetResponseTypeDef(TypedDict):
    Deleted: List[str],
    Errors: List[ErrorResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ErrorResultTypeDef
  2. See ResponseMetadataTypeDef

BatchGetFlowAssociationResponseTypeDef#

# BatchGetFlowAssociationResponseTypeDef definition

class BatchGetFlowAssociationResponseTypeDef(TypedDict):
    FlowAssociationSummaryList: List[FlowAssociationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowAssociationSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListFlowAssociationsResponseTypeDef#

# ListFlowAssociationsResponseTypeDef definition

class ListFlowAssociationsResponseTypeDef(TypedDict):
    FlowAssociationSummaryList: List[FlowAssociationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See FlowAssociationSummaryTypeDef
  2. See ResponseMetadataTypeDef

BatchPutContactResponseTypeDef#

# BatchPutContactResponseTypeDef definition

class BatchPutContactResponseTypeDef(TypedDict):
    SuccessfulRequestList: List[SuccessfulRequestTypeDef],  # (1)
    FailedRequestList: List[FailedRequestTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SuccessfulRequestTypeDef
  2. See FailedRequestTypeDef
  3. See ResponseMetadataTypeDef

StartContactStreamingRequestRequestTypeDef#

# StartContactStreamingRequestRequestTypeDef definition

class StartContactStreamingRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    ChatStreamingConfiguration: ChatStreamingConfigurationTypeDef,  # (1)
    ClientToken: str,
  1. See ChatStreamingConfigurationTypeDef

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],
    InstanceId: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],
    PhoneNumberStatus: NotRequired[PhoneNumberStatusTypeDef],  # (3)
    SourcePhoneNumberArn: NotRequired[str],
  1. See PhoneNumberCountryCodeType
  2. See PhoneNumberTypeType
  3. See PhoneNumberStatusTypeDef

ConditionTypeDef#

# ConditionTypeDef definition

class ConditionTypeDef(TypedDict):
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
    NumberCondition: NotRequired[NumberConditionTypeDef],  # (2)
  1. See StringConditionTypeDef
  2. See NumberConditionTypeDef

ContactDataRequestTypeDef#

# ContactDataRequestTypeDef definition

class ContactDataRequestTypeDef(TypedDict):
    SystemEndpoint: NotRequired[EndpointTypeDef],  # (1)
    CustomerEndpoint: NotRequired[EndpointTypeDef],  # (1)
    RequestIdentifier: NotRequired[str],
    QueueId: NotRequired[str],
    Attributes: NotRequired[Mapping[str, str]],
    Campaign: NotRequired[CampaignTypeDef],  # (3)
  1. See EndpointTypeDef
  2. See EndpointTypeDef
  3. See CampaignTypeDef

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]],
  1. See ContactFilterTypeDef

ListContactFlowModulesResponseTypeDef#

# ListContactFlowModulesResponseTypeDef definition

class ListContactFlowModulesResponseTypeDef(TypedDict):
    ContactFlowModulesSummaryList: List[ContactFlowModuleSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ContactFlowModuleSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeContactFlowModuleResponseTypeDef#

# DescribeContactFlowModuleResponseTypeDef definition

class DescribeContactFlowModuleResponseTypeDef(TypedDict):
    ContactFlowModule: ContactFlowModuleTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContactFlowModuleTypeDef
  2. See ResponseMetadataTypeDef

SearchContactFlowModulesResponseTypeDef#

# SearchContactFlowModulesResponseTypeDef definition

class SearchContactFlowModulesResponseTypeDef(TypedDict):
    ContactFlowModules: List[ContactFlowModuleTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ContactFlowModuleTypeDef
  2. See ResponseMetadataTypeDef

ListContactFlowsResponseTypeDef#

# ListContactFlowsResponseTypeDef definition

class ListContactFlowsResponseTypeDef(TypedDict):
    ContactFlowSummaryList: List[ContactFlowSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ContactFlowSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeContactFlowResponseTypeDef#

# DescribeContactFlowResponseTypeDef definition

class DescribeContactFlowResponseTypeDef(TypedDict):
    ContactFlow: ContactFlowTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContactFlowTypeDef
  2. See ResponseMetadataTypeDef

SearchContactFlowsResponseTypeDef#

# SearchContactFlowsResponseTypeDef definition

class SearchContactFlowsResponseTypeDef(TypedDict):
    ContactFlows: List[ContactFlowTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ContactFlowTypeDef
  2. See ResponseMetadataTypeDef

ListContactFlowVersionsResponseTypeDef#

# ListContactFlowVersionsResponseTypeDef definition

class ListContactFlowVersionsResponseTypeDef(TypedDict):
    ContactFlowVersionSummaryList: List[ContactFlowVersionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ContactFlowVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ContactSearchSummaryTypeDef#

# ContactSearchSummaryTypeDef definition

class ContactSearchSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    Id: NotRequired[str],
    InitialContactId: NotRequired[str],
    PreviousContactId: NotRequired[str],
    InitiationMethod: NotRequired[ContactInitiationMethodType],  # (1)
    Channel: NotRequired[ChannelType],  # (2)
    QueueInfo: NotRequired[ContactSearchSummaryQueueInfoTypeDef],  # (3)
    AgentInfo: NotRequired[ContactSearchSummaryAgentInfoTypeDef],  # (4)
    InitiationTimestamp: NotRequired[datetime],
    DisconnectTimestamp: NotRequired[datetime],
    ScheduledTimestamp: NotRequired[datetime],
  1. See ContactInitiationMethodType
  2. See ChannelType
  3. See ContactSearchSummaryQueueInfoTypeDef
  4. See ContactSearchSummaryAgentInfoTypeDef

CreateContactFlowVersionRequestRequestTypeDef#

# CreateContactFlowVersionRequestRequestTypeDef definition

class CreateContactFlowVersionRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactFlowId: str,
    Description: NotRequired[str],
    FlowContentSha256: NotRequired[str],
    LastModifiedTime: NotRequired[TimestampTypeDef],
    LastModifiedRegion: NotRequired[str],

SearchContactsTimeRangeTypeDef#

# SearchContactsTimeRangeTypeDef definition

class SearchContactsTimeRangeTypeDef(TypedDict):
    Type: SearchContactsTimeRangeTypeType,  # (1)
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
  1. See SearchContactsTimeRangeTypeType

UpdateContactScheduleRequestRequestTypeDef#

# UpdateContactScheduleRequestRequestTypeDef definition

class UpdateContactScheduleRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    ScheduledTime: TimestampTypeDef,

CreateParticipantRequestRequestTypeDef#

# CreateParticipantRequestRequestTypeDef definition

class CreateParticipantRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    ParticipantDetails: ParticipantDetailsToAddTypeDef,  # (1)
    ClientToken: NotRequired[str],
  1. See ParticipantDetailsToAddTypeDef

CreateParticipantResponseTypeDef#

# CreateParticipantResponseTypeDef definition

class CreateParticipantResponseTypeDef(TypedDict):
    ParticipantCredentials: ParticipantTokenCredentialsTypeDef,  # (1)
    ParticipantId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ParticipantTokenCredentialsTypeDef
  2. See ResponseMetadataTypeDef

CreatePredefinedAttributeRequestRequestTypeDef#

# CreatePredefinedAttributeRequestRequestTypeDef definition

class CreatePredefinedAttributeRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Name: str,
    Values: PredefinedAttributeValuesTypeDef,  # (1)
  1. See PredefinedAttributeValuesTypeDef

UpdatePredefinedAttributeRequestRequestTypeDef#

# UpdatePredefinedAttributeRequestRequestTypeDef definition

class UpdatePredefinedAttributeRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Name: str,
    Values: NotRequired[PredefinedAttributeValuesTypeDef],  # (1)
  1. See PredefinedAttributeValuesTypeDef

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]],
  1. See OutboundCallerConfigTypeDef

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]],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
  1. See OutboundCallerConfigTypeDef
  2. See QueueStatusType

UpdateQueueOutboundCallerConfigRequestRequestTypeDef#

# UpdateQueueOutboundCallerConfigRequestRequestTypeDef definition

class UpdateQueueOutboundCallerConfigRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    QueueId: str,
    OutboundCallerConfig: OutboundCallerConfigTypeDef,  # (1)
  1. See OutboundCallerConfigTypeDef

UpdateUserIdentityInfoRequestRequestTypeDef#

# UpdateUserIdentityInfoRequestRequestTypeDef definition

class UpdateUserIdentityInfoRequestRequestTypeDef(TypedDict):
    IdentityInfo: UserIdentityInfoTypeDef,  # (1)
    UserId: str,
    InstanceId: str,
  1. See UserIdentityInfoTypeDef

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]],
  1. See UserPhoneConfigTypeDef
  2. See UserIdentityInfoTypeDef

UpdateUserPhoneConfigRequestRequestTypeDef#

# UpdateUserPhoneConfigRequestRequestTypeDef definition

class UpdateUserPhoneConfigRequestRequestTypeDef(TypedDict):
    PhoneConfig: UserPhoneConfigTypeDef,  # (1)
    UserId: str,
    InstanceId: str,
  1. See UserPhoneConfigTypeDef

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]],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
  1. See UserIdentityInfoTypeDef
  2. See UserPhoneConfigTypeDef

CreateViewRequestRequestTypeDef#

# CreateViewRequestRequestTypeDef definition

class CreateViewRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Status: ViewStatusType,  # (1)
    Content: ViewInputContentTypeDef,  # (2)
    Name: str,
    ClientToken: NotRequired[str],
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See ViewStatusType
  2. See ViewInputContentTypeDef

UpdateViewContentRequestRequestTypeDef#

# UpdateViewContentRequestRequestTypeDef definition

class UpdateViewContentRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ViewId: str,
    Status: ViewStatusType,  # (1)
    Content: ViewInputContentTypeDef,  # (2)
  1. See ViewStatusType
  2. See ViewInputContentTypeDef

GetFederationTokenResponseTypeDef#

# GetFederationTokenResponseTypeDef definition

class GetFederationTokenResponseTypeDef(TypedDict):
    Credentials: CredentialsTypeDef,  # (1)
    SignInUrl: str,
    UserArn: str,
    UserId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CredentialsTypeDef
  2. See ResponseMetadataTypeDef

MediaConcurrencyTypeDef#

# MediaConcurrencyTypeDef definition

class MediaConcurrencyTypeDef(TypedDict):
    Channel: ChannelType,  # (1)
    Concurrency: int,
    CrossChannelBehavior: NotRequired[CrossChannelBehaviorTypeDef],  # (2)
  1. See ChannelType
  2. See CrossChannelBehaviorTypeDef

CurrentMetricDataTypeDef#

# CurrentMetricDataTypeDef definition

class CurrentMetricDataTypeDef(TypedDict):
    Metric: NotRequired[CurrentMetricTypeDef],  # (1)
    Value: NotRequired[float],
  1. See CurrentMetricTypeDef

ListDefaultVocabulariesResponseTypeDef#

# ListDefaultVocabulariesResponseTypeDef definition

class ListDefaultVocabulariesResponseTypeDef(TypedDict):
    DefaultVocabularyList: List[DefaultVocabularyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See DefaultVocabularyTypeDef
  2. See ResponseMetadataTypeDef

DescribePromptResponseTypeDef#

# DescribePromptResponseTypeDef definition

class DescribePromptResponseTypeDef(TypedDict):
    Prompt: PromptTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PromptTypeDef
  2. See ResponseMetadataTypeDef

SearchPromptsResponseTypeDef#

# SearchPromptsResponseTypeDef definition

class SearchPromptsResponseTypeDef(TypedDict):
    Prompts: List[PromptTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See PromptTypeDef
  2. See ResponseMetadataTypeDef

DescribeSecurityProfileResponseTypeDef#

# DescribeSecurityProfileResponseTypeDef definition

class DescribeSecurityProfileResponseTypeDef(TypedDict):
    SecurityProfile: SecurityProfileTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SecurityProfileTypeDef
  2. See ResponseMetadataTypeDef

DescribeTrafficDistributionGroupResponseTypeDef#

# DescribeTrafficDistributionGroupResponseTypeDef definition

class DescribeTrafficDistributionGroupResponseTypeDef(TypedDict):
    TrafficDistributionGroup: TrafficDistributionGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TrafficDistributionGroupTypeDef
  2. See ResponseMetadataTypeDef

DescribeVocabularyResponseTypeDef#

# DescribeVocabularyResponseTypeDef definition

class DescribeVocabularyResponseTypeDef(TypedDict):
    Vocabulary: VocabularyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VocabularyTypeDef
  2. See ResponseMetadataTypeDef

DimensionsTypeDef#

# DimensionsTypeDef definition

class DimensionsTypeDef(TypedDict):
    Queue: NotRequired[QueueReferenceTypeDef],  # (1)
    Channel: NotRequired[ChannelType],  # (2)
    RoutingProfile: NotRequired[RoutingProfileReferenceTypeDef],  # (3)
    RoutingStepExpression: NotRequired[str],
  1. See QueueReferenceTypeDef
  2. See ChannelType
  3. See RoutingProfileReferenceTypeDef

DisassociateRoutingProfileQueuesRequestRequestTypeDef#

# DisassociateRoutingProfileQueuesRequestRequestTypeDef definition

class DisassociateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    RoutingProfileId: str,
    QueueReferences: Sequence[RoutingProfileQueueReferenceTypeDef],  # (1)
  1. See RoutingProfileQueueReferenceTypeDef

RoutingProfileQueueConfigTypeDef#

# RoutingProfileQueueConfigTypeDef definition

class RoutingProfileQueueConfigTypeDef(TypedDict):
    QueueReference: RoutingProfileQueueReferenceTypeDef,  # (1)
    Priority: int,
    Delay: int,
  1. See RoutingProfileQueueReferenceTypeDef

DisassociateUserProficienciesRequestRequestTypeDef#

# DisassociateUserProficienciesRequestRequestTypeDef definition

class DisassociateUserProficienciesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    UserId: str,
    UserProficiencies: Sequence[UserProficiencyDisassociateTypeDef],  # (1)
  1. See UserProficiencyDisassociateTypeDef

StopContactRequestRequestTypeDef#

# StopContactRequestRequestTypeDef definition

class StopContactRequestRequestTypeDef(TypedDict):
    ContactId: str,
    InstanceId: str,
    DisconnectReason: NotRequired[DisconnectReasonTypeDef],  # (1)
  1. See DisconnectReasonTypeDef

GetAttachedFileResponseTypeDef#

# GetAttachedFileResponseTypeDef definition

class GetAttachedFileResponseTypeDef(TypedDict):
    FileArn: str,
    FileId: str,
    CreationTime: str,
    FileStatus: FileStatusTypeType,  # (1)
    FileName: str,
    FileSizeInBytes: int,
    AssociatedResourceArn: str,
    FileUseCaseType: FileUseCaseTypeType,  # (2)
    CreatedBy: CreatedByInfoTypeDef,  # (3)
    DownloadUrlMetadata: DownloadUrlMetadataTypeDef,  # (4)
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See FileStatusTypeType
  2. See FileUseCaseTypeType
  3. See CreatedByInfoTypeDef
  4. See DownloadUrlMetadataTypeDef
  5. See ResponseMetadataTypeDef

KinesisVideoStreamConfigTypeDef#

# KinesisVideoStreamConfigTypeDef definition

class KinesisVideoStreamConfigTypeDef(TypedDict):
    Prefix: str,
    RetentionPeriodHours: int,
    EncryptionConfig: EncryptionConfigTypeDef,  # (1)
  1. See EncryptionConfigTypeDef

S3ConfigTypeDef#

# S3ConfigTypeDef definition

class S3ConfigTypeDef(TypedDict):
    BucketName: str,
    BucketPrefix: str,
    EncryptionConfig: NotRequired[EncryptionConfigTypeDef],  # (1)
  1. See EncryptionConfigTypeDef

EvaluationAnswerInputTypeDef#

# EvaluationAnswerInputTypeDef definition

class EvaluationAnswerInputTypeDef(TypedDict):
    Value: NotRequired[EvaluationAnswerDataTypeDef],  # (1)
  1. See EvaluationAnswerDataTypeDef

EvaluationAnswerOutputTypeDef#

# EvaluationAnswerOutputTypeDef definition

class EvaluationAnswerOutputTypeDef(TypedDict):
    Value: NotRequired[EvaluationAnswerDataTypeDef],  # (1)
    SystemSuggestedValue: NotRequired[EvaluationAnswerDataTypeDef],  # (1)
  1. See EvaluationAnswerDataTypeDef
  2. See EvaluationAnswerDataTypeDef

EvaluationFormNumericQuestionAutomationTypeDef#

# EvaluationFormNumericQuestionAutomationTypeDef definition

class EvaluationFormNumericQuestionAutomationTypeDef(TypedDict):
    PropertyValue: NotRequired[NumericQuestionPropertyValueAutomationTypeDef],  # (1)
  1. See NumericQuestionPropertyValueAutomationTypeDef

EvaluationFormSingleSelectQuestionAutomationOptionTypeDef#

# EvaluationFormSingleSelectQuestionAutomationOptionTypeDef definition

class EvaluationFormSingleSelectQuestionAutomationOptionTypeDef(TypedDict):
    RuleCategory: NotRequired[SingleSelectQuestionRuleCategoryAutomationTypeDef],  # (1)
  1. See SingleSelectQuestionRuleCategoryAutomationTypeDef

ListEvaluationFormsResponseTypeDef#

# ListEvaluationFormsResponseTypeDef definition

class ListEvaluationFormsResponseTypeDef(TypedDict):
    EvaluationFormSummaryList: List[EvaluationFormSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See EvaluationFormSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListEvaluationFormVersionsResponseTypeDef#

# ListEvaluationFormVersionsResponseTypeDef definition

class ListEvaluationFormVersionsResponseTypeDef(TypedDict):
    EvaluationFormVersionSummaryList: List[EvaluationFormVersionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See EvaluationFormVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef

EvaluationMetadataTypeDef#

# EvaluationMetadataTypeDef definition

class EvaluationMetadataTypeDef(TypedDict):
    ContactId: str,
    EvaluatorArn: str,
    ContactAgentId: NotRequired[str],
    Score: NotRequired[EvaluationScoreTypeDef],  # (1)
  1. See EvaluationScoreTypeDef

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)
  1. See EvaluationStatusType
  2. See EvaluationScoreTypeDef

FieldValueOutputTypeDef#

# FieldValueOutputTypeDef definition

class FieldValueOutputTypeDef(TypedDict):
    Id: str,
    Value: FieldValueUnionOutputTypeDef,  # (1)
  1. See FieldValueUnionOutputTypeDef

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)
  1. See FiltersTypeDef
  2. See CurrentMetricTypeDef
  3. See GroupingType
  4. See CurrentMetricSortCriteriaTypeDef

ListAgentStatusRequestListAgentStatusesPaginateTypeDef#

# ListAgentStatusRequestListAgentStatusesPaginateTypeDef definition

class ListAgentStatusRequestListAgentStatusesPaginateTypeDef(TypedDict):
    InstanceId: str,
    AgentStatusTypes: NotRequired[Sequence[AgentStatusTypeType]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See AgentStatusTypeType
  2. See PaginatorConfigTypeDef

ListApprovedOriginsRequestListApprovedOriginsPaginateTypeDef#

# ListApprovedOriginsRequestListApprovedOriginsPaginateTypeDef definition

class ListApprovedOriginsRequestListApprovedOriginsPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAuthenticationProfilesRequestListAuthenticationProfilesPaginateTypeDef#

# ListAuthenticationProfilesRequestListAuthenticationProfilesPaginateTypeDef definition

class ListAuthenticationProfilesRequestListAuthenticationProfilesPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListBotsRequestListBotsPaginateTypeDef#

# ListBotsRequestListBotsPaginateTypeDef definition

class ListBotsRequestListBotsPaginateTypeDef(TypedDict):
    InstanceId: str,
    LexVersion: LexVersionType,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See LexVersionType
  2. See PaginatorConfigTypeDef

ListContactEvaluationsRequestListContactEvaluationsPaginateTypeDef#

# ListContactEvaluationsRequestListContactEvaluationsPaginateTypeDef definition

class ListContactEvaluationsRequestListContactEvaluationsPaginateTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListContactFlowModulesRequestListContactFlowModulesPaginateTypeDef#

# ListContactFlowModulesRequestListContactFlowModulesPaginateTypeDef definition

class ListContactFlowModulesRequestListContactFlowModulesPaginateTypeDef(TypedDict):
    InstanceId: str,
    ContactFlowModuleState: NotRequired[ContactFlowModuleStateType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ContactFlowModuleStateType
  2. See PaginatorConfigTypeDef

ListContactFlowVersionsRequestListContactFlowVersionsPaginateTypeDef#

# ListContactFlowVersionsRequestListContactFlowVersionsPaginateTypeDef definition

class ListContactFlowVersionsRequestListContactFlowVersionsPaginateTypeDef(TypedDict):
    InstanceId: str,
    ContactFlowId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListContactFlowsRequestListContactFlowsPaginateTypeDef#

# ListContactFlowsRequestListContactFlowsPaginateTypeDef definition

class ListContactFlowsRequestListContactFlowsPaginateTypeDef(TypedDict):
    InstanceId: str,
    ContactFlowTypes: NotRequired[Sequence[ContactFlowTypeType]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ContactFlowTypeType
  2. See PaginatorConfigTypeDef

ListContactReferencesRequestListContactReferencesPaginateTypeDef#

# ListContactReferencesRequestListContactReferencesPaginateTypeDef definition

class ListContactReferencesRequestListContactReferencesPaginateTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    ReferenceTypes: Sequence[ReferenceTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ReferenceTypeType
  2. See PaginatorConfigTypeDef

ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateTypeDef#

# ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateTypeDef definition

class ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateTypeDef(TypedDict):
    InstanceId: str,
    LanguageCode: NotRequired[VocabularyLanguageCodeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See VocabularyLanguageCodeType
  2. See PaginatorConfigTypeDef

ListEvaluationFormVersionsRequestListEvaluationFormVersionsPaginateTypeDef#

# ListEvaluationFormVersionsRequestListEvaluationFormVersionsPaginateTypeDef definition

class ListEvaluationFormVersionsRequestListEvaluationFormVersionsPaginateTypeDef(TypedDict):
    InstanceId: str,
    EvaluationFormId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListEvaluationFormsRequestListEvaluationFormsPaginateTypeDef#

# ListEvaluationFormsRequestListEvaluationFormsPaginateTypeDef definition

class ListEvaluationFormsRequestListEvaluationFormsPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListFlowAssociationsRequestListFlowAssociationsPaginateTypeDef#

# ListFlowAssociationsRequestListFlowAssociationsPaginateTypeDef definition

class ListFlowAssociationsRequestListFlowAssociationsPaginateTypeDef(TypedDict):
    InstanceId: str,
    ResourceType: NotRequired[ListFlowAssociationResourceTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ListFlowAssociationResourceTypeType
  2. See PaginatorConfigTypeDef

ListHoursOfOperationsRequestListHoursOfOperationsPaginateTypeDef#

# ListHoursOfOperationsRequestListHoursOfOperationsPaginateTypeDef definition

class ListHoursOfOperationsRequestListHoursOfOperationsPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListInstanceAttributesRequestListInstanceAttributesPaginateTypeDef#

# ListInstanceAttributesRequestListInstanceAttributesPaginateTypeDef definition

class ListInstanceAttributesRequestListInstanceAttributesPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateTypeDef#

# ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateTypeDef definition

class ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateTypeDef(TypedDict):
    InstanceId: str,
    ResourceType: InstanceStorageResourceTypeType,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See InstanceStorageResourceTypeType
  2. See PaginatorConfigTypeDef

ListInstancesRequestListInstancesPaginateTypeDef#

# ListInstancesRequestListInstancesPaginateTypeDef definition

class ListInstancesRequestListInstancesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateTypeDef#

# ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateTypeDef definition

class ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateTypeDef(TypedDict):
    InstanceId: str,
    IntegrationType: NotRequired[IntegrationTypeType],  # (1)
    IntegrationArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See IntegrationTypeType
  2. See PaginatorConfigTypeDef

ListLambdaFunctionsRequestListLambdaFunctionsPaginateTypeDef#

# ListLambdaFunctionsRequestListLambdaFunctionsPaginateTypeDef definition

class ListLambdaFunctionsRequestListLambdaFunctionsPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListLexBotsRequestListLexBotsPaginateTypeDef#

# ListLexBotsRequestListLexBotsPaginateTypeDef definition

class ListLexBotsRequestListLexBotsPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPhoneNumbersRequestListPhoneNumbersPaginateTypeDef#

# ListPhoneNumbersRequestListPhoneNumbersPaginateTypeDef definition

class ListPhoneNumbersRequestListPhoneNumbersPaginateTypeDef(TypedDict):
    InstanceId: str,
    PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]],  # (1)
    PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See PhoneNumberTypeType
  2. See PhoneNumberCountryCodeType
  3. See PaginatorConfigTypeDef

ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateTypeDef#

# ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateTypeDef definition

class ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateTypeDef(TypedDict):
    TargetArn: NotRequired[str],
    InstanceId: NotRequired[str],
    PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]],  # (1)
    PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]],  # (2)
    PhoneNumberPrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See PhoneNumberCountryCodeType
  2. See PhoneNumberTypeType
  3. See PaginatorConfigTypeDef

ListPredefinedAttributesRequestListPredefinedAttributesPaginateTypeDef#

# ListPredefinedAttributesRequestListPredefinedAttributesPaginateTypeDef definition

class ListPredefinedAttributesRequestListPredefinedAttributesPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPromptsRequestListPromptsPaginateTypeDef#

# ListPromptsRequestListPromptsPaginateTypeDef definition

class ListPromptsRequestListPromptsPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateTypeDef#

# ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateTypeDef definition

class ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateTypeDef(TypedDict):
    InstanceId: str,
    QueueId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQueuesRequestListQueuesPaginateTypeDef#

# ListQueuesRequestListQueuesPaginateTypeDef definition

class ListQueuesRequestListQueuesPaginateTypeDef(TypedDict):
    InstanceId: str,
    QueueTypes: NotRequired[Sequence[QueueTypeType]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See QueueTypeType
  2. See PaginatorConfigTypeDef

ListQuickConnectsRequestListQuickConnectsPaginateTypeDef#

# ListQuickConnectsRequestListQuickConnectsPaginateTypeDef definition

class ListQuickConnectsRequestListQuickConnectsPaginateTypeDef(TypedDict):
    InstanceId: str,
    QuickConnectTypes: NotRequired[Sequence[QuickConnectTypeType]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See QuickConnectTypeType
  2. See PaginatorConfigTypeDef

ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateTypeDef#

# ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateTypeDef definition

class ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateTypeDef(TypedDict):
    InstanceId: str,
    RoutingProfileId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRoutingProfilesRequestListRoutingProfilesPaginateTypeDef#

# ListRoutingProfilesRequestListRoutingProfilesPaginateTypeDef definition

class ListRoutingProfilesRequestListRoutingProfilesPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRulesRequestListRulesPaginateTypeDef#

# ListRulesRequestListRulesPaginateTypeDef definition

class ListRulesRequestListRulesPaginateTypeDef(TypedDict):
    InstanceId: str,
    PublishStatus: NotRequired[RulePublishStatusType],  # (1)
    EventSourceName: NotRequired[EventSourceNameType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See RulePublishStatusType
  2. See EventSourceNameType
  3. See PaginatorConfigTypeDef

ListSecurityKeysRequestListSecurityKeysPaginateTypeDef#

# ListSecurityKeysRequestListSecurityKeysPaginateTypeDef definition

class ListSecurityKeysRequestListSecurityKeysPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSecurityProfileApplicationsRequestListSecurityProfileApplicationsPaginateTypeDef#

# ListSecurityProfileApplicationsRequestListSecurityProfileApplicationsPaginateTypeDef definition

class ListSecurityProfileApplicationsRequestListSecurityProfileApplicationsPaginateTypeDef(TypedDict):
    SecurityProfileId: str,
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateTypeDef#

# ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateTypeDef definition

class ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateTypeDef(TypedDict):
    SecurityProfileId: str,
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef#

# ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef definition

class ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTaskTemplatesRequestListTaskTemplatesPaginateTypeDef#

# ListTaskTemplatesRequestListTaskTemplatesPaginateTypeDef definition

class ListTaskTemplatesRequestListTaskTemplatesPaginateTypeDef(TypedDict):
    InstanceId: str,
    Status: NotRequired[TaskTemplateStatusType],  # (1)
    Name: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See TaskTemplateStatusType
  2. See PaginatorConfigTypeDef

ListTrafficDistributionGroupUsersRequestListTrafficDistributionGroupUsersPaginateTypeDef#

# ListTrafficDistributionGroupUsersRequestListTrafficDistributionGroupUsersPaginateTypeDef definition

class ListTrafficDistributionGroupUsersRequestListTrafficDistributionGroupUsersPaginateTypeDef(TypedDict):
    TrafficDistributionGroupId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateTypeDef#

# ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateTypeDef definition

class ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateTypeDef(TypedDict):
    InstanceId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListUseCasesRequestListUseCasesPaginateTypeDef#

# ListUseCasesRequestListUseCasesPaginateTypeDef definition

class ListUseCasesRequestListUseCasesPaginateTypeDef(TypedDict):
    InstanceId: str,
    IntegrationAssociationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateTypeDef#

# ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateTypeDef definition

class ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListUserProficienciesRequestListUserProficienciesPaginateTypeDef#

# ListUserProficienciesRequestListUserProficienciesPaginateTypeDef definition

class ListUserProficienciesRequestListUserProficienciesPaginateTypeDef(TypedDict):
    InstanceId: str,
    UserId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListUsersRequestListUsersPaginateTypeDef#

# ListUsersRequestListUsersPaginateTypeDef definition

class ListUsersRequestListUsersPaginateTypeDef(TypedDict):
    InstanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListViewVersionsRequestListViewVersionsPaginateTypeDef#

# ListViewVersionsRequestListViewVersionsPaginateTypeDef definition

class ListViewVersionsRequestListViewVersionsPaginateTypeDef(TypedDict):
    InstanceId: str,
    ViewId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListViewsRequestListViewsPaginateTypeDef#

# ListViewsRequestListViewsPaginateTypeDef definition

class ListViewsRequestListViewsPaginateTypeDef(TypedDict):
    InstanceId: str,
    Type: NotRequired[ViewTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ViewTypeType
  2. See PaginatorConfigTypeDef

SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateTypeDef#

# SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateTypeDef definition

class SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateTypeDef(TypedDict):
    PhoneNumberCountryCode: PhoneNumberCountryCodeType,  # (1)
    PhoneNumberType: PhoneNumberTypeType,  # (2)
    TargetArn: NotRequired[str],
    InstanceId: NotRequired[str],
    PhoneNumberPrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See PhoneNumberCountryCodeType
  2. See PhoneNumberTypeType
  3. See PaginatorConfigTypeDef

SearchVocabulariesRequestSearchVocabulariesPaginateTypeDef#

# SearchVocabulariesRequestSearchVocabulariesPaginateTypeDef definition

class SearchVocabulariesRequestSearchVocabulariesPaginateTypeDef(TypedDict):
    InstanceId: str,
    State: NotRequired[VocabularyStateType],  # (1)
    NameStartsWith: NotRequired[str],
    LanguageCode: NotRequired[VocabularyLanguageCodeType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See VocabularyStateType
  2. See VocabularyLanguageCodeType
  3. See PaginatorConfigTypeDef

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)
  1. See HierarchyGroupSummaryReferenceTypeDef
  2. See HierarchyGroupSummaryReferenceTypeDef
  3. See HierarchyGroupSummaryReferenceTypeDef
  4. See HierarchyGroupSummaryReferenceTypeDef
  5. 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)
  1. See HierarchyGroupSummaryTypeDef
  2. See HierarchyGroupSummaryTypeDef
  3. See HierarchyGroupSummaryTypeDef
  4. See HierarchyGroupSummaryTypeDef
  5. See HierarchyGroupSummaryTypeDef

ListUserHierarchyGroupsResponseTypeDef#

# ListUserHierarchyGroupsResponseTypeDef definition

class ListUserHierarchyGroupsResponseTypeDef(TypedDict):
    UserHierarchyGroupSummaryList: List[HierarchyGroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See HierarchyGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See HierarchyLevelTypeDef
  2. See HierarchyLevelTypeDef
  3. See HierarchyLevelTypeDef
  4. See HierarchyLevelTypeDef
  5. 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)
  1. See HierarchyLevelUpdateTypeDef
  2. See HierarchyLevelUpdateTypeDef
  3. See HierarchyLevelUpdateTypeDef
  4. See HierarchyLevelUpdateTypeDef
  5. See HierarchyLevelUpdateTypeDef

HistoricalMetricTypeDef#

# HistoricalMetricTypeDef definition

class HistoricalMetricTypeDef(TypedDict):
    Name: NotRequired[HistoricalMetricNameType],  # (1)
    Threshold: NotRequired[ThresholdTypeDef],  # (2)
    Statistic: NotRequired[StatisticType],  # (3)
    Unit: NotRequired[UnitType],  # (4)
  1. See HistoricalMetricNameType
  2. See ThresholdTypeDef
  3. See StatisticType
  4. See UnitType

HoursOfOperationConfigTypeDef#

# HoursOfOperationConfigTypeDef definition

class HoursOfOperationConfigTypeDef(TypedDict):
    Day: HoursOfOperationDaysType,  # (1)
    StartTime: HoursOfOperationTimeSliceTypeDef,  # (2)
    EndTime: HoursOfOperationTimeSliceTypeDef,  # (2)
  1. See HoursOfOperationDaysType
  2. See HoursOfOperationTimeSliceTypeDef
  3. See HoursOfOperationTimeSliceTypeDef

ListHoursOfOperationsResponseTypeDef#

# ListHoursOfOperationsResponseTypeDef definition

class ListHoursOfOperationsResponseTypeDef(TypedDict):
    HoursOfOperationSummaryList: List[HoursOfOperationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See HoursOfOperationSummaryTypeDef
  2. See ResponseMetadataTypeDef

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],
    Tags: NotRequired[Dict[str, str]],
  1. See DirectoryTypeType
  2. See InstanceStatusType
  3. See InstanceStatusReasonTypeDef

ListInstancesResponseTypeDef#

# ListInstancesResponseTypeDef definition

class ListInstancesResponseTypeDef(TypedDict):
    InstanceSummaryList: List[InstanceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See InstanceSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListIntegrationAssociationsResponseTypeDef#

# ListIntegrationAssociationsResponseTypeDef definition

class ListIntegrationAssociationsResponseTypeDef(TypedDict):
    IntegrationAssociationSummaryList: List[IntegrationAssociationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See IntegrationAssociationSummaryTypeDef
  2. See ResponseMetadataTypeDef

InvisibleFieldInfoTypeDef#

# InvisibleFieldInfoTypeDef definition

class InvisibleFieldInfoTypeDef(TypedDict):
    Id: NotRequired[TaskTemplateFieldIdentifierTypeDef],  # (1)
  1. See TaskTemplateFieldIdentifierTypeDef

ReadOnlyFieldInfoTypeDef#

# ReadOnlyFieldInfoTypeDef definition

class ReadOnlyFieldInfoTypeDef(TypedDict):
    Id: NotRequired[TaskTemplateFieldIdentifierTypeDef],  # (1)
  1. See TaskTemplateFieldIdentifierTypeDef

RequiredFieldInfoTypeDef#

# RequiredFieldInfoTypeDef definition

class RequiredFieldInfoTypeDef(TypedDict):
    Id: NotRequired[TaskTemplateFieldIdentifierTypeDef],  # (1)
  1. See TaskTemplateFieldIdentifierTypeDef

TaskTemplateDefaultFieldValueTypeDef#

# TaskTemplateDefaultFieldValueTypeDef definition

class TaskTemplateDefaultFieldValueTypeDef(TypedDict):
    Id: NotRequired[TaskTemplateFieldIdentifierTypeDef],  # (1)
    DefaultValue: NotRequired[str],
  1. See TaskTemplateFieldIdentifierTypeDef

TaskTemplateFieldOutputTypeDef#

# TaskTemplateFieldOutputTypeDef definition

class TaskTemplateFieldOutputTypeDef(TypedDict):
    Id: TaskTemplateFieldIdentifierTypeDef,  # (1)
    Description: NotRequired[str],
    Type: NotRequired[TaskTemplateFieldTypeType],  # (2)
    SingleSelectOptions: NotRequired[List[str]],
  1. See TaskTemplateFieldIdentifierTypeDef
  2. See TaskTemplateFieldTypeType

TaskTemplateFieldTypeDef#

# TaskTemplateFieldTypeDef definition

class TaskTemplateFieldTypeDef(TypedDict):
    Id: TaskTemplateFieldIdentifierTypeDef,  # (1)
    Description: NotRequired[str],
    Type: NotRequired[TaskTemplateFieldTypeType],  # (2)
    SingleSelectOptions: NotRequired[Sequence[str]],
  1. See TaskTemplateFieldIdentifierTypeDef
  2. See TaskTemplateFieldTypeType

ListPhoneNumbersResponseTypeDef#

# ListPhoneNumbersResponseTypeDef definition

class ListPhoneNumbersResponseTypeDef(TypedDict):
    PhoneNumberSummaryList: List[PhoneNumberSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See PhoneNumberSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListPhoneNumbersV2ResponseTypeDef#

# ListPhoneNumbersV2ResponseTypeDef definition

class ListPhoneNumbersV2ResponseTypeDef(TypedDict):
    ListPhoneNumbersSummaryList: List[ListPhoneNumbersSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ListPhoneNumbersSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListPredefinedAttributesResponseTypeDef#

# ListPredefinedAttributesResponseTypeDef definition

class ListPredefinedAttributesResponseTypeDef(TypedDict):
    PredefinedAttributeSummaryList: List[PredefinedAttributeSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See PredefinedAttributeSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListPromptsResponseTypeDef#

# ListPromptsResponseTypeDef definition

class ListPromptsResponseTypeDef(TypedDict):
    PromptSummaryList: List[PromptSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See PromptSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListQueueQuickConnectsResponseTypeDef#

# ListQueueQuickConnectsResponseTypeDef definition

class ListQueueQuickConnectsResponseTypeDef(TypedDict):
    QuickConnectSummaryList: List[QuickConnectSummaryTypeDef],  # (1)
    LastModifiedTime: datetime,
    LastModifiedRegion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See QuickConnectSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListQuickConnectsResponseTypeDef#

# ListQuickConnectsResponseTypeDef definition

class ListQuickConnectsResponseTypeDef(TypedDict):
    QuickConnectSummaryList: List[QuickConnectSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See QuickConnectSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListQueuesResponseTypeDef#

# ListQueuesResponseTypeDef definition

class ListQueuesResponseTypeDef(TypedDict):
    QueueSummaryList: List[QueueSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See QueueSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListRoutingProfileQueuesResponseTypeDef#

# ListRoutingProfileQueuesResponseTypeDef definition

class ListRoutingProfileQueuesResponseTypeDef(TypedDict):
    RoutingProfileQueueConfigSummaryList: List[RoutingProfileQueueConfigSummaryTypeDef],  # (1)
    LastModifiedTime: datetime,
    LastModifiedRegion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See RoutingProfileQueueConfigSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListRoutingProfilesResponseTypeDef#

# ListRoutingProfilesResponseTypeDef definition

class ListRoutingProfilesResponseTypeDef(TypedDict):
    RoutingProfileSummaryList: List[RoutingProfileSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See RoutingProfileSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSecurityKeysResponseTypeDef#

# ListSecurityKeysResponseTypeDef definition

class ListSecurityKeysResponseTypeDef(TypedDict):
    SecurityKeys: List[SecurityKeyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SecurityKeyTypeDef
  2. See ResponseMetadataTypeDef

ListSecurityProfilesResponseTypeDef#

# ListSecurityProfilesResponseTypeDef definition

class ListSecurityProfilesResponseTypeDef(TypedDict):
    SecurityProfileSummaryList: List[SecurityProfileSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SecurityProfileSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTaskTemplatesResponseTypeDef#

# ListTaskTemplatesResponseTypeDef definition

class ListTaskTemplatesResponseTypeDef(TypedDict):
    TaskTemplates: List[TaskTemplateMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See TaskTemplateMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListTrafficDistributionGroupUsersResponseTypeDef#

# ListTrafficDistributionGroupUsersResponseTypeDef definition

class ListTrafficDistributionGroupUsersResponseTypeDef(TypedDict):
    TrafficDistributionGroupUserSummaryList: List[TrafficDistributionGroupUserSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See TrafficDistributionGroupUserSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTrafficDistributionGroupsResponseTypeDef#

# ListTrafficDistributionGroupsResponseTypeDef definition

class ListTrafficDistributionGroupsResponseTypeDef(TypedDict):
    TrafficDistributionGroupSummaryList: List[TrafficDistributionGroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See TrafficDistributionGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListUseCasesResponseTypeDef#

# ListUseCasesResponseTypeDef definition

class ListUseCasesResponseTypeDef(TypedDict):
    UseCaseSummaryList: List[UseCaseTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See UseCaseTypeDef
  2. See ResponseMetadataTypeDef

ListUsersResponseTypeDef#

# ListUsersResponseTypeDef definition

class ListUsersResponseTypeDef(TypedDict):
    UserSummaryList: List[UserSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See UserSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListViewVersionsResponseTypeDef#

# ListViewVersionsResponseTypeDef definition

class ListViewVersionsResponseTypeDef(TypedDict):
    ViewVersionSummaryList: List[ViewVersionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ViewVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListViewsResponseTypeDef#

# ListViewsResponseTypeDef definition

class ListViewsResponseTypeDef(TypedDict):
    ViewsSummaryList: List[ViewSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ViewSummaryTypeDef
  2. See ResponseMetadataTypeDef

MetricV2OutputTypeDef#

# MetricV2OutputTypeDef definition

class MetricV2OutputTypeDef(TypedDict):
    Name: NotRequired[str],
    Threshold: NotRequired[List[ThresholdV2TypeDef]],  # (1)
    MetricFilters: NotRequired[List[MetricFilterV2OutputTypeDef]],  # (2)
  1. See ThresholdV2TypeDef
  2. See MetricFilterV2OutputTypeDef

NewSessionDetailsTypeDef#

# NewSessionDetailsTypeDef definition

class NewSessionDetailsTypeDef(TypedDict):
    SupportedMessagingContentTypes: NotRequired[Sequence[str]],
    ParticipantDetails: NotRequired[ParticipantDetailsTypeDef],  # (1)
    Attributes: NotRequired[Mapping[str, str]],
    StreamingConfiguration: NotRequired[ChatStreamingConfigurationTypeDef],  # (2)
  1. See ParticipantDetailsTypeDef
  2. See ChatStreamingConfigurationTypeDef

StartOutboundChatContactRequestRequestTypeDef#

# StartOutboundChatContactRequestRequestTypeDef definition

class StartOutboundChatContactRequestRequestTypeDef(TypedDict):
    SourceEndpoint: EndpointTypeDef,  # (1)
    DestinationEndpoint: EndpointTypeDef,  # (1)
    InstanceId: str,
    SegmentAttributes: Mapping[str, SegmentAttributeValueTypeDef],  # (3)
    ContactFlowId: str,
    Attributes: NotRequired[Mapping[str, str]],
    ChatDurationInMinutes: NotRequired[int],
    ParticipantDetails: NotRequired[ParticipantDetailsTypeDef],  # (4)
    InitialSystemMessage: NotRequired[ChatMessageTypeDef],  # (5)
    RelatedContactId: NotRequired[str],
    SupportedMessagingContentTypes: NotRequired[Sequence[str]],
    ClientToken: NotRequired[str],
  1. See EndpointTypeDef
  2. See EndpointTypeDef
  3. See SegmentAttributeValueTypeDef
  4. See ParticipantDetailsTypeDef
  5. See ChatMessageTypeDef

SendNotificationActionDefinitionOutputTypeDef#

# SendNotificationActionDefinitionOutputTypeDef definition

class SendNotificationActionDefinitionOutputTypeDef(TypedDict):
    DeliveryMethod: NotificationDeliveryTypeType,  # (1)
    Content: str,
    ContentType: NotificationContentTypeType,  # (2)
    Recipient: NotificationRecipientTypeOutputTypeDef,  # (3)
    Subject: NotRequired[str],
  1. See NotificationDeliveryTypeType
  2. See NotificationContentTypeType
  3. See NotificationRecipientTypeOutputTypeDef

ParticipantTimerConfigurationTypeDef#

# ParticipantTimerConfigurationTypeDef definition

class ParticipantTimerConfigurationTypeDef(TypedDict):
    ParticipantRole: TimerEligibleParticipantRolesType,  # (1)
    TimerType: ParticipantTimerTypeType,  # (2)
    TimerValue: ParticipantTimerValueTypeDef,  # (3)
  1. See TimerEligibleParticipantRolesType
  2. See ParticipantTimerTypeType
  3. See ParticipantTimerValueTypeDef

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],
    SegmentAttributes: NotRequired[Mapping[str, SegmentAttributeValueTypeDef]],  # (4)
  1. See ParticipantDetailsTypeDef
  2. See ChatMessageTypeDef
  3. See PersistentChatTypeDef
  4. See SegmentAttributeValueTypeDef

PredefinedAttributeTypeDef#

# PredefinedAttributeTypeDef definition

class PredefinedAttributeTypeDef(TypedDict):
    Name: NotRequired[str],
    Values: NotRequired[PredefinedAttributeValuesOutputTypeDef],  # (1)
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
  1. See PredefinedAttributeValuesOutputTypeDef

QuickConnectConfigTypeDef#

# QuickConnectConfigTypeDef definition

class QuickConnectConfigTypeDef(TypedDict):
    QuickConnectType: QuickConnectTypeType,  # (1)
    UserConfig: NotRequired[UserQuickConnectConfigTypeDef],  # (2)
    QueueConfig: NotRequired[QueueQuickConnectConfigTypeDef],  # (3)
    PhoneConfig: NotRequired[PhoneNumberQuickConnectConfigTypeDef],  # (4)
  1. See QuickConnectTypeType
  2. See UserQuickConnectConfigTypeDef
  3. See QueueQuickConnectConfigTypeDef
  4. See PhoneNumberQuickConnectConfigTypeDef

RealTimeContactAnalysisTranscriptItemRedactionTypeDef#

# RealTimeContactAnalysisTranscriptItemRedactionTypeDef definition

class RealTimeContactAnalysisTranscriptItemRedactionTypeDef(TypedDict):
    CharacterOffsets: NotRequired[List[RealTimeContactAnalysisCharacterIntervalTypeDef]],  # (1)
  1. See RealTimeContactAnalysisCharacterIntervalTypeDef

RealTimeContactAnalysisTranscriptItemWithCharacterOffsetsTypeDef#

# RealTimeContactAnalysisTranscriptItemWithCharacterOffsetsTypeDef definition

class RealTimeContactAnalysisTranscriptItemWithCharacterOffsetsTypeDef(TypedDict):
    Id: str,
    CharacterOffsets: NotRequired[RealTimeContactAnalysisCharacterIntervalTypeDef],  # (1)
  1. See RealTimeContactAnalysisCharacterIntervalTypeDef

RealTimeContactAnalysisTranscriptItemWithContentTypeDef#

# RealTimeContactAnalysisTranscriptItemWithContentTypeDef definition

class RealTimeContactAnalysisTranscriptItemWithContentTypeDef(TypedDict):
    Id: str,
    Content: NotRequired[str],
    CharacterOffsets: NotRequired[RealTimeContactAnalysisCharacterIntervalTypeDef],  # (1)
  1. See RealTimeContactAnalysisCharacterIntervalTypeDef

RealTimeContactAnalysisSegmentAttachmentsTypeDef#

# RealTimeContactAnalysisSegmentAttachmentsTypeDef definition

class RealTimeContactAnalysisSegmentAttachmentsTypeDef(TypedDict):
    Id: str,
    ParticipantId: str,
    ParticipantRole: ParticipantRoleType,  # (1)
    Attachments: List[RealTimeContactAnalysisAttachmentTypeDef],  # (2)
    Time: RealTimeContactAnalysisTimeDataTypeDef,  # (3)
    DisplayName: NotRequired[str],
  1. See ParticipantRoleType
  2. See RealTimeContactAnalysisAttachmentTypeDef
  3. See RealTimeContactAnalysisTimeDataTypeDef

RealTimeContactAnalysisSegmentEventTypeDef#

# RealTimeContactAnalysisSegmentEventTypeDef definition

class RealTimeContactAnalysisSegmentEventTypeDef(TypedDict):
    Id: str,
    EventType: str,
    Time: RealTimeContactAnalysisTimeDataTypeDef,  # (2)
    ParticipantId: NotRequired[str],
    ParticipantRole: NotRequired[ParticipantRoleType],  # (1)
    DisplayName: NotRequired[str],
  1. See ParticipantRoleType
  2. See RealTimeContactAnalysisTimeDataTypeDef

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)
  1. See UrlReferenceTypeDef
  2. See AttachmentReferenceTypeDef
  3. See StringReferenceTypeDef
  4. See NumberReferenceTypeDef
  5. See DateReferenceTypeDef
  6. See EmailReferenceTypeDef

StartOutboundVoiceContactRequestRequestTypeDef#

# StartOutboundVoiceContactRequestRequestTypeDef definition

class StartOutboundVoiceContactRequestRequestTypeDef(TypedDict):
    DestinationPhoneNumber: str,
    ContactFlowId: str,
    InstanceId: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    References: NotRequired[Mapping[str, ReferenceTypeDef]],  # (1)
    RelatedContactId: NotRequired[str],
    ClientToken: NotRequired[str],
    SourcePhoneNumber: NotRequired[str],
    QueueId: NotRequired[str],
    Attributes: NotRequired[Mapping[str, str]],
    AnswerMachineDetectionConfig: NotRequired[AnswerMachineDetectionConfigTypeDef],  # (2)
    CampaignId: NotRequired[str],
    TrafficType: NotRequired[TrafficTypeType],  # (3)
  1. See ReferenceTypeDef
  2. See AnswerMachineDetectionConfigTypeDef
  3. See TrafficTypeType

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[TimestampTypeDef],
    TaskTemplateId: NotRequired[str],
    QuickConnectId: NotRequired[str],
    RelatedContactId: NotRequired[str],
  1. See ReferenceTypeDef

TaskActionDefinitionOutputTypeDef#

# TaskActionDefinitionOutputTypeDef definition

class TaskActionDefinitionOutputTypeDef(TypedDict):
    Name: str,
    ContactFlowId: str,
    Description: NotRequired[str],
    References: NotRequired[Dict[str, ReferenceTypeDef]],  # (1)
  1. See ReferenceTypeDef

TaskActionDefinitionTypeDef#

# TaskActionDefinitionTypeDef definition

class TaskActionDefinitionTypeDef(TypedDict):
    Name: str,
    ContactFlowId: str,
    Description: NotRequired[str],
    References: NotRequired[Mapping[str, ReferenceTypeDef]],  # (1)
  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)
  1. See ReferenceTypeDef

ReplicationConfigurationTypeDef#

# ReplicationConfigurationTypeDef definition

class ReplicationConfigurationTypeDef(TypedDict):
    ReplicationStatusSummaryList: NotRequired[List[ReplicationStatusSummaryTypeDef]],  # (1)
    SourceRegion: NotRequired[str],
    GlobalSignInEndpoint: NotRequired[str],
  1. See ReplicationStatusSummaryTypeDef

ResourceTagsSearchCriteriaTypeDef#

# ResourceTagsSearchCriteriaTypeDef definition

class ResourceTagsSearchCriteriaTypeDef(TypedDict):
    TagSearchCondition: NotRequired[TagSearchConditionTypeDef],  # (1)
  1. See TagSearchConditionTypeDef

SearchResourceTagsResponseTypeDef#

# SearchResourceTagsResponseTypeDef definition

class SearchResourceTagsResponseTypeDef(TypedDict):
    Tags: List[TagSetTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See TagSetTypeDef
  2. See ResponseMetadataTypeDef

SearchSecurityProfilesResponseTypeDef#

# SearchSecurityProfilesResponseTypeDef definition

class SearchSecurityProfilesResponseTypeDef(TypedDict):
    SecurityProfiles: List[SecurityProfileSearchSummaryTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SecurityProfileSearchSummaryTypeDef
  2. See ResponseMetadataTypeDef

SearchVocabulariesResponseTypeDef#

# SearchVocabulariesResponseTypeDef definition

class SearchVocabulariesResponseTypeDef(TypedDict):
    VocabularySummaryList: List[VocabularySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See VocabularySummaryTypeDef
  2. See ResponseMetadataTypeDef

SearchableContactAttributesTypeDef#

# SearchableContactAttributesTypeDef definition

class SearchableContactAttributesTypeDef(TypedDict):
    Criteria: Sequence[SearchableContactAttributesCriteriaTypeDef],  # (1)
    MatchType: NotRequired[SearchContactsMatchTypeType],  # (2)
  1. See SearchableContactAttributesCriteriaTypeDef
  2. See SearchContactsMatchTypeType

SignInConfigOutputTypeDef#

# SignInConfigOutputTypeDef definition

class SignInConfigOutputTypeDef(TypedDict):
    Distributions: List[SignInDistributionTypeDef],  # (1)
  1. See SignInDistributionTypeDef

SignInConfigTypeDef#

# SignInConfigTypeDef definition

class SignInConfigTypeDef(TypedDict):
    Distributions: Sequence[SignInDistributionTypeDef],  # (1)
  1. See SignInDistributionTypeDef

StartAttachedFileUploadResponseTypeDef#

# StartAttachedFileUploadResponseTypeDef definition

class StartAttachedFileUploadResponseTypeDef(TypedDict):
    FileArn: str,
    FileId: str,
    CreationTime: str,
    FileStatus: FileStatusTypeType,  # (1)
    CreatedBy: CreatedByInfoTypeDef,  # (2)
    UploadUrlMetadata: UploadUrlMetadataTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See FileStatusTypeType
  2. See CreatedByInfoTypeDef
  3. See UploadUrlMetadataTypeDef
  4. See ResponseMetadataTypeDef

StartContactRecordingRequestRequestTypeDef#

# StartContactRecordingRequestRequestTypeDef definition

class StartContactRecordingRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    InitialContactId: str,
    VoiceRecordingConfiguration: VoiceRecordingConfigurationTypeDef,  # (1)
  1. See VoiceRecordingConfigurationTypeDef

TranscriptTypeDef#

# TranscriptTypeDef definition

class TranscriptTypeDef(TypedDict):
    Criteria: Sequence[TranscriptCriteriaTypeDef],  # (1)
    MatchType: NotRequired[SearchContactsMatchTypeType],  # (2)
  1. See TranscriptCriteriaTypeDef
  2. See SearchContactsMatchTypeType

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],
  1. See UserIdentityInfoLiteTypeDef
  2. See UserPhoneConfigTypeDef

ViewTypeDef#

# ViewTypeDef definition

class ViewTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[ViewStatusType],  # (1)
    Type: NotRequired[ViewTypeType],  # (2)
    Description: NotRequired[str],
    Version: NotRequired[int],
    VersionDescription: NotRequired[str],
    Content: NotRequired[ViewContentTypeDef],  # (3)
    Tags: NotRequired[Dict[str, str]],
    CreatedTime: NotRequired[datetime],
    LastModifiedTime: NotRequired[datetime],
    ViewContentSha256: NotRequired[str],
  1. See ViewStatusType
  2. See ViewTypeType
  3. See ViewContentTypeDef

ListRulesResponseTypeDef#

# ListRulesResponseTypeDef definition

class ListRulesResponseTypeDef(TypedDict):
    RuleSummaryList: List[RuleSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See RuleSummaryTypeDef
  2. See ResponseMetadataTypeDef

AgentInfoTypeDef#

# AgentInfoTypeDef definition

class AgentInfoTypeDef(TypedDict):
    Id: NotRequired[str],
    ConnectedToAgentTimestamp: NotRequired[datetime],
    AgentPauseDurationInSeconds: NotRequired[int],
    HierarchyGroups: NotRequired[HierarchyGroupsTypeDef],  # (1)
    DeviceInfo: NotRequired[DeviceInfoTypeDef],  # (2)
    Capabilities: NotRequired[ParticipantCapabilitiesTypeDef],  # (3)
  1. See HierarchyGroupsTypeDef
  2. See DeviceInfoTypeDef
  3. See ParticipantCapabilitiesTypeDef

StartWebRTCContactRequestRequestTypeDef#

# StartWebRTCContactRequestRequestTypeDef definition

class StartWebRTCContactRequestRequestTypeDef(TypedDict):
    ContactFlowId: str,
    InstanceId: str,
    ParticipantDetails: ParticipantDetailsTypeDef,  # (1)
    Attributes: NotRequired[Mapping[str, str]],
    ClientToken: NotRequired[str],
    AllowedCapabilities: NotRequired[AllowedCapabilitiesTypeDef],  # (2)
    RelatedContactId: NotRequired[str],
    References: NotRequired[Mapping[str, ReferenceTypeDef]],  # (3)
    Description: NotRequired[str],
  1. See ParticipantDetailsTypeDef
  2. See AllowedCapabilitiesTypeDef
  3. See ReferenceTypeDef

QualityMetricsTypeDef#

# QualityMetricsTypeDef definition

class QualityMetricsTypeDef(TypedDict):
    Agent: NotRequired[AgentQualityMetricsTypeDef],  # (1)
    Customer: NotRequired[CustomerQualityMetricsTypeDef],  # (2)
  1. See AgentQualityMetricsTypeDef
  2. See CustomerQualityMetricsTypeDef

SearchPredefinedAttributesRequestSearchPredefinedAttributesPaginateTypeDef#

# SearchPredefinedAttributesRequestSearchPredefinedAttributesPaginateTypeDef definition

class SearchPredefinedAttributesRequestSearchPredefinedAttributesPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchCriteria: NotRequired[PredefinedAttributeSearchCriteriaPaginatorTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See PredefinedAttributeSearchCriteriaPaginatorTypeDef
  2. See PaginatorConfigTypeDef

SearchPredefinedAttributesRequestRequestTypeDef#

# SearchPredefinedAttributesRequestRequestTypeDef definition

class SearchPredefinedAttributesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchCriteria: NotRequired[PredefinedAttributeSearchCriteriaTypeDef],  # (1)
  1. See PredefinedAttributeSearchCriteriaTypeDef

AttributeConditionOutputTypeDef#

# AttributeConditionOutputTypeDef definition

class AttributeConditionOutputTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],
    ProficiencyLevel: NotRequired[float],
    MatchCriteria: NotRequired[MatchCriteriaOutputTypeDef],  # (1)
    ComparisonOperator: NotRequired[str],
  1. See MatchCriteriaOutputTypeDef

MatchCriteriaTypeDef#

# MatchCriteriaTypeDef definition

class MatchCriteriaTypeDef(TypedDict):
    AgentsCriteria: NotRequired[AgentsCriteriaUnionTypeDef],  # (1)
  1. See AgentsCriteriaTypeDef AgentsCriteriaOutputTypeDef

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]],
    Applications: NotRequired[Sequence[ApplicationUnionTypeDef]],  # (1)
    HierarchyRestrictedResources: NotRequired[Sequence[str]],
    AllowedAccessControlHierarchyGroupId: NotRequired[str],
  1. See ApplicationTypeDef ApplicationOutputTypeDef

ListBotsResponseTypeDef#

# ListBotsResponseTypeDef definition

class ListBotsResponseTypeDef(TypedDict):
    LexBots: List[LexBotConfigTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See LexBotConfigTypeDef
  2. See ResponseMetadataTypeDef

BatchGetAttachedFileMetadataResponseTypeDef#

# BatchGetAttachedFileMetadataResponseTypeDef definition

class BatchGetAttachedFileMetadataResponseTypeDef(TypedDict):
    Files: List[AttachedFileTypeDef],  # (1)
    Errors: List[AttachedFileErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AttachedFileTypeDef
  2. See AttachedFileErrorTypeDef
  3. See ResponseMetadataTypeDef

ControlPlaneUserAttributeFilterTypeDef#

# ControlPlaneUserAttributeFilterTypeDef definition

class ControlPlaneUserAttributeFilterTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[AttributeAndConditionTypeDef]],  # (1)
    AndCondition: NotRequired[AttributeAndConditionTypeDef],  # (2)
    TagCondition: NotRequired[TagConditionTypeDef],  # (3)
    HierarchyGroupCondition: NotRequired[HierarchyGroupConditionTypeDef],  # (4)
  1. See AttributeAndConditionTypeDef
  2. See AttributeAndConditionTypeDef
  3. See TagConditionTypeDef
  4. See HierarchyGroupConditionTypeDef

ControlPlaneAttributeFilterTypeDef#

# ControlPlaneAttributeFilterTypeDef definition

class ControlPlaneAttributeFilterTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[CommonAttributeAndConditionTypeDef]],  # (1)
    AndCondition: NotRequired[CommonAttributeAndConditionTypeDef],  # (2)
    TagCondition: NotRequired[TagConditionTypeDef],  # (3)
  1. See CommonAttributeAndConditionTypeDef
  2. See CommonAttributeAndConditionTypeDef
  3. See TagConditionTypeDef

ContactFlowModuleSearchFilterTypeDef#

# ContactFlowModuleSearchFilterTypeDef definition

class ContactFlowModuleSearchFilterTypeDef(TypedDict):
    TagFilter: NotRequired[ControlPlaneTagFilterTypeDef],  # (1)
  1. See ControlPlaneTagFilterTypeDef

ContactFlowSearchFilterTypeDef#

# ContactFlowSearchFilterTypeDef definition

class ContactFlowSearchFilterTypeDef(TypedDict):
    TagFilter: NotRequired[ControlPlaneTagFilterTypeDef],  # (1)
  1. See ControlPlaneTagFilterTypeDef

HoursOfOperationSearchFilterTypeDef#

# HoursOfOperationSearchFilterTypeDef definition

class HoursOfOperationSearchFilterTypeDef(TypedDict):
    TagFilter: NotRequired[ControlPlaneTagFilterTypeDef],  # (1)
  1. See ControlPlaneTagFilterTypeDef

PromptSearchFilterTypeDef#

# PromptSearchFilterTypeDef definition

class PromptSearchFilterTypeDef(TypedDict):
    TagFilter: NotRequired[ControlPlaneTagFilterTypeDef],  # (1)
  1. See ControlPlaneTagFilterTypeDef

QueueSearchFilterTypeDef#

# QueueSearchFilterTypeDef definition

class QueueSearchFilterTypeDef(TypedDict):
    TagFilter: NotRequired[ControlPlaneTagFilterTypeDef],  # (1)
  1. See ControlPlaneTagFilterTypeDef

QuickConnectSearchFilterTypeDef#

# QuickConnectSearchFilterTypeDef definition

class QuickConnectSearchFilterTypeDef(TypedDict):
    TagFilter: NotRequired[ControlPlaneTagFilterTypeDef],  # (1)
  1. See ControlPlaneTagFilterTypeDef

RoutingProfileSearchFilterTypeDef#

# RoutingProfileSearchFilterTypeDef definition

class RoutingProfileSearchFilterTypeDef(TypedDict):
    TagFilter: NotRequired[ControlPlaneTagFilterTypeDef],  # (1)
  1. See ControlPlaneTagFilterTypeDef

SecurityProfilesSearchFilterTypeDef#

# SecurityProfilesSearchFilterTypeDef definition

class SecurityProfilesSearchFilterTypeDef(TypedDict):
    TagFilter: NotRequired[ControlPlaneTagFilterTypeDef],  # (1)
  1. See ControlPlaneTagFilterTypeDef

MeetingTypeDef#

# MeetingTypeDef definition

class MeetingTypeDef(TypedDict):
    MediaRegion: NotRequired[str],
    MediaPlacement: NotRequired[MediaPlacementTypeDef],  # (1)
    MeetingFeatures: NotRequired[MeetingFeaturesConfigurationTypeDef],  # (2)
    MeetingId: NotRequired[str],
  1. See MediaPlacementTypeDef
  2. See MeetingFeaturesConfigurationTypeDef

DescribePhoneNumberResponseTypeDef#

# DescribePhoneNumberResponseTypeDef definition

class DescribePhoneNumberResponseTypeDef(TypedDict):
    ClaimedPhoneNumberSummary: ClaimedPhoneNumberSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClaimedPhoneNumberSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListConditionTypeDef#

# ListConditionTypeDef definition

class ListConditionTypeDef(TypedDict):
    TargetListType: NotRequired[TargetListTypeType],  # (1)
    Conditions: NotRequired[Sequence[ConditionTypeDef]],  # (2)
  1. See TargetListTypeType
  2. See ConditionTypeDef

BatchPutContactRequestRequestTypeDef#

# BatchPutContactRequestRequestTypeDef definition

class BatchPutContactRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactDataRequestList: Sequence[ContactDataRequestTypeDef],  # (1)
    ClientToken: NotRequired[str],
  1. See ContactDataRequestTypeDef

GetCurrentUserDataRequestRequestTypeDef#

# GetCurrentUserDataRequestRequestTypeDef definition

class GetCurrentUserDataRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Filters: UserDataFiltersTypeDef,  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See UserDataFiltersTypeDef

SearchContactsResponseTypeDef#

# SearchContactsResponseTypeDef definition

class SearchContactsResponseTypeDef(TypedDict):
    Contacts: List[ContactSearchSummaryTypeDef],  # (1)
    TotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ContactSearchSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeQueueResponseTypeDef#

# DescribeQueueResponseTypeDef definition

class DescribeQueueResponseTypeDef(TypedDict):
    Queue: QueueTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueueTypeDef
  2. See ResponseMetadataTypeDef

SearchQueuesResponseTypeDef#

# SearchQueuesResponseTypeDef definition

class SearchQueuesResponseTypeDef(TypedDict):
    Queues: List[QueueTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See QueueTypeDef
  2. See ResponseMetadataTypeDef

DescribeUserResponseTypeDef#

# DescribeUserResponseTypeDef definition

class DescribeUserResponseTypeDef(TypedDict):
    User: UserTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserTypeDef
  2. 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)
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
    IsDefault: NotRequired[bool],
    AssociatedQueueIds: NotRequired[List[str]],
  1. See MediaConcurrencyTypeDef
  2. See AgentAvailabilityTimerType

UpdateRoutingProfileConcurrencyRequestRequestTypeDef#

# UpdateRoutingProfileConcurrencyRequestRequestTypeDef definition

class UpdateRoutingProfileConcurrencyRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    RoutingProfileId: str,
    MediaConcurrencies: Sequence[MediaConcurrencyTypeDef],  # (1)
  1. See MediaConcurrencyTypeDef

CurrentMetricResultTypeDef#

# CurrentMetricResultTypeDef definition

class CurrentMetricResultTypeDef(TypedDict):
    Dimensions: NotRequired[DimensionsTypeDef],  # (1)
    Collections: NotRequired[List[CurrentMetricDataTypeDef]],  # (2)
  1. See DimensionsTypeDef
  2. See CurrentMetricDataTypeDef

AssociateRoutingProfileQueuesRequestRequestTypeDef#

# AssociateRoutingProfileQueuesRequestRequestTypeDef definition

class AssociateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    RoutingProfileId: str,
    QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef],  # (1)
  1. See RoutingProfileQueueConfigTypeDef

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)
  1. See MediaConcurrencyTypeDef
  2. See RoutingProfileQueueConfigTypeDef
  3. See AgentAvailabilityTimerType

UpdateRoutingProfileQueuesRequestRequestTypeDef#

# UpdateRoutingProfileQueuesRequestRequestTypeDef definition

class UpdateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    RoutingProfileId: str,
    QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef],  # (1)
  1. See RoutingProfileQueueConfigTypeDef

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)
  1. See StorageTypeType
  2. See S3ConfigTypeDef
  3. See KinesisVideoStreamConfigTypeDef
  4. See KinesisStreamConfigTypeDef
  5. See KinesisFirehoseConfigTypeDef

SubmitContactEvaluationRequestRequestTypeDef#

# SubmitContactEvaluationRequestRequestTypeDef definition

class SubmitContactEvaluationRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    EvaluationId: str,
    Answers: NotRequired[Mapping[str, EvaluationAnswerInputTypeDef]],  # (1)
    Notes: NotRequired[Mapping[str, EvaluationNoteTypeDef]],  # (2)
  1. See EvaluationAnswerInputTypeDef
  2. See EvaluationNoteTypeDef

UpdateContactEvaluationRequestRequestTypeDef#

# UpdateContactEvaluationRequestRequestTypeDef definition

class UpdateContactEvaluationRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    EvaluationId: str,
    Answers: NotRequired[Mapping[str, EvaluationAnswerInputTypeDef]],  # (1)
    Notes: NotRequired[Mapping[str, EvaluationNoteTypeDef]],  # (2)
  1. See EvaluationAnswerInputTypeDef
  2. See EvaluationNoteTypeDef

EvaluationFormNumericQuestionPropertiesOutputTypeDef#

# EvaluationFormNumericQuestionPropertiesOutputTypeDef definition

class EvaluationFormNumericQuestionPropertiesOutputTypeDef(TypedDict):
    MinValue: int,
    MaxValue: int,
    Options: NotRequired[List[EvaluationFormNumericQuestionOptionTypeDef]],  # (1)
    Automation: NotRequired[EvaluationFormNumericQuestionAutomationTypeDef],  # (2)
  1. See EvaluationFormNumericQuestionOptionTypeDef
  2. See EvaluationFormNumericQuestionAutomationTypeDef

EvaluationFormNumericQuestionPropertiesTypeDef#

# EvaluationFormNumericQuestionPropertiesTypeDef definition

class EvaluationFormNumericQuestionPropertiesTypeDef(TypedDict):
    MinValue: int,
    MaxValue: int,
    Options: NotRequired[Sequence[EvaluationFormNumericQuestionOptionTypeDef]],  # (1)
    Automation: NotRequired[EvaluationFormNumericQuestionAutomationTypeDef],  # (2)
  1. See EvaluationFormNumericQuestionOptionTypeDef
  2. See EvaluationFormNumericQuestionAutomationTypeDef

EvaluationFormSingleSelectQuestionAutomationOutputTypeDef#

# EvaluationFormSingleSelectQuestionAutomationOutputTypeDef definition

class EvaluationFormSingleSelectQuestionAutomationOutputTypeDef(TypedDict):
    Options: List[EvaluationFormSingleSelectQuestionAutomationOptionTypeDef],  # (1)
    DefaultOptionRefId: NotRequired[str],
  1. See EvaluationFormSingleSelectQuestionAutomationOptionTypeDef

EvaluationFormSingleSelectQuestionAutomationTypeDef#

# EvaluationFormSingleSelectQuestionAutomationTypeDef definition

class EvaluationFormSingleSelectQuestionAutomationTypeDef(TypedDict):
    Options: Sequence[EvaluationFormSingleSelectQuestionAutomationOptionTypeDef],  # (1)
    DefaultOptionRefId: NotRequired[str],
  1. See EvaluationFormSingleSelectQuestionAutomationOptionTypeDef

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]],
  1. See EvaluationMetadataTypeDef
  2. See EvaluationAnswerOutputTypeDef
  3. See EvaluationNoteTypeDef
  4. See EvaluationStatusType
  5. See EvaluationScoreTypeDef

ListContactEvaluationsResponseTypeDef#

# ListContactEvaluationsResponseTypeDef definition

class ListContactEvaluationsResponseTypeDef(TypedDict):
    EvaluationSummaryList: List[EvaluationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See EvaluationSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateCaseActionDefinitionOutputTypeDef#

# CreateCaseActionDefinitionOutputTypeDef definition

class CreateCaseActionDefinitionOutputTypeDef(TypedDict):
    Fields: List[FieldValueOutputTypeDef],  # (1)
    TemplateId: str,
  1. See FieldValueOutputTypeDef

UpdateCaseActionDefinitionOutputTypeDef#

# UpdateCaseActionDefinitionOutputTypeDef definition

class UpdateCaseActionDefinitionOutputTypeDef(TypedDict):
    Fields: List[FieldValueOutputTypeDef],  # (1)
  1. See FieldValueOutputTypeDef

FieldValueTypeDef#

# FieldValueTypeDef definition

class FieldValueTypeDef(TypedDict):
    Id: str,
    Value: FieldValueUnionUnionTypeDef,  # (1)
  1. See FieldValueUnionTypeDef FieldValueUnionOutputTypeDef

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],
  1. See UserReferenceTypeDef
  2. See RoutingProfileReferenceTypeDef
  3. See HierarchyPathReferenceTypeDef
  4. See AgentStatusReferenceTypeDef
  5. See ChannelType
  6. See ChannelType
  7. See ChannelType
  8. 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]],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
  1. See HierarchyPathTypeDef

DescribeUserHierarchyStructureResponseTypeDef#

# DescribeUserHierarchyStructureResponseTypeDef definition

class DescribeUserHierarchyStructureResponseTypeDef(TypedDict):
    HierarchyStructure: HierarchyStructureTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HierarchyStructureTypeDef
  2. See ResponseMetadataTypeDef

UpdateUserHierarchyStructureRequestRequestTypeDef#

# UpdateUserHierarchyStructureRequestRequestTypeDef definition

class UpdateUserHierarchyStructureRequestRequestTypeDef(TypedDict):
    HierarchyStructure: HierarchyStructureUpdateTypeDef,  # (1)
    InstanceId: str,
  1. See HierarchyStructureUpdateTypeDef

GetMetricDataRequestGetMetricDataPaginateTypeDef#

# GetMetricDataRequestGetMetricDataPaginateTypeDef definition

class GetMetricDataRequestGetMetricDataPaginateTypeDef(TypedDict):
    InstanceId: str,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    Filters: FiltersTypeDef,  # (1)
    HistoricalMetrics: Sequence[HistoricalMetricTypeDef],  # (2)
    Groupings: NotRequired[Sequence[GroupingType]],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See FiltersTypeDef
  2. See HistoricalMetricTypeDef
  3. See GroupingType
  4. See PaginatorConfigTypeDef

GetMetricDataRequestRequestTypeDef#

# GetMetricDataRequestRequestTypeDef definition

class GetMetricDataRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    Filters: FiltersTypeDef,  # (1)
    HistoricalMetrics: Sequence[HistoricalMetricTypeDef],  # (2)
    Groupings: NotRequired[Sequence[GroupingType]],  # (3)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See FiltersTypeDef
  2. See HistoricalMetricTypeDef
  3. See GroupingType

HistoricalMetricDataTypeDef#

# HistoricalMetricDataTypeDef definition

class HistoricalMetricDataTypeDef(TypedDict):
    Metric: NotRequired[HistoricalMetricTypeDef],  # (1)
    Value: NotRequired[float],
  1. See HistoricalMetricTypeDef

CreateHoursOfOperationRequestRequestTypeDef#

# CreateHoursOfOperationRequestRequestTypeDef definition

class CreateHoursOfOperationRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Name: str,
    TimeZone: str,
    Config: Sequence[HoursOfOperationConfigTypeDef],  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See HoursOfOperationConfigTypeDef

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]],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
  1. See HoursOfOperationConfigTypeDef

UpdateHoursOfOperationRequestRequestTypeDef#

# UpdateHoursOfOperationRequestRequestTypeDef definition

class UpdateHoursOfOperationRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    HoursOfOperationId: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    TimeZone: NotRequired[str],
    Config: NotRequired[Sequence[HoursOfOperationConfigTypeDef]],  # (1)
  1. See HoursOfOperationConfigTypeDef

TaskTemplateConstraintsOutputTypeDef#

# TaskTemplateConstraintsOutputTypeDef definition

class TaskTemplateConstraintsOutputTypeDef(TypedDict):
    RequiredFields: NotRequired[List[RequiredFieldInfoTypeDef]],  # (1)
    ReadOnlyFields: NotRequired[List[ReadOnlyFieldInfoTypeDef]],  # (2)
    InvisibleFields: NotRequired[List[InvisibleFieldInfoTypeDef]],  # (3)
  1. See RequiredFieldInfoTypeDef
  2. See ReadOnlyFieldInfoTypeDef
  3. See InvisibleFieldInfoTypeDef

TaskTemplateConstraintsTypeDef#

# TaskTemplateConstraintsTypeDef definition

class TaskTemplateConstraintsTypeDef(TypedDict):
    RequiredFields: NotRequired[Sequence[RequiredFieldInfoTypeDef]],  # (1)
    ReadOnlyFields: NotRequired[Sequence[ReadOnlyFieldInfoTypeDef]],  # (2)
    InvisibleFields: NotRequired[Sequence[InvisibleFieldInfoTypeDef]],  # (3)
  1. See RequiredFieldInfoTypeDef
  2. See ReadOnlyFieldInfoTypeDef
  3. See InvisibleFieldInfoTypeDef

TaskTemplateDefaultsOutputTypeDef#

# TaskTemplateDefaultsOutputTypeDef definition

class TaskTemplateDefaultsOutputTypeDef(TypedDict):
    DefaultFieldValues: NotRequired[List[TaskTemplateDefaultFieldValueTypeDef]],  # (1)
  1. See TaskTemplateDefaultFieldValueTypeDef

TaskTemplateDefaultsTypeDef#

# TaskTemplateDefaultsTypeDef definition

class TaskTemplateDefaultsTypeDef(TypedDict):
    DefaultFieldValues: NotRequired[Sequence[TaskTemplateDefaultFieldValueTypeDef]],  # (1)
  1. See TaskTemplateDefaultFieldValueTypeDef

MetricV2TypeDef#

# MetricV2TypeDef definition

class MetricV2TypeDef(TypedDict):
    Name: NotRequired[str],
    Threshold: NotRequired[Sequence[ThresholdV2TypeDef]],  # (1)
    MetricFilters: NotRequired[Sequence[MetricFilterV2UnionTypeDef]],  # (2)
  1. See ThresholdV2TypeDef
  2. See MetricFilterV2TypeDef MetricFilterV2OutputTypeDef

MetricDataV2TypeDef#

# MetricDataV2TypeDef definition

class MetricDataV2TypeDef(TypedDict):
    Metric: NotRequired[MetricV2OutputTypeDef],  # (1)
    Value: NotRequired[float],
  1. See MetricV2OutputTypeDef

SendChatIntegrationEventRequestRequestTypeDef#

# SendChatIntegrationEventRequestRequestTypeDef definition

class SendChatIntegrationEventRequestRequestTypeDef(TypedDict):
    SourceId: str,
    DestinationId: str,
    Event: ChatEventTypeDef,  # (1)
    Subtype: NotRequired[str],
    NewSessionDetails: NotRequired[NewSessionDetailsTypeDef],  # (2)
  1. See ChatEventTypeDef
  2. See NewSessionDetailsTypeDef

SendNotificationActionDefinitionTypeDef#

# SendNotificationActionDefinitionTypeDef definition

class SendNotificationActionDefinitionTypeDef(TypedDict):
    DeliveryMethod: NotificationDeliveryTypeType,  # (1)
    Content: str,
    ContentType: NotificationContentTypeType,  # (2)
    Recipient: NotificationRecipientTypeUnionTypeDef,  # (3)
    Subject: NotRequired[str],
  1. See NotificationDeliveryTypeType
  2. See NotificationContentTypeType
  3. See NotificationRecipientTypeTypeDef NotificationRecipientTypeOutputTypeDef

ChatParticipantRoleConfigTypeDef#

# ChatParticipantRoleConfigTypeDef definition

class ChatParticipantRoleConfigTypeDef(TypedDict):
    ParticipantTimerConfigList: Sequence[ParticipantTimerConfigurationTypeDef],  # (1)
  1. See ParticipantTimerConfigurationTypeDef

DescribePredefinedAttributeResponseTypeDef#

# DescribePredefinedAttributeResponseTypeDef definition

class DescribePredefinedAttributeResponseTypeDef(TypedDict):
    PredefinedAttribute: PredefinedAttributeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PredefinedAttributeTypeDef
  2. See ResponseMetadataTypeDef

SearchPredefinedAttributesResponseTypeDef#

# SearchPredefinedAttributesResponseTypeDef definition

class SearchPredefinedAttributesResponseTypeDef(TypedDict):
    PredefinedAttributes: List[PredefinedAttributeTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See PredefinedAttributeTypeDef
  2. See ResponseMetadataTypeDef

CreateQuickConnectRequestRequestTypeDef#

# CreateQuickConnectRequestRequestTypeDef definition

class CreateQuickConnectRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Name: str,
    QuickConnectConfig: QuickConnectConfigTypeDef,  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See QuickConnectConfigTypeDef

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]],
    LastModifiedTime: NotRequired[datetime],
    LastModifiedRegion: NotRequired[str],
  1. See QuickConnectConfigTypeDef

UpdateQuickConnectConfigRequestRequestTypeDef#

# UpdateQuickConnectConfigRequestRequestTypeDef definition

class UpdateQuickConnectConfigRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    QuickConnectId: str,
    QuickConnectConfig: QuickConnectConfigTypeDef,  # (1)
  1. See QuickConnectConfigTypeDef

RealTimeContactAnalysisSegmentTranscriptTypeDef#

# RealTimeContactAnalysisSegmentTranscriptTypeDef definition

class RealTimeContactAnalysisSegmentTranscriptTypeDef(TypedDict):
    Id: str,
    ParticipantId: str,
    ParticipantRole: ParticipantRoleType,  # (1)
    Content: str,
    Time: RealTimeContactAnalysisTimeDataTypeDef,  # (2)
    DisplayName: NotRequired[str],
    ContentType: NotRequired[str],
    Redaction: NotRequired[RealTimeContactAnalysisTranscriptItemRedactionTypeDef],  # (3)
    Sentiment: NotRequired[RealTimeContactAnalysisSentimentLabelType],  # (4)
  1. See ParticipantRoleType
  2. See RealTimeContactAnalysisTimeDataTypeDef
  3. See RealTimeContactAnalysisTranscriptItemRedactionTypeDef
  4. See RealTimeContactAnalysisSentimentLabelType

RealTimeContactAnalysisPointOfInterestTypeDef#

# RealTimeContactAnalysisPointOfInterestTypeDef definition

class RealTimeContactAnalysisPointOfInterestTypeDef(TypedDict):
    TranscriptItems: NotRequired[List[RealTimeContactAnalysisTranscriptItemWithCharacterOffsetsTypeDef]],  # (1)
  1. See RealTimeContactAnalysisTranscriptItemWithCharacterOffsetsTypeDef

RealTimeContactAnalysisIssueDetectedTypeDef#

# RealTimeContactAnalysisIssueDetectedTypeDef definition

class RealTimeContactAnalysisIssueDetectedTypeDef(TypedDict):
    TranscriptItems: List[RealTimeContactAnalysisTranscriptItemWithContentTypeDef],  # (1)
  1. See RealTimeContactAnalysisTranscriptItemWithContentTypeDef

ListContactReferencesResponseTypeDef#

# ListContactReferencesResponseTypeDef definition

class ListContactReferencesResponseTypeDef(TypedDict):
    ReferenceSummaryList: List[ReferenceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ReferenceSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeInstanceResponseTypeDef#

# DescribeInstanceResponseTypeDef definition

class DescribeInstanceResponseTypeDef(TypedDict):
    Instance: InstanceTypeDef,  # (1)
    ReplicationConfiguration: ReplicationConfigurationTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See InstanceTypeDef
  2. See ReplicationConfigurationTypeDef
  3. See ResponseMetadataTypeDef

SearchResourceTagsRequestRequestTypeDef#

# SearchResourceTagsRequestRequestTypeDef definition

class SearchResourceTagsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ResourceTypes: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchCriteria: NotRequired[ResourceTagsSearchCriteriaTypeDef],  # (1)
  1. See ResourceTagsSearchCriteriaTypeDef

SearchResourceTagsRequestSearchResourceTagsPaginateTypeDef#

# SearchResourceTagsRequestSearchResourceTagsPaginateTypeDef definition

class SearchResourceTagsRequestSearchResourceTagsPaginateTypeDef(TypedDict):
    InstanceId: str,
    ResourceTypes: NotRequired[Sequence[str]],
    SearchCriteria: NotRequired[ResourceTagsSearchCriteriaTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ResourceTagsSearchCriteriaTypeDef
  2. See PaginatorConfigTypeDef

GetTrafficDistributionResponseTypeDef#

# GetTrafficDistributionResponseTypeDef definition

class GetTrafficDistributionResponseTypeDef(TypedDict):
    TelephonyConfig: TelephonyConfigOutputTypeDef,  # (1)
    Id: str,
    Arn: str,
    SignInConfig: SignInConfigOutputTypeDef,  # (2)
    AgentConfig: AgentConfigOutputTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See TelephonyConfigOutputTypeDef
  2. See SignInConfigOutputTypeDef
  3. See AgentConfigOutputTypeDef
  4. See ResponseMetadataTypeDef

UpdateTrafficDistributionRequestRequestTypeDef#

# UpdateTrafficDistributionRequestRequestTypeDef definition

class UpdateTrafficDistributionRequestRequestTypeDef(TypedDict):
    Id: str,
    TelephonyConfig: NotRequired[TelephonyConfigTypeDef],  # (1)
    SignInConfig: NotRequired[SignInConfigTypeDef],  # (2)
    AgentConfig: NotRequired[AgentConfigTypeDef],  # (3)
  1. See TelephonyConfigTypeDef
  2. See SignInConfigTypeDef
  3. See AgentConfigTypeDef

ContactAnalysisTypeDef#

# ContactAnalysisTypeDef definition

class ContactAnalysisTypeDef(TypedDict):
    Transcript: NotRequired[TranscriptTypeDef],  # (1)
  1. See TranscriptTypeDef

SearchUsersResponseTypeDef#

# SearchUsersResponseTypeDef definition

class SearchUsersResponseTypeDef(TypedDict):
    Users: List[UserSearchSummaryTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See UserSearchSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateViewResponseTypeDef#

# CreateViewResponseTypeDef definition

class CreateViewResponseTypeDef(TypedDict):
    View: ViewTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ViewTypeDef
  2. See ResponseMetadataTypeDef

CreateViewVersionResponseTypeDef#

# CreateViewVersionResponseTypeDef definition

class CreateViewVersionResponseTypeDef(TypedDict):
    View: ViewTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ViewTypeDef
  2. See ResponseMetadataTypeDef

DescribeViewResponseTypeDef#

# DescribeViewResponseTypeDef definition

class DescribeViewResponseTypeDef(TypedDict):
    View: ViewTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ViewTypeDef
  2. See ResponseMetadataTypeDef

UpdateViewContentResponseTypeDef#

# UpdateViewContentResponseTypeDef definition

class UpdateViewContentResponseTypeDef(TypedDict):
    View: ViewTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ViewTypeDef
  2. See ResponseMetadataTypeDef

ExpressionOutputTypeDef#

# ExpressionOutputTypeDef definition

class ExpressionOutputTypeDef(TypedDict):
    AttributeCondition: NotRequired[AttributeConditionOutputTypeDef],  # (1)
    AndExpression: NotRequired[List[Dict[str, Any]]],
    OrExpression: NotRequired[List[Dict[str, Any]]],
  1. See AttributeConditionOutputTypeDef

UserSearchFilterTypeDef#

# UserSearchFilterTypeDef definition

class UserSearchFilterTypeDef(TypedDict):
    TagFilter: NotRequired[ControlPlaneTagFilterTypeDef],  # (1)
    UserAttributeFilter: NotRequired[ControlPlaneUserAttributeFilterTypeDef],  # (2)
  1. See ControlPlaneTagFilterTypeDef
  2. See ControlPlaneUserAttributeFilterTypeDef

AgentStatusSearchFilterTypeDef#

# AgentStatusSearchFilterTypeDef definition

class AgentStatusSearchFilterTypeDef(TypedDict):
    AttributeFilter: NotRequired[ControlPlaneAttributeFilterTypeDef],  # (1)
  1. See ControlPlaneAttributeFilterTypeDef

UserHierarchyGroupSearchFilterTypeDef#

# UserHierarchyGroupSearchFilterTypeDef definition

class UserHierarchyGroupSearchFilterTypeDef(TypedDict):
    AttributeFilter: NotRequired[ControlPlaneAttributeFilterTypeDef],  # (1)
  1. See ControlPlaneAttributeFilterTypeDef

SearchContactFlowModulesRequestRequestTypeDef#

# SearchContactFlowModulesRequestRequestTypeDef definition

class SearchContactFlowModulesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchFilter: NotRequired[ContactFlowModuleSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[ContactFlowModuleSearchCriteriaTypeDef],  # (2)
  1. See ContactFlowModuleSearchFilterTypeDef
  2. See ContactFlowModuleSearchCriteriaTypeDef

SearchContactFlowModulesRequestSearchContactFlowModulesPaginateTypeDef#

# SearchContactFlowModulesRequestSearchContactFlowModulesPaginateTypeDef definition

class SearchContactFlowModulesRequestSearchContactFlowModulesPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchFilter: NotRequired[ContactFlowModuleSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[ContactFlowModuleSearchCriteriaPaginatorTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See ContactFlowModuleSearchFilterTypeDef
  2. See ContactFlowModuleSearchCriteriaPaginatorTypeDef
  3. See PaginatorConfigTypeDef

SearchContactFlowsRequestRequestTypeDef#

# SearchContactFlowsRequestRequestTypeDef definition

class SearchContactFlowsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchFilter: NotRequired[ContactFlowSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[ContactFlowSearchCriteriaTypeDef],  # (2)
  1. See ContactFlowSearchFilterTypeDef
  2. See ContactFlowSearchCriteriaTypeDef

SearchContactFlowsRequestSearchContactFlowsPaginateTypeDef#

# SearchContactFlowsRequestSearchContactFlowsPaginateTypeDef definition

class SearchContactFlowsRequestSearchContactFlowsPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchFilter: NotRequired[ContactFlowSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[ContactFlowSearchCriteriaPaginatorTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See ContactFlowSearchFilterTypeDef
  2. See ContactFlowSearchCriteriaPaginatorTypeDef
  3. See PaginatorConfigTypeDef

SearchHoursOfOperationsRequestRequestTypeDef#

# SearchHoursOfOperationsRequestRequestTypeDef definition

class SearchHoursOfOperationsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchFilter: NotRequired[HoursOfOperationSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[HoursOfOperationSearchCriteriaTypeDef],  # (2)
  1. See HoursOfOperationSearchFilterTypeDef
  2. See HoursOfOperationSearchCriteriaTypeDef

SearchHoursOfOperationsRequestSearchHoursOfOperationsPaginateTypeDef#

# SearchHoursOfOperationsRequestSearchHoursOfOperationsPaginateTypeDef definition

class SearchHoursOfOperationsRequestSearchHoursOfOperationsPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchFilter: NotRequired[HoursOfOperationSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[HoursOfOperationSearchCriteriaPaginatorTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See HoursOfOperationSearchFilterTypeDef
  2. See HoursOfOperationSearchCriteriaPaginatorTypeDef
  3. See PaginatorConfigTypeDef

SearchPromptsRequestRequestTypeDef#

# SearchPromptsRequestRequestTypeDef definition

class SearchPromptsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchFilter: NotRequired[PromptSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[PromptSearchCriteriaTypeDef],  # (2)
  1. See PromptSearchFilterTypeDef
  2. See PromptSearchCriteriaTypeDef

SearchPromptsRequestSearchPromptsPaginateTypeDef#

# SearchPromptsRequestSearchPromptsPaginateTypeDef definition

class SearchPromptsRequestSearchPromptsPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchFilter: NotRequired[PromptSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[PromptSearchCriteriaPaginatorTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See PromptSearchFilterTypeDef
  2. See PromptSearchCriteriaPaginatorTypeDef
  3. See PaginatorConfigTypeDef

SearchQueuesRequestRequestTypeDef#

# SearchQueuesRequestRequestTypeDef definition

class SearchQueuesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchFilter: NotRequired[QueueSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[QueueSearchCriteriaTypeDef],  # (2)
  1. See QueueSearchFilterTypeDef
  2. See QueueSearchCriteriaTypeDef

SearchQueuesRequestSearchQueuesPaginateTypeDef#

# SearchQueuesRequestSearchQueuesPaginateTypeDef definition

class SearchQueuesRequestSearchQueuesPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchFilter: NotRequired[QueueSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[QueueSearchCriteriaPaginatorTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See QueueSearchFilterTypeDef
  2. See QueueSearchCriteriaPaginatorTypeDef
  3. See PaginatorConfigTypeDef

SearchQuickConnectsRequestRequestTypeDef#

# SearchQuickConnectsRequestRequestTypeDef definition

class SearchQuickConnectsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchFilter: NotRequired[QuickConnectSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[QuickConnectSearchCriteriaTypeDef],  # (2)
  1. See QuickConnectSearchFilterTypeDef
  2. See QuickConnectSearchCriteriaTypeDef

SearchQuickConnectsRequestSearchQuickConnectsPaginateTypeDef#

# SearchQuickConnectsRequestSearchQuickConnectsPaginateTypeDef definition

class SearchQuickConnectsRequestSearchQuickConnectsPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchFilter: NotRequired[QuickConnectSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[QuickConnectSearchCriteriaPaginatorTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See QuickConnectSearchFilterTypeDef
  2. See QuickConnectSearchCriteriaPaginatorTypeDef
  3. See PaginatorConfigTypeDef

SearchRoutingProfilesRequestRequestTypeDef#

# SearchRoutingProfilesRequestRequestTypeDef definition

class SearchRoutingProfilesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchFilter: NotRequired[RoutingProfileSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[RoutingProfileSearchCriteriaTypeDef],  # (2)
  1. See RoutingProfileSearchFilterTypeDef
  2. See RoutingProfileSearchCriteriaTypeDef

SearchRoutingProfilesRequestSearchRoutingProfilesPaginateTypeDef#

# SearchRoutingProfilesRequestSearchRoutingProfilesPaginateTypeDef definition

class SearchRoutingProfilesRequestSearchRoutingProfilesPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchFilter: NotRequired[RoutingProfileSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[RoutingProfileSearchCriteriaPaginatorTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See RoutingProfileSearchFilterTypeDef
  2. See RoutingProfileSearchCriteriaPaginatorTypeDef
  3. See PaginatorConfigTypeDef

SearchSecurityProfilesRequestRequestTypeDef#

# SearchSecurityProfilesRequestRequestTypeDef definition

class SearchSecurityProfilesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchCriteria: NotRequired[SecurityProfileSearchCriteriaTypeDef],  # (1)
    SearchFilter: NotRequired[SecurityProfilesSearchFilterTypeDef],  # (2)
  1. See SecurityProfileSearchCriteriaTypeDef
  2. See SecurityProfilesSearchFilterTypeDef

SearchSecurityProfilesRequestSearchSecurityProfilesPaginateTypeDef#

# SearchSecurityProfilesRequestSearchSecurityProfilesPaginateTypeDef definition

class SearchSecurityProfilesRequestSearchSecurityProfilesPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchCriteria: NotRequired[SecurityProfileSearchCriteriaPaginatorTypeDef],  # (1)
    SearchFilter: NotRequired[SecurityProfilesSearchFilterTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See SecurityProfileSearchCriteriaPaginatorTypeDef
  2. See SecurityProfilesSearchFilterTypeDef
  3. See PaginatorConfigTypeDef

ConnectionDataTypeDef#

# ConnectionDataTypeDef definition

class ConnectionDataTypeDef(TypedDict):
    Attendee: NotRequired[AttendeeTypeDef],  # (1)
    Meeting: NotRequired[MeetingTypeDef],  # (2)
  1. See AttendeeTypeDef
  2. See MeetingTypeDef

UserSearchCriteriaPaginatorTypeDef#

# UserSearchCriteriaPaginatorTypeDef definition

class UserSearchCriteriaPaginatorTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
    ListCondition: NotRequired[ListConditionTypeDef],  # (2)
    HierarchyGroupCondition: NotRequired[HierarchyGroupConditionTypeDef],  # (3)
  1. See StringConditionTypeDef
  2. See ListConditionTypeDef
  3. See HierarchyGroupConditionTypeDef

UserSearchCriteriaTypeDef#

# UserSearchCriteriaTypeDef definition

class UserSearchCriteriaTypeDef(TypedDict):
    OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
    AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
    StringCondition: NotRequired[StringConditionTypeDef],  # (1)
    ListCondition: NotRequired[ListConditionTypeDef],  # (2)
    HierarchyGroupCondition: NotRequired[HierarchyGroupConditionTypeDef],  # (3)
  1. See StringConditionTypeDef
  2. See ListConditionTypeDef
  3. See HierarchyGroupConditionTypeDef

DescribeRoutingProfileResponseTypeDef#

# DescribeRoutingProfileResponseTypeDef definition

class DescribeRoutingProfileResponseTypeDef(TypedDict):
    RoutingProfile: RoutingProfileTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RoutingProfileTypeDef
  2. See ResponseMetadataTypeDef

SearchRoutingProfilesResponseTypeDef#

# SearchRoutingProfilesResponseTypeDef definition

class SearchRoutingProfilesResponseTypeDef(TypedDict):
    RoutingProfiles: List[RoutingProfileTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See RoutingProfileTypeDef
  2. See ResponseMetadataTypeDef

GetCurrentMetricDataResponseTypeDef#

# GetCurrentMetricDataResponseTypeDef definition

class GetCurrentMetricDataResponseTypeDef(TypedDict):
    MetricResults: List[CurrentMetricResultTypeDef],  # (1)
    DataSnapshotTime: datetime,
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See CurrentMetricResultTypeDef
  2. See ResponseMetadataTypeDef

AssociateInstanceStorageConfigRequestRequestTypeDef#

# AssociateInstanceStorageConfigRequestRequestTypeDef definition

class AssociateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ResourceType: InstanceStorageResourceTypeType,  # (1)
    StorageConfig: InstanceStorageConfigTypeDef,  # (2)
  1. See InstanceStorageResourceTypeType
  2. See InstanceStorageConfigTypeDef

DescribeInstanceStorageConfigResponseTypeDef#

# DescribeInstanceStorageConfigResponseTypeDef definition

class DescribeInstanceStorageConfigResponseTypeDef(TypedDict):
    StorageConfig: InstanceStorageConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceStorageConfigTypeDef
  2. See ResponseMetadataTypeDef

ListInstanceStorageConfigsResponseTypeDef#

# ListInstanceStorageConfigsResponseTypeDef definition

class ListInstanceStorageConfigsResponseTypeDef(TypedDict):
    StorageConfigs: List[InstanceStorageConfigTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See InstanceStorageConfigTypeDef
  2. See ResponseMetadataTypeDef

UpdateInstanceStorageConfigRequestRequestTypeDef#

# UpdateInstanceStorageConfigRequestRequestTypeDef definition

class UpdateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    AssociationId: str,
    ResourceType: InstanceStorageResourceTypeType,  # (1)
    StorageConfig: InstanceStorageConfigTypeDef,  # (2)
  1. See InstanceStorageResourceTypeType
  2. See InstanceStorageConfigTypeDef

EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef#

# EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef definition

class EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef(TypedDict):
    Options: List[EvaluationFormSingleSelectQuestionOptionTypeDef],  # (1)
    DisplayAs: NotRequired[EvaluationFormSingleSelectQuestionDisplayModeType],  # (2)
    Automation: NotRequired[EvaluationFormSingleSelectQuestionAutomationOutputTypeDef],  # (3)
  1. See EvaluationFormSingleSelectQuestionOptionTypeDef
  2. See EvaluationFormSingleSelectQuestionDisplayModeType
  3. See EvaluationFormSingleSelectQuestionAutomationOutputTypeDef

RuleActionOutputTypeDef#

# RuleActionOutputTypeDef definition

class RuleActionOutputTypeDef(TypedDict):
    ActionType: ActionTypeType,  # (1)
    TaskAction: NotRequired[TaskActionDefinitionOutputTypeDef],  # (2)
    EventBridgeAction: NotRequired[EventBridgeActionDefinitionTypeDef],  # (3)
    AssignContactCategoryAction: NotRequired[Dict[str, Any]],
    SendNotificationAction: NotRequired[SendNotificationActionDefinitionOutputTypeDef],  # (4)
    CreateCaseAction: NotRequired[CreateCaseActionDefinitionOutputTypeDef],  # (5)
    UpdateCaseAction: NotRequired[UpdateCaseActionDefinitionOutputTypeDef],  # (6)
    EndAssociatedTasksAction: NotRequired[Dict[str, Any]],
    SubmitAutoEvaluationAction: NotRequired[SubmitAutoEvaluationActionDefinitionTypeDef],  # (7)
  1. See ActionTypeType
  2. See TaskActionDefinitionOutputTypeDef
  3. See EventBridgeActionDefinitionTypeDef
  4. See SendNotificationActionDefinitionOutputTypeDef
  5. See CreateCaseActionDefinitionOutputTypeDef
  6. See UpdateCaseActionDefinitionOutputTypeDef
  7. See SubmitAutoEvaluationActionDefinitionTypeDef

UpdateCaseActionDefinitionTypeDef#

# UpdateCaseActionDefinitionTypeDef definition

class UpdateCaseActionDefinitionTypeDef(TypedDict):
    Fields: Sequence[FieldValueTypeDef],  # (1)
  1. See FieldValueTypeDef

GetCurrentUserDataResponseTypeDef#

# GetCurrentUserDataResponseTypeDef definition

class GetCurrentUserDataResponseTypeDef(TypedDict):
    UserDataList: List[UserDataTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See UserDataTypeDef
  2. See ResponseMetadataTypeDef

DescribeUserHierarchyGroupResponseTypeDef#

# DescribeUserHierarchyGroupResponseTypeDef definition

class DescribeUserHierarchyGroupResponseTypeDef(TypedDict):
    HierarchyGroup: HierarchyGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HierarchyGroupTypeDef
  2. See ResponseMetadataTypeDef

SearchUserHierarchyGroupsResponseTypeDef#

# SearchUserHierarchyGroupsResponseTypeDef definition

class SearchUserHierarchyGroupsResponseTypeDef(TypedDict):
    UserHierarchyGroups: List[HierarchyGroupTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See HierarchyGroupTypeDef
  2. See ResponseMetadataTypeDef

HistoricalMetricResultTypeDef#

# HistoricalMetricResultTypeDef definition

class HistoricalMetricResultTypeDef(TypedDict):
    Dimensions: NotRequired[DimensionsTypeDef],  # (1)
    Collections: NotRequired[List[HistoricalMetricDataTypeDef]],  # (2)
  1. See DimensionsTypeDef
  2. See HistoricalMetricDataTypeDef

DescribeHoursOfOperationResponseTypeDef#

# DescribeHoursOfOperationResponseTypeDef definition

class DescribeHoursOfOperationResponseTypeDef(TypedDict):
    HoursOfOperation: HoursOfOperationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HoursOfOperationTypeDef
  2. See ResponseMetadataTypeDef

SearchHoursOfOperationsResponseTypeDef#

# SearchHoursOfOperationsResponseTypeDef definition

class SearchHoursOfOperationsResponseTypeDef(TypedDict):
    HoursOfOperations: List[HoursOfOperationTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See HoursOfOperationTypeDef
  2. See ResponseMetadataTypeDef

GetTaskTemplateResponseTypeDef#

# GetTaskTemplateResponseTypeDef definition

class GetTaskTemplateResponseTypeDef(TypedDict):
    InstanceId: str,
    Id: str,
    Arn: str,
    Name: str,
    Description: str,
    ContactFlowId: str,
    Constraints: TaskTemplateConstraintsOutputTypeDef,  # (1)
    Defaults: TaskTemplateDefaultsOutputTypeDef,  # (2)
    Fields: List[TaskTemplateFieldOutputTypeDef],  # (3)
    Status: TaskTemplateStatusType,  # (4)
    LastModifiedTime: datetime,
    CreatedTime: datetime,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See TaskTemplateConstraintsOutputTypeDef
  2. See TaskTemplateDefaultsOutputTypeDef
  3. See TaskTemplateFieldOutputTypeDef
  4. See TaskTemplateStatusType
  5. See ResponseMetadataTypeDef

UpdateTaskTemplateResponseTypeDef#

# UpdateTaskTemplateResponseTypeDef definition

class UpdateTaskTemplateResponseTypeDef(TypedDict):
    InstanceId: str,
    Id: str,
    Arn: str,
    Name: str,
    Description: str,
    ContactFlowId: str,
    Constraints: TaskTemplateConstraintsOutputTypeDef,  # (1)
    Defaults: TaskTemplateDefaultsOutputTypeDef,  # (2)
    Fields: List[TaskTemplateFieldOutputTypeDef],  # (3)
    Status: TaskTemplateStatusType,  # (4)
    LastModifiedTime: datetime,
    CreatedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See TaskTemplateConstraintsOutputTypeDef
  2. See TaskTemplateDefaultsOutputTypeDef
  3. See TaskTemplateFieldOutputTypeDef
  4. See TaskTemplateStatusType
  5. 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)
  1. See TaskTemplateConstraintsTypeDef
  2. See TaskTemplateDefaultsTypeDef
  3. See TaskTemplateStatusType
  4. See TaskTemplateFieldTypeDef

CreateTaskTemplateRequestRequestTypeDef#

# CreateTaskTemplateRequestRequestTypeDef definition

class CreateTaskTemplateRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Name: str,
    Fields: Sequence[TaskTemplateFieldUnionTypeDef],  # (1)
    Description: NotRequired[str],
    ContactFlowId: NotRequired[str],
    Constraints: NotRequired[TaskTemplateConstraintsTypeDef],  # (2)
    Defaults: NotRequired[TaskTemplateDefaultsTypeDef],  # (3)
    Status: NotRequired[TaskTemplateStatusType],  # (4)
    ClientToken: NotRequired[str],
  1. See TaskTemplateFieldTypeDef TaskTemplateFieldOutputTypeDef
  2. See TaskTemplateConstraintsTypeDef
  3. See TaskTemplateDefaultsTypeDef
  4. See TaskTemplateStatusType

MetricResultV2TypeDef#

# MetricResultV2TypeDef definition

class MetricResultV2TypeDef(TypedDict):
    Dimensions: NotRequired[Dict[str, str]],
    MetricInterval: NotRequired[MetricIntervalTypeDef],  # (1)
    Collections: NotRequired[List[MetricDataV2TypeDef]],  # (2)
  1. See MetricIntervalTypeDef
  2. See MetricDataV2TypeDef

UpdateParticipantRoleConfigChannelInfoTypeDef#

# UpdateParticipantRoleConfigChannelInfoTypeDef definition

class UpdateParticipantRoleConfigChannelInfoTypeDef(TypedDict):
    Chat: NotRequired[ChatParticipantRoleConfigTypeDef],  # (1)
  1. See ChatParticipantRoleConfigTypeDef

DescribeQuickConnectResponseTypeDef#

# DescribeQuickConnectResponseTypeDef definition

class DescribeQuickConnectResponseTypeDef(TypedDict):
    QuickConnect: QuickConnectTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickConnectTypeDef
  2. See ResponseMetadataTypeDef

SearchQuickConnectsResponseTypeDef#

# SearchQuickConnectsResponseTypeDef definition

class SearchQuickConnectsResponseTypeDef(TypedDict):
    QuickConnects: List[QuickConnectTypeDef],  # (1)
    ApproximateTotalCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See QuickConnectTypeDef
  2. See ResponseMetadataTypeDef

RealTimeContactAnalysisCategoryDetailsTypeDef#

# RealTimeContactAnalysisCategoryDetailsTypeDef definition

class RealTimeContactAnalysisCategoryDetailsTypeDef(TypedDict):
    PointsOfInterest: List[RealTimeContactAnalysisPointOfInterestTypeDef],  # (1)
  1. See RealTimeContactAnalysisPointOfInterestTypeDef

RealTimeContactAnalysisSegmentIssuesTypeDef#

# RealTimeContactAnalysisSegmentIssuesTypeDef definition

class RealTimeContactAnalysisSegmentIssuesTypeDef(TypedDict):
    IssuesDetected: List[RealTimeContactAnalysisIssueDetectedTypeDef],  # (1)
  1. See RealTimeContactAnalysisIssueDetectedTypeDef

SearchCriteriaTypeDef#

# SearchCriteriaTypeDef definition

class SearchCriteriaTypeDef(TypedDict):
    AgentIds: NotRequired[Sequence[str]],
    AgentHierarchyGroups: NotRequired[AgentHierarchyGroupsTypeDef],  # (1)
    Channels: NotRequired[Sequence[ChannelType]],  # (2)
    ContactAnalysis: NotRequired[ContactAnalysisTypeDef],  # (3)
    InitiationMethods: NotRequired[Sequence[ContactInitiationMethodType]],  # (4)
    QueueIds: NotRequired[Sequence[str]],
    SearchableContactAttributes: NotRequired[SearchableContactAttributesTypeDef],  # (5)
  1. See AgentHierarchyGroupsTypeDef
  2. See ChannelType
  3. See ContactAnalysisTypeDef
  4. See ContactInitiationMethodType
  5. See SearchableContactAttributesTypeDef

StepTypeDef#

# StepTypeDef definition

class StepTypeDef(TypedDict):
    Expiry: NotRequired[ExpiryTypeDef],  # (1)
    Expression: NotRequired[ExpressionOutputTypeDef],  # (2)
    Status: NotRequired[RoutingCriteriaStepStatusType],  # (3)
  1. See ExpiryTypeDef
  2. See ExpressionOutputTypeDef
  3. See RoutingCriteriaStepStatusType

AttributeConditionTypeDef#

# AttributeConditionTypeDef definition

class AttributeConditionTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],
    ProficiencyLevel: NotRequired[float],
    MatchCriteria: NotRequired[MatchCriteriaUnionTypeDef],  # (1)
    ComparisonOperator: NotRequired[str],
  1. See MatchCriteriaTypeDef MatchCriteriaOutputTypeDef

SearchAgentStatusesRequestRequestTypeDef#

# SearchAgentStatusesRequestRequestTypeDef definition

class SearchAgentStatusesRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchFilter: NotRequired[AgentStatusSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[AgentStatusSearchCriteriaTypeDef],  # (2)
  1. See AgentStatusSearchFilterTypeDef
  2. See AgentStatusSearchCriteriaTypeDef

SearchAgentStatusesRequestSearchAgentStatusesPaginateTypeDef#

# SearchAgentStatusesRequestSearchAgentStatusesPaginateTypeDef definition

class SearchAgentStatusesRequestSearchAgentStatusesPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchFilter: NotRequired[AgentStatusSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[AgentStatusSearchCriteriaPaginatorTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See AgentStatusSearchFilterTypeDef
  2. See AgentStatusSearchCriteriaPaginatorTypeDef
  3. See PaginatorConfigTypeDef

SearchUserHierarchyGroupsRequestRequestTypeDef#

# SearchUserHierarchyGroupsRequestRequestTypeDef definition

class SearchUserHierarchyGroupsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchFilter: NotRequired[UserHierarchyGroupSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[UserHierarchyGroupSearchCriteriaTypeDef],  # (2)
  1. See UserHierarchyGroupSearchFilterTypeDef
  2. See UserHierarchyGroupSearchCriteriaTypeDef

SearchUserHierarchyGroupsRequestSearchUserHierarchyGroupsPaginateTypeDef#

# SearchUserHierarchyGroupsRequestSearchUserHierarchyGroupsPaginateTypeDef definition

class SearchUserHierarchyGroupsRequestSearchUserHierarchyGroupsPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchFilter: NotRequired[UserHierarchyGroupSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[UserHierarchyGroupSearchCriteriaPaginatorTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See UserHierarchyGroupSearchFilterTypeDef
  2. See UserHierarchyGroupSearchCriteriaPaginatorTypeDef
  3. See PaginatorConfigTypeDef

StartWebRTCContactResponseTypeDef#

# StartWebRTCContactResponseTypeDef definition

class StartWebRTCContactResponseTypeDef(TypedDict):
    ConnectionData: ConnectionDataTypeDef,  # (1)
    ContactId: str,
    ParticipantId: str,
    ParticipantToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectionDataTypeDef
  2. See ResponseMetadataTypeDef

SearchUsersRequestSearchUsersPaginateTypeDef#

# SearchUsersRequestSearchUsersPaginateTypeDef definition

class SearchUsersRequestSearchUsersPaginateTypeDef(TypedDict):
    InstanceId: str,
    SearchFilter: NotRequired[UserSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[UserSearchCriteriaPaginatorTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See UserSearchFilterTypeDef
  2. See UserSearchCriteriaPaginatorTypeDef
  3. See PaginatorConfigTypeDef

SearchUsersRequestRequestTypeDef#

# SearchUsersRequestRequestTypeDef definition

class SearchUsersRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SearchFilter: NotRequired[UserSearchFilterTypeDef],  # (1)
    SearchCriteria: NotRequired[UserSearchCriteriaTypeDef],  # (2)
  1. See UserSearchFilterTypeDef
  2. See UserSearchCriteriaTypeDef

EvaluationFormQuestionTypePropertiesOutputTypeDef#

# EvaluationFormQuestionTypePropertiesOutputTypeDef definition

class EvaluationFormQuestionTypePropertiesOutputTypeDef(TypedDict):
    Numeric: NotRequired[EvaluationFormNumericQuestionPropertiesOutputTypeDef],  # (1)
    SingleSelect: NotRequired[EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef],  # (2)
  1. See EvaluationFormNumericQuestionPropertiesOutputTypeDef
  2. See EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef

EvaluationFormSingleSelectQuestionPropertiesTypeDef#

# EvaluationFormSingleSelectQuestionPropertiesTypeDef definition

class EvaluationFormSingleSelectQuestionPropertiesTypeDef(TypedDict):
    Options: Sequence[EvaluationFormSingleSelectQuestionOptionTypeDef],  # (1)
    DisplayAs: NotRequired[EvaluationFormSingleSelectQuestionDisplayModeType],  # (2)
    Automation: NotRequired[EvaluationFormSingleSelectQuestionAutomationUnionTypeDef],  # (3)
  1. See EvaluationFormSingleSelectQuestionOptionTypeDef
  2. See EvaluationFormSingleSelectQuestionDisplayModeType
  3. See EvaluationFormSingleSelectQuestionAutomationTypeDef EvaluationFormSingleSelectQuestionAutomationOutputTypeDef

RuleTypeDef#

# RuleTypeDef definition

class RuleTypeDef(TypedDict):
    Name: str,
    RuleId: str,
    RuleArn: str,
    TriggerEventSource: RuleTriggerEventSourceTypeDef,  # (1)
    Function: str,
    Actions: List[RuleActionOutputTypeDef],  # (2)
    PublishStatus: RulePublishStatusType,  # (3)
    CreatedTime: datetime,
    LastUpdatedTime: datetime,
    LastUpdatedBy: str,
    Tags: NotRequired[Dict[str, str]],
  1. See RuleTriggerEventSourceTypeDef
  2. See RuleActionOutputTypeDef
  3. See RulePublishStatusType

CreateCaseActionDefinitionTypeDef#

# CreateCaseActionDefinitionTypeDef definition

class CreateCaseActionDefinitionTypeDef(TypedDict):
    Fields: Sequence[FieldValueExtraUnionTypeDef],  # (1)
    TemplateId: str,
  1. See FieldValueTypeDef FieldValueOutputTypeDef

GetMetricDataResponseTypeDef#

# GetMetricDataResponseTypeDef definition

class GetMetricDataResponseTypeDef(TypedDict):
    MetricResults: List[HistoricalMetricResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See HistoricalMetricResultTypeDef
  2. See ResponseMetadataTypeDef

GetMetricDataV2RequestRequestTypeDef#

# GetMetricDataV2RequestRequestTypeDef definition

class GetMetricDataV2RequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    Filters: Sequence[FilterV2TypeDef],  # (1)
    Metrics: Sequence[MetricV2UnionTypeDef],  # (2)
    Interval: NotRequired[IntervalDetailsTypeDef],  # (3)
    Groupings: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See FilterV2TypeDef
  2. See MetricV2TypeDef MetricV2OutputTypeDef
  3. See IntervalDetailsTypeDef

GetMetricDataV2ResponseTypeDef#

# GetMetricDataV2ResponseTypeDef definition

class GetMetricDataV2ResponseTypeDef(TypedDict):
    MetricResults: List[MetricResultV2TypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See MetricResultV2TypeDef
  2. See ResponseMetadataTypeDef

UpdateParticipantRoleConfigRequestRequestTypeDef#

# UpdateParticipantRoleConfigRequestRequestTypeDef definition

class UpdateParticipantRoleConfigRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    ChannelConfiguration: UpdateParticipantRoleConfigChannelInfoTypeDef,  # (1)
  1. See UpdateParticipantRoleConfigChannelInfoTypeDef

RealTimeContactAnalysisSegmentCategoriesTypeDef#

# RealTimeContactAnalysisSegmentCategoriesTypeDef definition

class RealTimeContactAnalysisSegmentCategoriesTypeDef(TypedDict):
    MatchedDetails: Dict[str, RealTimeContactAnalysisCategoryDetailsTypeDef],  # (1)
  1. See RealTimeContactAnalysisCategoryDetailsTypeDef

SearchContactsRequestRequestTypeDef#

# SearchContactsRequestRequestTypeDef definition

class SearchContactsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    TimeRange: SearchContactsTimeRangeTypeDef,  # (1)
    SearchCriteria: NotRequired[SearchCriteriaTypeDef],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Sort: NotRequired[SortTypeDef],  # (3)
  1. See SearchContactsTimeRangeTypeDef
  2. See SearchCriteriaTypeDef
  3. See SortTypeDef

SearchContactsRequestSearchContactsPaginateTypeDef#

# SearchContactsRequestSearchContactsPaginateTypeDef definition

class SearchContactsRequestSearchContactsPaginateTypeDef(TypedDict):
    InstanceId: str,
    TimeRange: SearchContactsTimeRangeTypeDef,  # (1)
    SearchCriteria: NotRequired[SearchCriteriaTypeDef],  # (2)
    Sort: NotRequired[SortTypeDef],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See SearchContactsTimeRangeTypeDef
  2. See SearchCriteriaTypeDef
  3. See SortTypeDef
  4. See PaginatorConfigTypeDef

RoutingCriteriaTypeDef#

# RoutingCriteriaTypeDef definition

class RoutingCriteriaTypeDef(TypedDict):
    Steps: NotRequired[List[StepTypeDef]],  # (1)
    ActivationTimestamp: NotRequired[datetime],
    Index: NotRequired[int],
  1. See StepTypeDef

EvaluationFormQuestionOutputTypeDef#

# EvaluationFormQuestionOutputTypeDef definition

class EvaluationFormQuestionOutputTypeDef(TypedDict):
    Title: str,
    RefId: str,
    QuestionType: EvaluationFormQuestionTypeType,  # (1)
    Instructions: NotRequired[str],
    NotApplicableEnabled: NotRequired[bool],
    QuestionTypeProperties: NotRequired[EvaluationFormQuestionTypePropertiesOutputTypeDef],  # (2)
    Weight: NotRequired[float],
  1. See EvaluationFormQuestionTypeType
  2. See EvaluationFormQuestionTypePropertiesOutputTypeDef

DescribeRuleResponseTypeDef#

# DescribeRuleResponseTypeDef definition

class DescribeRuleResponseTypeDef(TypedDict):
    Rule: RuleTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleTypeDef
  2. See ResponseMetadataTypeDef

RealtimeContactAnalysisSegmentTypeDef#

# RealtimeContactAnalysisSegmentTypeDef definition

class RealtimeContactAnalysisSegmentTypeDef(TypedDict):
    Transcript: NotRequired[RealTimeContactAnalysisSegmentTranscriptTypeDef],  # (1)
    Categories: NotRequired[RealTimeContactAnalysisSegmentCategoriesTypeDef],  # (2)
    Issues: NotRequired[RealTimeContactAnalysisSegmentIssuesTypeDef],  # (3)
    Event: NotRequired[RealTimeContactAnalysisSegmentEventTypeDef],  # (4)
    Attachments: NotRequired[RealTimeContactAnalysisSegmentAttachmentsTypeDef],  # (5)
    PostContactSummary: NotRequired[RealTimeContactAnalysisSegmentPostContactSummaryTypeDef],  # (6)
  1. See RealTimeContactAnalysisSegmentTranscriptTypeDef
  2. See RealTimeContactAnalysisSegmentCategoriesTypeDef
  3. See RealTimeContactAnalysisSegmentIssuesTypeDef
  4. See RealTimeContactAnalysisSegmentEventTypeDef
  5. See RealTimeContactAnalysisSegmentAttachmentsTypeDef
  6. See RealTimeContactAnalysisSegmentPostContactSummaryTypeDef

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],
    LastPausedTimestamp: NotRequired[datetime],
    LastResumedTimestamp: NotRequired[datetime],
    TotalPauseCount: NotRequired[int],
    TotalPauseDurationInSeconds: NotRequired[int],
    ScheduledTimestamp: NotRequired[datetime],
    RelatedContactId: NotRequired[str],
    WisdomInfo: NotRequired[WisdomInfoTypeDef],  # (5)
    QueueTimeAdjustmentSeconds: NotRequired[int],
    QueuePriority: NotRequired[int],
    Tags: NotRequired[Dict[str, str]],
    ConnectedToSystemTimestamp: NotRequired[datetime],
    RoutingCriteria: NotRequired[RoutingCriteriaTypeDef],  # (6)
    Customer: NotRequired[CustomerTypeDef],  # (7)
    Campaign: NotRequired[CampaignTypeDef],  # (8)
    AnsweringMachineDetectionStatus: NotRequired[AnsweringMachineDetectionStatusType],  # (9)
    CustomerVoiceActivity: NotRequired[CustomerVoiceActivityTypeDef],  # (10)
    QualityMetrics: NotRequired[QualityMetricsTypeDef],  # (11)
    DisconnectDetails: NotRequired[DisconnectDetailsTypeDef],  # (12)
    SegmentAttributes: NotRequired[Dict[str, SegmentAttributeValueTypeDef]],  # (13)
  1. See ContactInitiationMethodType
  2. See ChannelType
  3. See QueueInfoTypeDef
  4. See AgentInfoTypeDef
  5. See WisdomInfoTypeDef
  6. See RoutingCriteriaTypeDef
  7. See CustomerTypeDef
  8. See CampaignTypeDef
  9. See AnsweringMachineDetectionStatusType
  10. See CustomerVoiceActivityTypeDef
  11. See QualityMetricsTypeDef
  12. See DisconnectDetailsTypeDef
  13. See SegmentAttributeValueTypeDef

ExpressionTypeDef#

# ExpressionTypeDef definition

class ExpressionTypeDef(TypedDict):
    AttributeCondition: NotRequired[AttributeConditionUnionTypeDef],  # (1)
    AndExpression: NotRequired[Sequence[Mapping[str, Any]]],
    OrExpression: NotRequired[Sequence[Mapping[str, Any]]],
  1. See AttributeConditionTypeDef AttributeConditionOutputTypeDef

EvaluationFormItemOutputTypeDef#

# EvaluationFormItemOutputTypeDef definition

class EvaluationFormItemOutputTypeDef(TypedDict):
    Section: NotRequired[EvaluationFormSectionOutputTypeDef],  # (1)
    Question: NotRequired[EvaluationFormQuestionOutputTypeDef],  # (2)
  1. See EvaluationFormSectionOutputTypeDef
  2. See EvaluationFormQuestionOutputTypeDef

EvaluationFormQuestionTypePropertiesTypeDef#

# EvaluationFormQuestionTypePropertiesTypeDef definition

class EvaluationFormQuestionTypePropertiesTypeDef(TypedDict):
    Numeric: NotRequired[EvaluationFormNumericQuestionPropertiesUnionTypeDef],  # (1)
    SingleSelect: NotRequired[EvaluationFormSingleSelectQuestionPropertiesUnionTypeDef],  # (2)
  1. See EvaluationFormNumericQuestionPropertiesTypeDef EvaluationFormNumericQuestionPropertiesOutputTypeDef
  2. See EvaluationFormSingleSelectQuestionPropertiesTypeDef EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef

RuleActionTypeDef#

# RuleActionTypeDef definition

class RuleActionTypeDef(TypedDict):
    ActionType: ActionTypeType,  # (1)
    TaskAction: NotRequired[TaskActionDefinitionUnionTypeDef],  # (2)
    EventBridgeAction: NotRequired[EventBridgeActionDefinitionTypeDef],  # (3)
    AssignContactCategoryAction: NotRequired[Mapping[str, Any]],
    SendNotificationAction: NotRequired[SendNotificationActionDefinitionUnionTypeDef],  # (4)
    CreateCaseAction: NotRequired[CreateCaseActionDefinitionUnionTypeDef],  # (5)
    UpdateCaseAction: NotRequired[UpdateCaseActionDefinitionUnionTypeDef],  # (6)
    EndAssociatedTasksAction: NotRequired[Mapping[str, Any]],
    SubmitAutoEvaluationAction: NotRequired[SubmitAutoEvaluationActionDefinitionTypeDef],  # (7)
  1. See ActionTypeType
  2. See TaskActionDefinitionTypeDef TaskActionDefinitionOutputTypeDef
  3. See EventBridgeActionDefinitionTypeDef
  4. See SendNotificationActionDefinitionTypeDef SendNotificationActionDefinitionOutputTypeDef
  5. See CreateCaseActionDefinitionTypeDef CreateCaseActionDefinitionOutputTypeDef
  6. See UpdateCaseActionDefinitionTypeDef UpdateCaseActionDefinitionOutputTypeDef
  7. See SubmitAutoEvaluationActionDefinitionTypeDef

ListRealtimeContactAnalysisSegmentsV2ResponseTypeDef#

# ListRealtimeContactAnalysisSegmentsV2ResponseTypeDef definition

class ListRealtimeContactAnalysisSegmentsV2ResponseTypeDef(TypedDict):
    Channel: RealTimeContactAnalysisSupportedChannelType,  # (1)
    Status: RealTimeContactAnalysisStatusType,  # (2)
    Segments: List[RealtimeContactAnalysisSegmentTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
    NextToken: NotRequired[str],
  1. See RealTimeContactAnalysisSupportedChannelType
  2. See RealTimeContactAnalysisStatusType
  3. See RealtimeContactAnalysisSegmentTypeDef
  4. See ResponseMetadataTypeDef

DescribeContactResponseTypeDef#

# DescribeContactResponseTypeDef definition

class DescribeContactResponseTypeDef(TypedDict):
    Contact: ContactTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContactTypeDef
  2. See ResponseMetadataTypeDef

EvaluationFormContentTypeDef#

# EvaluationFormContentTypeDef definition

class EvaluationFormContentTypeDef(TypedDict):
    EvaluationFormVersion: int,
    EvaluationFormId: str,
    EvaluationFormArn: str,
    Title: str,
    Items: List[EvaluationFormItemOutputTypeDef],  # (1)
    Description: NotRequired[str],
    ScoringStrategy: NotRequired[EvaluationFormScoringStrategyTypeDef],  # (2)
  1. See EvaluationFormItemOutputTypeDef
  2. See EvaluationFormScoringStrategyTypeDef

EvaluationFormTypeDef#

# EvaluationFormTypeDef definition

class EvaluationFormTypeDef(TypedDict):
    EvaluationFormId: str,
    EvaluationFormVersion: int,
    Locked: bool,
    EvaluationFormArn: str,
    Title: str,
    Status: EvaluationFormVersionStatusType,  # (1)
    Items: List[EvaluationFormItemOutputTypeDef],  # (2)
    CreatedTime: datetime,
    CreatedBy: str,
    LastModifiedTime: datetime,
    LastModifiedBy: str,
    Description: NotRequired[str],
    ScoringStrategy: NotRequired[EvaluationFormScoringStrategyTypeDef],  # (3)
    Tags: NotRequired[Dict[str, str]],
  1. See EvaluationFormVersionStatusType
  2. See EvaluationFormItemOutputTypeDef
  3. See EvaluationFormScoringStrategyTypeDef

UpdateRuleRequestRequestTypeDef#

# UpdateRuleRequestRequestTypeDef definition

class UpdateRuleRequestRequestTypeDef(TypedDict):
    RuleId: str,
    InstanceId: str,
    Name: str,
    Function: str,
    Actions: Sequence[RuleActionTypeDef],  # (1)
    PublishStatus: RulePublishStatusType,  # (2)
  1. See RuleActionTypeDef
  2. See RulePublishStatusType

RoutingCriteriaInputStepTypeDef#

# RoutingCriteriaInputStepTypeDef definition

class RoutingCriteriaInputStepTypeDef(TypedDict):
    Expiry: NotRequired[RoutingCriteriaInputStepExpiryTypeDef],  # (1)
    Expression: NotRequired[ExpressionUnionTypeDef],  # (2)
  1. See RoutingCriteriaInputStepExpiryTypeDef
  2. See ExpressionTypeDef ExpressionOutputTypeDef

DescribeContactEvaluationResponseTypeDef#

# DescribeContactEvaluationResponseTypeDef definition

class DescribeContactEvaluationResponseTypeDef(TypedDict):
    Evaluation: EvaluationTypeDef,  # (1)
    EvaluationForm: EvaluationFormContentTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See EvaluationTypeDef
  2. See EvaluationFormContentTypeDef
  3. See ResponseMetadataTypeDef

DescribeEvaluationFormResponseTypeDef#

# DescribeEvaluationFormResponseTypeDef definition

class DescribeEvaluationFormResponseTypeDef(TypedDict):
    EvaluationForm: EvaluationFormTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EvaluationFormTypeDef
  2. See ResponseMetadataTypeDef

EvaluationFormQuestionTypeDef#

# EvaluationFormQuestionTypeDef definition

class EvaluationFormQuestionTypeDef(TypedDict):
    Title: str,
    RefId: str,
    QuestionType: EvaluationFormQuestionTypeType,  # (1)
    Instructions: NotRequired[str],
    NotApplicableEnabled: NotRequired[bool],
    QuestionTypeProperties: NotRequired[EvaluationFormQuestionTypePropertiesUnionTypeDef],  # (2)
    Weight: NotRequired[float],
  1. See EvaluationFormQuestionTypeType
  2. See EvaluationFormQuestionTypePropertiesTypeDef EvaluationFormQuestionTypePropertiesOutputTypeDef

CreateRuleRequestRequestTypeDef#

# CreateRuleRequestRequestTypeDef definition

class CreateRuleRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Name: str,
    TriggerEventSource: RuleTriggerEventSourceTypeDef,  # (1)
    Function: str,
    Actions: Sequence[RuleActionUnionTypeDef],  # (2)
    PublishStatus: RulePublishStatusType,  # (3)
    ClientToken: NotRequired[str],
  1. See RuleTriggerEventSourceTypeDef
  2. See RuleActionTypeDef RuleActionOutputTypeDef
  3. See RulePublishStatusType

RoutingCriteriaInputTypeDef#

# RoutingCriteriaInputTypeDef definition

class RoutingCriteriaInputTypeDef(TypedDict):
    Steps: NotRequired[Sequence[RoutingCriteriaInputStepTypeDef]],  # (1)
  1. See RoutingCriteriaInputStepTypeDef

UpdateContactRoutingDataRequestRequestTypeDef#

# UpdateContactRoutingDataRequestRequestTypeDef definition

class UpdateContactRoutingDataRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ContactId: str,
    QueueTimeAdjustmentSeconds: NotRequired[int],
    QueuePriority: NotRequired[int],
    RoutingCriteria: NotRequired[RoutingCriteriaInputTypeDef],  # (1)
  1. See RoutingCriteriaInputTypeDef

EvaluationFormItemTypeDef#

# EvaluationFormItemTypeDef definition

class EvaluationFormItemTypeDef(TypedDict):
    Section: NotRequired[EvaluationFormSectionUnionTypeDef],  # (1)
    Question: NotRequired[EvaluationFormQuestionUnionTypeDef],  # (2)
  1. See EvaluationFormSectionTypeDef EvaluationFormSectionOutputTypeDef
  2. See EvaluationFormQuestionTypeDef EvaluationFormQuestionOutputTypeDef

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],
  1. See EvaluationFormItemTypeDef
  2. See EvaluationFormScoringStrategyTypeDef

CreateEvaluationFormRequestRequestTypeDef#

# CreateEvaluationFormRequestRequestTypeDef definition

class CreateEvaluationFormRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Title: str,
    Items: Sequence[EvaluationFormItemUnionTypeDef],  # (1)
    Description: NotRequired[str],
    ScoringStrategy: NotRequired[EvaluationFormScoringStrategyTypeDef],  # (2)
    ClientToken: NotRequired[str],
  1. See EvaluationFormItemTypeDef EvaluationFormItemOutputTypeDef
  2. See EvaluationFormScoringStrategyTypeDef