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)
]ApplicationUnionTypeDef#
# ApplicationUnionTypeDef definition
ApplicationUnionTypeDef = Union[
ApplicationTypeDef, # (1)
ApplicationOutputTypeDef, # (2)
]EvaluationFormSectionUnionTypeDef#
# EvaluationFormSectionUnionTypeDef definition
EvaluationFormSectionUnionTypeDef = Union[
EvaluationFormSectionTypeDef, # (1)
EvaluationFormSectionOutputTypeDef, # (2)
]FieldValueUnionUnionTypeDef#
# FieldValueUnionUnionTypeDef definition
FieldValueUnionUnionTypeDef = Union[
FieldValueUnionTypeDef, # (1)
FieldValueUnionOutputTypeDef, # (2)
]MetricFilterV2UnionTypeDef#
# MetricFilterV2UnionTypeDef definition
MetricFilterV2UnionTypeDef = Union[
MetricFilterV2TypeDef, # (1)
MetricFilterV2OutputTypeDef, # (2)
]NotificationRecipientTypeUnionTypeDef#
# NotificationRecipientTypeUnionTypeDef definition
NotificationRecipientTypeUnionTypeDef = Union[
NotificationRecipientTypeTypeDef, # (1)
NotificationRecipientTypeOutputTypeDef, # (2)
]SegmentAttributeValueUnionTypeDef#
# SegmentAttributeValueUnionTypeDef definition
SegmentAttributeValueUnionTypeDef = Union[
SegmentAttributeValueTypeDef, # (1)
SegmentAttributeValueOutputTypeDef, # (2)
]TaskActionDefinitionUnionTypeDef#
# TaskActionDefinitionUnionTypeDef definition
TaskActionDefinitionUnionTypeDef = Union[
TaskActionDefinitionTypeDef, # (1)
TaskActionDefinitionOutputTypeDef, # (2)
]TaskTemplateFieldUnionTypeDef#
# TaskTemplateFieldUnionTypeDef definition
TaskTemplateFieldUnionTypeDef = Union[
TaskTemplateFieldTypeDef, # (1)
TaskTemplateFieldOutputTypeDef, # (2)
]MatchCriteriaUnionTypeDef#
# MatchCriteriaUnionTypeDef definition
MatchCriteriaUnionTypeDef = Union[
MatchCriteriaTypeDef, # (1)
MatchCriteriaOutputTypeDef, # (2)
]EvaluationFormNumericQuestionPropertiesUnionTypeDef#
# EvaluationFormNumericQuestionPropertiesUnionTypeDef definition
EvaluationFormNumericQuestionPropertiesUnionTypeDef = Union[
EvaluationFormNumericQuestionPropertiesTypeDef, # (1)
EvaluationFormNumericQuestionPropertiesOutputTypeDef, # (2)
]- See EvaluationFormNumericQuestionPropertiesTypeDef
- See EvaluationFormNumericQuestionPropertiesOutputTypeDef
EvaluationFormSingleSelectQuestionAutomationUnionTypeDef#
# EvaluationFormSingleSelectQuestionAutomationUnionTypeDef definition
EvaluationFormSingleSelectQuestionAutomationUnionTypeDef = Union[
EvaluationFormSingleSelectQuestionAutomationTypeDef, # (1)
EvaluationFormSingleSelectQuestionAutomationOutputTypeDef, # (2)
]- See EvaluationFormSingleSelectQuestionAutomationTypeDef
- See EvaluationFormSingleSelectQuestionAutomationOutputTypeDef
FieldValueExtraUnionTypeDef#
# FieldValueExtraUnionTypeDef definition
FieldValueExtraUnionTypeDef = Union[
FieldValueTypeDef, # (1)
FieldValueOutputTypeDef, # (2)
]MetricV2UnionTypeDef#
# MetricV2UnionTypeDef definition
MetricV2UnionTypeDef = Union[
MetricV2TypeDef, # (1)
MetricV2OutputTypeDef, # (2)
]- See MetricV2TypeDef
- See MetricV2OutputTypeDef
SendNotificationActionDefinitionUnionTypeDef#
# SendNotificationActionDefinitionUnionTypeDef definition
SendNotificationActionDefinitionUnionTypeDef = Union[
SendNotificationActionDefinitionTypeDef, # (1)
SendNotificationActionDefinitionOutputTypeDef, # (2)
]CreateCaseActionDefinitionUnionTypeDef#
# CreateCaseActionDefinitionUnionTypeDef definition
CreateCaseActionDefinitionUnionTypeDef = Union[
CreateCaseActionDefinitionTypeDef, # (1)
CreateCaseActionDefinitionOutputTypeDef, # (2)
]AttributeConditionUnionTypeDef#
# AttributeConditionUnionTypeDef definition
AttributeConditionUnionTypeDef = Union[
AttributeConditionTypeDef, # (1)
AttributeConditionOutputTypeDef, # (2)
]EvaluationFormSingleSelectQuestionPropertiesUnionTypeDef#
# EvaluationFormSingleSelectQuestionPropertiesUnionTypeDef definition
EvaluationFormSingleSelectQuestionPropertiesUnionTypeDef = Union[
EvaluationFormSingleSelectQuestionPropertiesTypeDef, # (1)
EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef, # (2)
]- See EvaluationFormSingleSelectQuestionPropertiesTypeDef
- See EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef
UpdateCaseActionDefinitionUnionTypeDef#
# UpdateCaseActionDefinitionUnionTypeDef definition
UpdateCaseActionDefinitionUnionTypeDef = Union[
UpdateCaseActionDefinitionTypeDef, # (1)
UpdateCaseActionDefinitionOutputTypeDef, # (2)
]ExpressionUnionTypeDef#
# ExpressionUnionTypeDef definition
ExpressionUnionTypeDef = Union[
ExpressionTypeDef, # (1)
ExpressionOutputTypeDef, # (2)
]EvaluationFormQuestionTypePropertiesUnionTypeDef#
# EvaluationFormQuestionTypePropertiesUnionTypeDef definition
EvaluationFormQuestionTypePropertiesUnionTypeDef = Union[
EvaluationFormQuestionTypePropertiesTypeDef, # (1)
EvaluationFormQuestionTypePropertiesOutputTypeDef, # (2)
]- See EvaluationFormQuestionTypePropertiesTypeDef
- See EvaluationFormQuestionTypePropertiesOutputTypeDef
RuleActionUnionTypeDef#
# RuleActionUnionTypeDef definition
RuleActionUnionTypeDef = Union[
RuleActionTypeDef, # (1)
RuleActionOutputTypeDef, # (2)
]EvaluationFormQuestionUnionTypeDef#
# EvaluationFormQuestionUnionTypeDef definition
EvaluationFormQuestionUnionTypeDef = Union[
EvaluationFormQuestionTypeDef, # (1)
EvaluationFormQuestionOutputTypeDef, # (2)
]EvaluationFormItemUnionTypeDef#
# EvaluationFormItemUnionTypeDef definition
EvaluationFormItemUnionTypeDef = Union[
EvaluationFormItemTypeDef, # (1)
EvaluationFormItemOutputTypeDef, # (2)
]ActionSummaryTypeDef#
# ActionSummaryTypeDef definition
class ActionSummaryTypeDef(TypedDict):
ActionType: ActionTypeType, # (1)- See ActionTypeType
ActivateEvaluationFormRequestRequestTypeDef#
# ActivateEvaluationFormRequestRequestTypeDef definition
class ActivateEvaluationFormRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: int,ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],EmailRecipientTypeDef#
# EmailRecipientTypeDef definition
class EmailRecipientTypeDef(TypedDict):
Address: NotRequired[str],
DisplayName: 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)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)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],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],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],AssociateFlowRequestRequestTypeDef#
# AssociateFlowRequestRequestTypeDef definition
class AssociateFlowRequestRequestTypeDef(TypedDict):
InstanceId: str,
ResourceId: str,
FlowId: str,
ResourceType: FlowAssociationResourceTypeType, # (1)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,AssociatedContactSummaryTypeDef#
# AssociatedContactSummaryTypeDef definition
class AssociatedContactSummaryTypeDef(TypedDict):
ContactId: NotRequired[str],
ContactArn: NotRequired[str],
InitiationTimestamp: NotRequired[datetime],
DisconnectTimestamp: NotRequired[datetime],
InitialContactId: NotRequired[str],
PreviousContactId: NotRequired[str],
RelatedContactId: NotRequired[str],
InitiationMethod: NotRequired[ContactInitiationMethodType], # (1)
Channel: NotRequired[ChannelType], # (2)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)
Arn: NotRequired[str],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)TagConditionTypeDef#
# TagConditionTypeDef definition
class TagConditionTypeDef(TypedDict):
TagKey: NotRequired[str],
TagValue: NotRequired[str],RangeTypeDef#
# RangeTypeDef definition
class RangeTypeDef(TypedDict):
MinProficiencyLevel: NotRequired[float],
MaxProficiencyLevel: NotRequired[float],AttributeTypeDef#
# AttributeTypeDef definition
class AttributeTypeDef(TypedDict):
AttributeType: NotRequired[InstanceAttributeTypeType], # (1)
Value: NotRequired[str],AudioFeaturesTypeDef#
# AudioFeaturesTypeDef definition
class AudioFeaturesTypeDef(TypedDict):
EchoReduction: NotRequired[MeetingFeatureStatusType], # (1)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)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)FlowAssociationSummaryTypeDef#
# FlowAssociationSummaryTypeDef definition
class FlowAssociationSummaryTypeDef(TypedDict):
ResourceId: NotRequired[str],
FlowId: NotRequired[str],
ResourceType: NotRequired[ListFlowAssociationResourceTypeType], # (1)FailedRequestTypeDef#
# FailedRequestTypeDef definition
class FailedRequestTypeDef(TypedDict):
RequestIdentifier: NotRequired[str],
FailureReasonCode: NotRequired[FailureReasonCodeType], # (1)
FailureReasonMessage: NotRequired[str],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],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],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)ContactConfigurationTypeDef#
# ContactConfigurationTypeDef definition
class ContactConfigurationTypeDef(TypedDict):
ContactId: str,
ParticipantRole: NotRequired[ParticipantRoleType], # (1)
IncludeRawMessage: NotRequired[bool],EndpointTypeDef#
# EndpointTypeDef definition
class EndpointTypeDef(TypedDict):
Type: NotRequired[EndpointTypeType], # (1)
Address: NotRequired[str],- See EndpointTypeType
ContactFilterTypeDef#
# ContactFilterTypeDef definition
class ContactFilterTypeDef(TypedDict):
ContactStates: NotRequired[Sequence[ContactStateType]], # (1)- See ContactStateType
ContactFlowModuleSummaryTypeDef#
# ContactFlowModuleSummaryTypeDef definition
class ContactFlowModuleSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
State: NotRequired[ContactFlowModuleStateType], # (1)ContactFlowModuleTypeDef#
# ContactFlowModuleTypeDef definition
class ContactFlowModuleTypeDef(TypedDict):
Arn: NotRequired[str],
Id: NotRequired[str],
Name: NotRequired[str],
Content: NotRequired[str],
Description: NotRequired[str],
State: NotRequired[ContactFlowModuleStateType], # (1)
Status: NotRequired[ContactFlowModuleStatusType], # (2)
Tags: NotRequired[dict[str, str]],ContactFlowSummaryTypeDef#
# ContactFlowSummaryTypeDef definition
class ContactFlowSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
ContactFlowType: NotRequired[ContactFlowTypeType], # (1)
ContactFlowState: NotRequired[ContactFlowStateType], # (2)
ContactFlowStatus: NotRequired[ContactFlowStatusType], # (3)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]],
FlowContentSha256: NotRequired[str],
Version: NotRequired[int],
VersionDescription: NotRequired[str],
LastModifiedTime: NotRequired[datetime],
LastModifiedRegion: NotRequired[str],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],ContactSearchSummarySegmentAttributeValueTypeDef#
# ContactSearchSummarySegmentAttributeValueTypeDef definition
class ContactSearchSummarySegmentAttributeValueTypeDef(TypedDict):
ValueString: NotRequired[str],CustomerVoiceActivityTypeDef#
# CustomerVoiceActivityTypeDef definition
class CustomerVoiceActivityTypeDef(TypedDict):
GreetingStartTimestamp: NotRequired[datetime],
GreetingEndTimestamp: NotRequired[datetime],DisconnectDetailsTypeDef#
# DisconnectDetailsTypeDef definition
class DisconnectDetailsTypeDef(TypedDict):
PotentialDisconnectIssue: NotRequired[str],EndpointInfoTypeDef#
# EndpointInfoTypeDef definition
class EndpointInfoTypeDef(TypedDict):
Type: NotRequired[EndpointTypeType], # (1)
Address: NotRequired[str],
DisplayName: NotRequired[str],- See EndpointTypeType
QueueInfoTypeDef#
# QueueInfoTypeDef definition
class QueueInfoTypeDef(TypedDict):
Id: NotRequired[str],
EnqueueTimestamp: NotRequired[datetime],SegmentAttributeValueOutputTypeDef#
# SegmentAttributeValueOutputTypeDef definition
class SegmentAttributeValueOutputTypeDef(TypedDict):
ValueString: NotRequired[str],
ValueMap: NotRequired[dict[str, dict[str, Any]]],
ValueInteger: NotRequired[int],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]],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]],ReferenceTypeDef#
# ReferenceTypeDef definition
class ReferenceTypeDef(TypedDict):
Type: ReferenceTypeType, # (1)
Value: NotRequired[str],
Status: NotRequired[ReferenceStatusType], # (2)
Arn: NotRequired[str],
StatusReason: NotRequired[str],- See ReferenceTypeType
- See ReferenceStatusType
UserInfoTypeDef#
# UserInfoTypeDef definition
class UserInfoTypeDef(TypedDict):
UserId: NotRequired[str],CreateEmailAddressRequestRequestTypeDef#
# CreateEmailAddressRequestRequestTypeDef definition
class CreateEmailAddressRequestRequestTypeDef(TypedDict):
InstanceId: str,
EmailAddress: str,
Description: NotRequired[str],
DisplayName: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
ClientToken: NotRequired[str],EvaluationFormScoringStrategyTypeDef#
# EvaluationFormScoringStrategyTypeDef definition
class EvaluationFormScoringStrategyTypeDef(TypedDict):
Mode: EvaluationFormScoringModeType, # (1)
Status: EvaluationFormScoringStatusType, # (2)CreateInstanceRequestRequestTypeDef#
# CreateInstanceRequestRequestTypeDef definition
class CreateInstanceRequestRequestTypeDef(TypedDict):
IdentityManagementType: DirectoryTypeType, # (1)
InboundCallsEnabled: bool,
OutboundCallsEnabled: bool,
ClientToken: NotRequired[str],
InstanceAlias: NotRequired[str],
DirectoryId: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],CreateIntegrationAssociationRequestRequestTypeDef#
# CreateIntegrationAssociationRequestRequestTypeDef definition
class CreateIntegrationAssociationRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationType: IntegrationTypeType, # (1)
IntegrationArn: str,
SourceApplicationUrl: NotRequired[str],
SourceApplicationName: NotRequired[str],
SourceType: NotRequired[SourceTypeType], # (2)
Tags: NotRequired[Mapping[str, str]],- See IntegrationTypeType
- See SourceTypeType
ParticipantDetailsToAddTypeDef#
# ParticipantDetailsToAddTypeDef definition
class ParticipantDetailsToAddTypeDef(TypedDict):
ParticipantRole: NotRequired[ParticipantRoleType], # (1)
DisplayName: NotRequired[str],ParticipantTokenCredentialsTypeDef#
# ParticipantTokenCredentialsTypeDef definition
class ParticipantTokenCredentialsTypeDef(TypedDict):
ParticipantToken: NotRequired[str],
Expiry: NotRequired[str],CreatePersistentContactAssociationRequestRequestTypeDef#
# CreatePersistentContactAssociationRequestRequestTypeDef definition
class CreatePersistentContactAssociationRequestRequestTypeDef(TypedDict):
InstanceId: str,
InitialContactId: str,
RehydrationType: RehydrationTypeType, # (1)
SourceContactId: str,
ClientToken: NotRequired[str],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],OutboundEmailConfigTypeDef#
# OutboundEmailConfigTypeDef definition
class OutboundEmailConfigTypeDef(TypedDict):
OutboundEmailAddressId: NotRequired[str],RuleTriggerEventSourceTypeDef#
# RuleTriggerEventSourceTypeDef definition
class RuleTriggerEventSourceTypeDef(TypedDict):
EventSourceName: EventSourceNameType, # (1)
IntegrationAssociationId: NotRequired[str],CreateTrafficDistributionGroupRequestRequestTypeDef#
# CreateTrafficDistributionGroupRequestRequestTypeDef definition
class CreateTrafficDistributionGroupRequestRequestTypeDef(TypedDict):
Name: str,
InstanceId: str,
Description: NotRequired[str],
ClientToken: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],CreateUseCaseRequestRequestTypeDef#
# CreateUseCaseRequestRequestTypeDef definition
class CreateUseCaseRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
UseCaseType: UseCaseTypeType, # (1)
Tags: NotRequired[Mapping[str, str]],- See UseCaseTypeType
CreateUserHierarchyGroupRequestRequestTypeDef#
# CreateUserHierarchyGroupRequestRequestTypeDef definition
class CreateUserHierarchyGroupRequestRequestTypeDef(TypedDict):
Name: str,
InstanceId: str,
ParentGroupId: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],UserIdentityInfoTypeDef#
# UserIdentityInfoTypeDef definition
class UserIdentityInfoTypeDef(TypedDict):
FirstName: NotRequired[str],
LastName: NotRequired[str],
Email: NotRequired[str],
SecondaryEmail: NotRequired[str],
Mobile: NotRequired[str],UserPhoneConfigTypeDef#
# UserPhoneConfigTypeDef definition
class UserPhoneConfigTypeDef(TypedDict):
PhoneType: PhoneTypeType, # (1)
AutoAccept: NotRequired[bool],
AfterContactWorkTimeLimit: NotRequired[int],
DeskPhoneNumber: NotRequired[str],- See PhoneTypeType
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]],CredentialsTypeDef#
# CredentialsTypeDef definition
class CredentialsTypeDef(TypedDict):
AccessToken: NotRequired[str],
AccessTokenExpiration: NotRequired[datetime],
RefreshToken: NotRequired[str],
RefreshTokenExpiration: NotRequired[datetime],CrossChannelBehaviorTypeDef#
# CrossChannelBehaviorTypeDef definition
class CrossChannelBehaviorTypeDef(TypedDict):
BehaviorType: BehaviorTypeType, # (1)- See BehaviorTypeType
CurrentMetricTypeDef#
# CurrentMetricTypeDef definition
class CurrentMetricTypeDef(TypedDict):
Name: NotRequired[CurrentMetricNameType], # (1)
Unit: NotRequired[UnitType], # (2)- See CurrentMetricNameType
- See UnitType
CurrentMetricSortCriteriaTypeDef#
# CurrentMetricSortCriteriaTypeDef definition
class CurrentMetricSortCriteriaTypeDef(TypedDict):
SortByMetric: NotRequired[CurrentMetricNameType], # (1)
SortOrder: NotRequired[SortOrderType], # (2)- See CurrentMetricNameType
- See SortOrderType
DateConditionTypeDef#
# DateConditionTypeDef definition
class DateConditionTypeDef(TypedDict):
FieldName: NotRequired[str],
Value: NotRequired[str],
ComparisonType: NotRequired[DateComparisonTypeType], # (1)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,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,DeleteEmailAddressRequestRequestTypeDef#
# DeleteEmailAddressRequestRequestTypeDef definition
class DeleteEmailAddressRequestRequestTypeDef(TypedDict):
InstanceId: str,
EmailAddressId: str,DeleteEvaluationFormRequestRequestTypeDef#
# DeleteEvaluationFormRequestRequestTypeDef definition
class DeleteEvaluationFormRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: NotRequired[int],DeleteHoursOfOperationOverrideRequestRequestTypeDef#
# DeleteHoursOfOperationOverrideRequestRequestTypeDef definition
class DeleteHoursOfOperationOverrideRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
HoursOfOperationOverrideId: str,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,DeletePushNotificationRegistrationRequestRequestTypeDef#
# DeletePushNotificationRegistrationRequestRequestTypeDef definition
class DeletePushNotificationRegistrationRequestRequestTypeDef(TypedDict):
InstanceId: str,
RegistrationId: str,
ContactId: 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,DescribeEmailAddressRequestRequestTypeDef#
# DescribeEmailAddressRequestRequestTypeDef definition
class DescribeEmailAddressRequestRequestTypeDef(TypedDict):
InstanceId: str,
EmailAddressId: str,DescribeEvaluationFormRequestRequestTypeDef#
# DescribeEvaluationFormRequestRequestTypeDef definition
class DescribeEvaluationFormRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: NotRequired[int],DescribeHoursOfOperationOverrideRequestRequestTypeDef#
# DescribeHoursOfOperationOverrideRequestRequestTypeDef definition
class DescribeHoursOfOperationOverrideRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
HoursOfOperationOverrideId: str,DescribeHoursOfOperationRequestRequestTypeDef#
# DescribeHoursOfOperationRequestRequestTypeDef definition
class DescribeHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,DescribeInstanceAttributeRequestRequestTypeDef#
# DescribeInstanceAttributeRequestRequestTypeDef definition
class DescribeInstanceAttributeRequestRequestTypeDef(TypedDict):
InstanceId: str,
AttributeType: InstanceAttributeTypeType, # (1)DescribeInstanceRequestRequestTypeDef#
# DescribeInstanceRequestRequestTypeDef definition
class DescribeInstanceRequestRequestTypeDef(TypedDict):
InstanceId: str,DescribeInstanceStorageConfigRequestRequestTypeDef#
# DescribeInstanceStorageConfigRequestRequestTypeDef definition
class DescribeInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)DescribePhoneNumberRequestRequestTypeDef#
# DescribePhoneNumberRequestRequestTypeDef definition
class DescribePhoneNumberRequestRequestTypeDef(TypedDict):
PhoneNumberId: str,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],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]],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)DisassociateInstanceStorageConfigRequestRequestTypeDef#
# DisassociateInstanceStorageConfigRequestRequestTypeDef definition
class DisassociateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)DisassociateLambdaFunctionRequestRequestTypeDef#
# DisassociateLambdaFunctionRequestRequestTypeDef definition
class DisassociateLambdaFunctionRequestRequestTypeDef(TypedDict):
InstanceId: str,
FunctionArn: str,DisassociateLexBotRequestRequestTypeDef#
# DisassociateLexBotRequestRequestTypeDef definition
class DisassociateLexBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
BotName: str,
LexRegion: str,DisassociatePhoneNumberContactFlowRequestRequestTypeDef#
# DisassociatePhoneNumberContactFlowRequestRequestTypeDef definition
class DisassociatePhoneNumberContactFlowRequestRequestTypeDef(TypedDict):
PhoneNumberId: str,
InstanceId: str,DisassociateQueueQuickConnectsRequestRequestTypeDef#
# DisassociateQueueQuickConnectsRequestRequestTypeDef definition
class DisassociateQueueQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
QuickConnectIds: Sequence[str],RoutingProfileQueueReferenceTypeDef#
# RoutingProfileQueueReferenceTypeDef definition
class RoutingProfileQueueReferenceTypeDef(TypedDict):
QueueId: str,
Channel: ChannelType, # (1)- See ChannelType
DisassociateSecurityKeyRequestRequestTypeDef#
# DisassociateSecurityKeyRequestRequestTypeDef definition
class DisassociateSecurityKeyRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,DisassociateTrafficDistributionGroupUserRequestRequestTypeDef#
# DisassociateTrafficDistributionGroupUserRequestRequestTypeDef definition
class DisassociateTrafficDistributionGroupUserRequestRequestTypeDef(TypedDict):
TrafficDistributionGroupId: str,
UserId: str,
InstanceId: str,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],EmailAddressInfoTypeDef#
# EmailAddressInfoTypeDef definition
class EmailAddressInfoTypeDef(TypedDict):
EmailAddress: str,
DisplayName: NotRequired[str],EmailAddressMetadataTypeDef#
# EmailAddressMetadataTypeDef definition
class EmailAddressMetadataTypeDef(TypedDict):
EmailAddressId: NotRequired[str],
EmailAddressArn: NotRequired[str],
EmailAddress: NotRequired[str],
Description: NotRequired[str],
DisplayName: NotRequired[str],EmailAttachmentTypeDef#
# EmailAttachmentTypeDef definition
class EmailAttachmentTypeDef(TypedDict):
FileName: str,
S3Url: str,EmailMessageReferenceTypeDef#
# EmailMessageReferenceTypeDef definition
class EmailMessageReferenceTypeDef(TypedDict):
Name: NotRequired[str],
Arn: 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,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)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,EvaluationFormSingleSelectQuestionOptionTypeDef#
# EvaluationFormSingleSelectQuestionOptionTypeDef definition
class EvaluationFormSingleSelectQuestionOptionTypeDef(TypedDict):
RefId: str,
Text: str,
Score: NotRequired[int],
AutomaticFail: NotRequired[bool],EvaluationFormSummaryTypeDef#
# EvaluationFormSummaryTypeDef definition
class EvaluationFormSummaryTypeDef(TypedDict):
EvaluationFormId: str,
EvaluationFormArn: str,
Title: str,
CreatedTime: datetime,
CreatedBy: str,
LastModifiedTime: datetime,
LastModifiedBy: str,
LatestVersion: int,
LastActivatedTime: NotRequired[datetime],
LastActivatedBy: NotRequired[str],
ActiveVersion: NotRequired[int],EvaluationFormVersionSummaryTypeDef#
# EvaluationFormVersionSummaryTypeDef definition
class EvaluationFormVersionSummaryTypeDef(TypedDict):
EvaluationFormArn: str,
EvaluationFormId: str,
EvaluationFormVersion: int,
Locked: bool,
Status: EvaluationFormVersionStatusType, # (1)
CreatedTime: datetime,
CreatedBy: str,
LastModifiedTime: datetime,
LastModifiedBy: str,EvaluationScoreTypeDef#
# EvaluationScoreTypeDef definition
class EvaluationScoreTypeDef(TypedDict):
Percentage: NotRequired[float],
NotApplicable: NotRequired[bool],
AutomaticFail: NotRequired[bool],EvaluationNoteTypeDef#
# EvaluationNoteTypeDef definition
class EvaluationNoteTypeDef(TypedDict):
Value: NotRequired[str],EventBridgeActionDefinitionTypeDef#
# EventBridgeActionDefinitionTypeDef definition
class EventBridgeActionDefinitionTypeDef(TypedDict):
Name: str,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]],- 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,GetEffectiveHoursOfOperationsRequestRequestTypeDef#
# GetEffectiveHoursOfOperationsRequestRequestTypeDef definition
class GetEffectiveHoursOfOperationsRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
FromDate: str,
ToDate: str,GetFederationTokenRequestRequestTypeDef#
# GetFederationTokenRequestRequestTypeDef definition
class GetFederationTokenRequestRequestTypeDef(TypedDict):
InstanceId: str,GetFlowAssociationRequestRequestTypeDef#
# GetFlowAssociationRequestRequestTypeDef definition
class GetFlowAssociationRequestRequestTypeDef(TypedDict):
InstanceId: str,
ResourceId: str,
ResourceType: FlowAssociationResourceTypeType, # (1)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)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],- See ComparisonType
HoursOfOperationTimeSliceTypeDef#
# HoursOfOperationTimeSliceTypeDef definition
class HoursOfOperationTimeSliceTypeDef(TypedDict):
Hours: int,
Minutes: int,OverrideTimeSliceTypeDef#
# OverrideTimeSliceTypeDef definition
class OverrideTimeSliceTypeDef(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],InboundRawMessageTypeDef#
# InboundRawMessageTypeDef definition
class InboundRawMessageTypeDef(TypedDict):
Subject: str,
Body: str,
ContentType: str,
Headers: NotRequired[Mapping[EmailHeaderTypeType, str]], # (1)InstanceStatusReasonTypeDef#
# InstanceStatusReasonTypeDef definition
class InstanceStatusReasonTypeDef(TypedDict):
Message: NotRequired[str],KinesisFirehoseConfigTypeDef#
# KinesisFirehoseConfigTypeDef definition
class KinesisFirehoseConfigTypeDef(TypedDict):
FirehoseArn: str,KinesisStreamConfigTypeDef#
# KinesisStreamConfigTypeDef definition
class KinesisStreamConfigTypeDef(TypedDict):
StreamArn: str,InstanceSummaryTypeDef#
# InstanceSummaryTypeDef definition
class InstanceSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
IdentityManagementType: NotRequired[DirectoryTypeType], # (1)
InstanceAlias: NotRequired[str],
CreatedTime: NotRequired[datetime],
ServiceRole: NotRequired[str],
InstanceStatus: NotRequired[InstanceStatusType], # (2)
InboundCallsEnabled: NotRequired[bool],
OutboundCallsEnabled: NotRequired[bool],
InstanceAccessUrl: NotRequired[str],- See DirectoryTypeType
- See InstanceStatusType
IntegrationAssociationSummaryTypeDef#
# IntegrationAssociationSummaryTypeDef definition
class IntegrationAssociationSummaryTypeDef(TypedDict):
IntegrationAssociationId: NotRequired[str],
IntegrationAssociationArn: NotRequired[str],
InstanceId: NotRequired[str],
IntegrationType: NotRequired[IntegrationTypeType], # (1)
IntegrationArn: NotRequired[str],
SourceApplicationUrl: NotRequired[str],
SourceApplicationName: NotRequired[str],
SourceType: NotRequired[SourceTypeType], # (2)- See IntegrationTypeType
- See SourceTypeType
TaskTemplateFieldIdentifierTypeDef#
# TaskTemplateFieldIdentifierTypeDef definition
class TaskTemplateFieldIdentifierTypeDef(TypedDict):
Name: NotRequired[str],ListAgentStatusRequestRequestTypeDef#
# ListAgentStatusRequestRequestTypeDef definition
class ListAgentStatusRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
AgentStatusTypes: NotRequired[Sequence[AgentStatusTypeType]], # (1)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],ListAssociatedContactsRequestRequestTypeDef#
# ListAssociatedContactsRequestRequestTypeDef definition
class ListAssociatedContactsRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],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],- 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)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],ListContactReferencesRequestRequestTypeDef#
# ListContactReferencesRequestRequestTypeDef definition
class ListContactReferencesRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ReferenceTypes: Sequence[ReferenceTypeType], # (1)
NextToken: NotRequired[str],ListDefaultVocabulariesRequestRequestTypeDef#
# ListDefaultVocabulariesRequestRequestTypeDef definition
class ListDefaultVocabulariesRequestRequestTypeDef(TypedDict):
InstanceId: str,
LanguageCode: NotRequired[VocabularyLanguageCodeType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListEvaluationFormVersionsRequestRequestTypeDef#
# ListEvaluationFormVersionsRequestRequestTypeDef definition
class ListEvaluationFormVersionsRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListEvaluationFormsRequestRequestTypeDef#
# ListEvaluationFormsRequestRequestTypeDef definition
class ListEvaluationFormsRequestRequestTypeDef(TypedDict):
InstanceId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListFlowAssociationsRequestRequestTypeDef#
# ListFlowAssociationsRequestRequestTypeDef definition
class ListFlowAssociationsRequestRequestTypeDef(TypedDict):
InstanceId: str,
ResourceType: NotRequired[ListFlowAssociationResourceTypeType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListHoursOfOperationOverridesRequestRequestTypeDef#
# ListHoursOfOperationOverridesRequestRequestTypeDef definition
class ListHoursOfOperationOverridesRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListHoursOfOperationsRequestRequestTypeDef#
# ListHoursOfOperationsRequestRequestTypeDef definition
class ListHoursOfOperationsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListInstanceAttributesRequestRequestTypeDef#
# ListInstanceAttributesRequestRequestTypeDef definition
class ListInstanceAttributesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListInstanceStorageConfigsRequestRequestTypeDef#
# ListInstanceStorageConfigsRequestRequestTypeDef definition
class ListInstanceStorageConfigsRequestRequestTypeDef(TypedDict):
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListInstancesRequestRequestTypeDef#
# ListInstancesRequestRequestTypeDef definition
class ListInstancesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListIntegrationAssociationsRequestRequestTypeDef#
# ListIntegrationAssociationsRequestRequestTypeDef definition
class ListIntegrationAssociationsRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationType: NotRequired[IntegrationTypeType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
IntegrationArn: NotRequired[str],ListLambdaFunctionsRequestRequestTypeDef#
# ListLambdaFunctionsRequestRequestTypeDef definition
class ListLambdaFunctionsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListLexBotsRequestRequestTypeDef#
# ListLexBotsRequestRequestTypeDef definition
class ListLexBotsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListPhoneNumbersRequestRequestTypeDef#
# ListPhoneNumbersRequestRequestTypeDef definition
class ListPhoneNumbersRequestRequestTypeDef(TypedDict):
InstanceId: str,
PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]], # (1)
PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]], # (2)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],PhoneNumberSummaryTypeDef#
# PhoneNumberSummaryTypeDef definition
class PhoneNumberSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
PhoneNumber: NotRequired[str],
PhoneNumberType: NotRequired[PhoneNumberTypeType], # (1)
PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType], # (2)ListPhoneNumbersSummaryTypeDef#
# ListPhoneNumbersSummaryTypeDef definition
class ListPhoneNumbersSummaryTypeDef(TypedDict):
PhoneNumberId: NotRequired[str],
PhoneNumberArn: NotRequired[str],
PhoneNumber: NotRequired[str],
PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType], # (1)
PhoneNumberType: NotRequired[PhoneNumberTypeType], # (2)
TargetArn: NotRequired[str],
InstanceId: NotRequired[str],
PhoneNumberDescription: NotRequired[str],
SourcePhoneNumberArn: NotRequired[str],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],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],ListQueuesRequestRequestTypeDef#
# ListQueuesRequestRequestTypeDef definition
class ListQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueTypes: NotRequired[Sequence[QueueTypeType]], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],- See QueueTypeType
QueueSummaryTypeDef#
# QueueSummaryTypeDef definition
class QueueSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
QueueType: NotRequired[QueueTypeType], # (1)
LastModifiedTime: NotRequired[datetime],
LastModifiedRegion: NotRequired[str],- See QueueTypeType
ListQuickConnectsRequestRequestTypeDef#
# ListQuickConnectsRequestRequestTypeDef definition
class ListQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
QuickConnectTypes: NotRequired[Sequence[QuickConnectTypeType]], # (1)ListRealtimeContactAnalysisSegmentsV2RequestRequestTypeDef#
# ListRealtimeContactAnalysisSegmentsV2RequestRequestTypeDef definition
class ListRealtimeContactAnalysisSegmentsV2RequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
OutputType: RealTimeContactAnalysisOutputTypeType, # (1)
SegmentTypes: Sequence[RealTimeContactAnalysisSegmentTypeType], # (2)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListRoutingProfileQueuesRequestRequestTypeDef#
# ListRoutingProfileQueuesRequestRequestTypeDef definition
class ListRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],RoutingProfileQueueConfigSummaryTypeDef#
# RoutingProfileQueueConfigSummaryTypeDef definition
class RoutingProfileQueueConfigSummaryTypeDef(TypedDict):
QueueId: str,
QueueArn: str,
QueueName: str,
Priority: int,
Delay: int,
Channel: ChannelType, # (1)- See ChannelType
ListRoutingProfilesRequestRequestTypeDef#
# ListRoutingProfilesRequestRequestTypeDef definition
class ListRoutingProfilesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],RoutingProfileSummaryTypeDef#
# RoutingProfileSummaryTypeDef definition
class RoutingProfileSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
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],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],TaskTemplateMetadataTypeDef#
# TaskTemplateMetadataTypeDef definition
class TaskTemplateMetadataTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
Status: NotRequired[TaskTemplateStatusType], # (1)
LastModifiedTime: NotRequired[datetime],
CreatedTime: NotRequired[datetime],ListTrafficDistributionGroupUsersRequestRequestTypeDef#
# ListTrafficDistributionGroupUsersRequestRequestTypeDef definition
class ListTrafficDistributionGroupUsersRequestRequestTypeDef(TypedDict):
TrafficDistributionGroupId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],TrafficDistributionGroupUserSummaryTypeDef#
# TrafficDistributionGroupUserSummaryTypeDef definition
class TrafficDistributionGroupUserSummaryTypeDef(TypedDict):
UserId: NotRequired[str],ListTrafficDistributionGroupsRequestRequestTypeDef#
# ListTrafficDistributionGroupsRequestRequestTypeDef definition
class ListTrafficDistributionGroupsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
InstanceId: NotRequired[str],TrafficDistributionGroupSummaryTypeDef#
# TrafficDistributionGroupSummaryTypeDef definition
class TrafficDistributionGroupSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
InstanceArn: NotRequired[str],
Status: NotRequired[TrafficDistributionGroupStatusType], # (1)
IsDefault: NotRequired[bool],ListUseCasesRequestRequestTypeDef#
# ListUseCasesRequestRequestTypeDef definition
class ListUseCasesRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],UseCaseTypeDef#
# UseCaseTypeDef definition
class UseCaseTypeDef(TypedDict):
UseCaseId: NotRequired[str],
UseCaseArn: NotRequired[str],
UseCaseType: NotRequired[UseCaseTypeType], # (1)- See UseCaseTypeType
ListUserHierarchyGroupsRequestRequestTypeDef#
# ListUserHierarchyGroupsRequestRequestTypeDef definition
class ListUserHierarchyGroupsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],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],- See ViewTypeType
ListViewsRequestRequestTypeDef#
# ListViewsRequestRequestTypeDef definition
class ListViewsRequestRequestTypeDef(TypedDict):
InstanceId: str,
Type: NotRequired[ViewTypeType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],- 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],- See ViewTypeType
- 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],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],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],OutboundRawMessageTypeDef#
# OutboundRawMessageTypeDef definition
class OutboundRawMessageTypeDef(TypedDict):
Subject: str,
Body: str,
ContentType: str,ParticipantTimerValueTypeDef#
# ParticipantTimerValueTypeDef definition
class ParticipantTimerValueTypeDef(TypedDict):
ParticipantTimerAction: NotRequired[ParticipantTimerActionType], # (1)
ParticipantTimerDurationInMinutes: NotRequired[int],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],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,QueueInfoInputTypeDef#
# QueueInfoInputTypeDef definition
class QueueInfoInputTypeDef(TypedDict):
Id: NotRequired[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)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)- See RealTimeContactAnalysisPostContactSummaryStatusType
- 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],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],TagSearchConditionTypeDef#
# TagSearchConditionTypeDef definition
class TagSearchConditionTypeDef(TypedDict):
tagKey: NotRequired[str],
tagValue: NotRequired[str],
tagKeyComparisonType: NotRequired[StringComparisonTypeType], # (1)
tagValueComparisonType: NotRequired[StringComparisonTypeType], # (1)ResumeContactRecordingRequestRequestTypeDef#
# ResumeContactRecordingRequestRequestTypeDef definition
class ResumeContactRecordingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
InitialContactId: str,
ContactRecordingType: NotRequired[ContactRecordingTypeType], # (1)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],SortTypeDef#
# SortTypeDef definition
class SortTypeDef(TypedDict):
FieldName: SortableFieldNameType, # (1)
Order: SortOrderType, # (2)- See SortableFieldNameType
- 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)VocabularySummaryTypeDef#
# VocabularySummaryTypeDef definition
class VocabularySummaryTypeDef(TypedDict):
Name: str,
Id: str,
Arn: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
State: VocabularyStateType, # (2)
LastModifiedTime: datetime,
FailureReason: NotRequired[str],SearchableContactAttributesCriteriaTypeDef#
# SearchableContactAttributesCriteriaTypeDef definition
class SearchableContactAttributesCriteriaTypeDef(TypedDict):
Key: str,
Values: Sequence[str],SearchableSegmentAttributesCriteriaTypeDef#
# SearchableSegmentAttributesCriteriaTypeDef definition
class SearchableSegmentAttributesCriteriaTypeDef(TypedDict):
Key: str,
Values: Sequence[str],SegmentAttributeValueTypeDef#
# SegmentAttributeValueTypeDef definition
class SegmentAttributeValueTypeDef(TypedDict):
ValueString: NotRequired[str],
ValueMap: NotRequired[Mapping[str, Mapping[str, Any]]],
ValueInteger: NotRequired[int],SourceCampaignTypeDef#
# SourceCampaignTypeDef definition
class SourceCampaignTypeDef(TypedDict):
CampaignId: NotRequired[str],
OutboundRequestId: NotRequired[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)
IvrRecordingTrack: NotRequired[IvrRecordingTrackType], # (2)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,
ContactRecordingType: NotRequired[ContactRecordingTypeType], # (1)StopContactStreamingRequestRequestTypeDef#
# StopContactStreamingRequestRequestTypeDef definition
class StopContactStreamingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
StreamingId: str,SuspendContactRecordingRequestRequestTypeDef#
# SuspendContactRecordingRequestRequestTypeDef definition
class SuspendContactRecordingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
InitialContactId: str,
ContactRecordingType: NotRequired[ContactRecordingTypeType], # (1)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],TemplateAttributesTypeDef#
# TemplateAttributesTypeDef definition
class TemplateAttributesTypeDef(TypedDict):
CustomAttributes: NotRequired[Mapping[str, str]],
CustomerProfileAttributes: NotRequired[str],TranscriptCriteriaTypeDef#
# TranscriptCriteriaTypeDef definition
class TranscriptCriteriaTypeDef(TypedDict):
ParticipantRole: ParticipantRoleType, # (1)
SearchText: Sequence[str],
MatchType: SearchContactsMatchTypeType, # (2)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],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)UpdateContactFlowModuleContentRequestRequestTypeDef#
# UpdateContactFlowModuleContentRequestRequestTypeDef definition
class UpdateContactFlowModuleContentRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleId: str,
Content: str,UpdateContactFlowModuleMetadataRequestRequestTypeDef#
# UpdateContactFlowModuleMetadataRequestRequestTypeDef definition
class UpdateContactFlowModuleMetadataRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleId: str,
Name: NotRequired[str],
Description: NotRequired[str],
State: NotRequired[ContactFlowModuleStateType], # (1)UpdateContactFlowNameRequestRequestTypeDef#
# UpdateContactFlowNameRequestRequestTypeDef definition
class UpdateContactFlowNameRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,
Name: NotRequired[str],
Description: NotRequired[str],UpdateEmailAddressMetadataRequestRequestTypeDef#
# UpdateEmailAddressMetadataRequestRequestTypeDef definition
class UpdateEmailAddressMetadataRequestRequestTypeDef(TypedDict):
InstanceId: str,
EmailAddressId: str,
Description: NotRequired[str],
DisplayName: NotRequired[str],
ClientToken: NotRequired[str],UpdateInstanceAttributeRequestRequestTypeDef#
# UpdateInstanceAttributeRequestRequestTypeDef definition
class UpdateInstanceAttributeRequestRequestTypeDef(TypedDict):
InstanceId: str,
AttributeType: InstanceAttributeTypeType, # (1)
Value: str,UpdateParticipantAuthenticationRequestRequestTypeDef#
# UpdateParticipantAuthenticationRequestRequestTypeDef definition
class UpdateParticipantAuthenticationRequestRequestTypeDef(TypedDict):
State: str,
InstanceId: str,
Code: NotRequired[str],
Error: NotRequired[str],
ErrorDescription: NotRequired[str],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)- See QueueStatusType
UpdateQuickConnectNameRequestRequestTypeDef#
# UpdateQuickConnectNameRequestRequestTypeDef definition
class UpdateQuickConnectNameRequestRequestTypeDef(TypedDict):
InstanceId: str,
QuickConnectId: str,
Name: NotRequired[str],
Description: NotRequired[str],UpdateRoutingProfileAgentAvailabilityTimerRequestRequestTypeDef#
# UpdateRoutingProfileAgentAvailabilityTimerRequestRequestTypeDef definition
class UpdateRoutingProfileAgentAvailabilityTimerRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
AgentAvailabilityTimer: AgentAvailabilityTimerType, # (1)UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef#
# UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef definition
class UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
DefaultOutboundQueueId: str,UpdateRoutingProfileNameRequestRequestTypeDef#
# UpdateRoutingProfileNameRequestRequestTypeDef definition
class UpdateRoutingProfileNameRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
Name: NotRequired[str],
Description: NotRequired[str],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,ActivateEvaluationFormResponseTypeDef#
# ActivateEvaluationFormResponseTypeDef definition
class ActivateEvaluationFormResponseTypeDef(TypedDict):
EvaluationFormId: str,
EvaluationFormArn: str,
EvaluationFormVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociateAnalyticsDataSetResponseTypeDef#
# AssociateAnalyticsDataSetResponseTypeDef definition
class AssociateAnalyticsDataSetResponseTypeDef(TypedDict):
DataSetId: str,
TargetAccountId: str,
ResourceShareId: str,
ResourceShareArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociateInstanceStorageConfigResponseTypeDef#
# AssociateInstanceStorageConfigResponseTypeDef definition
class AssociateInstanceStorageConfigResponseTypeDef(TypedDict):
AssociationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociateSecurityKeyResponseTypeDef#
# AssociateSecurityKeyResponseTypeDef definition
class AssociateSecurityKeyResponseTypeDef(TypedDict):
AssociationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ClaimPhoneNumberResponseTypeDef#
# ClaimPhoneNumberResponseTypeDef definition
class ClaimPhoneNumberResponseTypeDef(TypedDict):
PhoneNumberId: str,
PhoneNumberArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateAgentStatusResponseTypeDef#
# CreateAgentStatusResponseTypeDef definition
class CreateAgentStatusResponseTypeDef(TypedDict):
AgentStatusARN: str,
AgentStatusId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateContactFlowModuleResponseTypeDef#
# CreateContactFlowModuleResponseTypeDef definition
class CreateContactFlowModuleResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateContactFlowResponseTypeDef#
# CreateContactFlowResponseTypeDef definition
class CreateContactFlowResponseTypeDef(TypedDict):
ContactFlowId: str,
ContactFlowArn: str,
FlowContentSha256: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateContactFlowVersionResponseTypeDef#
# CreateContactFlowVersionResponseTypeDef definition
class CreateContactFlowVersionResponseTypeDef(TypedDict):
ContactFlowArn: str,
Version: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateContactResponseTypeDef#
# CreateContactResponseTypeDef definition
class CreateContactResponseTypeDef(TypedDict):
ContactId: str,
ContactArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateEmailAddressResponseTypeDef#
# CreateEmailAddressResponseTypeDef definition
class CreateEmailAddressResponseTypeDef(TypedDict):
EmailAddressId: str,
EmailAddressArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateEvaluationFormResponseTypeDef#
# CreateEvaluationFormResponseTypeDef definition
class CreateEvaluationFormResponseTypeDef(TypedDict):
EvaluationFormId: str,
EvaluationFormArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateHoursOfOperationOverrideResponseTypeDef#
# CreateHoursOfOperationOverrideResponseTypeDef definition
class CreateHoursOfOperationOverrideResponseTypeDef(TypedDict):
HoursOfOperationOverrideId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateHoursOfOperationResponseTypeDef#
# CreateHoursOfOperationResponseTypeDef definition
class CreateHoursOfOperationResponseTypeDef(TypedDict):
HoursOfOperationId: str,
HoursOfOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateInstanceResponseTypeDef#
# CreateInstanceResponseTypeDef definition
class CreateInstanceResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateIntegrationAssociationResponseTypeDef#
# CreateIntegrationAssociationResponseTypeDef definition
class CreateIntegrationAssociationResponseTypeDef(TypedDict):
IntegrationAssociationId: str,
IntegrationAssociationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreatePersistentContactAssociationResponseTypeDef#
# CreatePersistentContactAssociationResponseTypeDef definition
class CreatePersistentContactAssociationResponseTypeDef(TypedDict):
ContinuedFromContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreatePromptResponseTypeDef#
# CreatePromptResponseTypeDef definition
class CreatePromptResponseTypeDef(TypedDict):
PromptARN: str,
PromptId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreatePushNotificationRegistrationResponseTypeDef#
# CreatePushNotificationRegistrationResponseTypeDef definition
class CreatePushNotificationRegistrationResponseTypeDef(TypedDict):
RegistrationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateQueueResponseTypeDef#
# CreateQueueResponseTypeDef definition
class CreateQueueResponseTypeDef(TypedDict):
QueueArn: str,
QueueId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateQuickConnectResponseTypeDef#
# CreateQuickConnectResponseTypeDef definition
class CreateQuickConnectResponseTypeDef(TypedDict):
QuickConnectARN: str,
QuickConnectId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateRoutingProfileResponseTypeDef#
# CreateRoutingProfileResponseTypeDef definition
class CreateRoutingProfileResponseTypeDef(TypedDict):
RoutingProfileArn: str,
RoutingProfileId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateRuleResponseTypeDef#
# CreateRuleResponseTypeDef definition
class CreateRuleResponseTypeDef(TypedDict):
RuleArn: str,
RuleId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateSecurityProfileResponseTypeDef#
# CreateSecurityProfileResponseTypeDef definition
class CreateSecurityProfileResponseTypeDef(TypedDict):
SecurityProfileId: str,
SecurityProfileArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateTaskTemplateResponseTypeDef#
# CreateTaskTemplateResponseTypeDef definition
class CreateTaskTemplateResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateTrafficDistributionGroupResponseTypeDef#
# CreateTrafficDistributionGroupResponseTypeDef definition
class CreateTrafficDistributionGroupResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateUseCaseResponseTypeDef#
# CreateUseCaseResponseTypeDef definition
class CreateUseCaseResponseTypeDef(TypedDict):
UseCaseId: str,
UseCaseArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateUserHierarchyGroupResponseTypeDef#
# CreateUserHierarchyGroupResponseTypeDef definition
class CreateUserHierarchyGroupResponseTypeDef(TypedDict):
HierarchyGroupId: str,
HierarchyGroupArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateUserResponseTypeDef#
# CreateUserResponseTypeDef definition
class CreateUserResponseTypeDef(TypedDict):
UserId: str,
UserArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateVocabularyResponseTypeDef#
# CreateVocabularyResponseTypeDef definition
class CreateVocabularyResponseTypeDef(TypedDict):
VocabularyArn: str,
VocabularyId: str,
State: VocabularyStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeactivateEvaluationFormResponseTypeDef#
# DeactivateEvaluationFormResponseTypeDef definition
class DeactivateEvaluationFormResponseTypeDef(TypedDict):
EvaluationFormId: str,
EvaluationFormArn: str,
EvaluationFormVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DeleteVocabularyResponseTypeDef#
# DeleteVocabularyResponseTypeDef definition
class DeleteVocabularyResponseTypeDef(TypedDict):
VocabularyArn: str,
VocabularyId: str,
State: VocabularyStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeEmailAddressResponseTypeDef#
# DescribeEmailAddressResponseTypeDef definition
class DescribeEmailAddressResponseTypeDef(TypedDict):
EmailAddressId: str,
EmailAddressArn: str,
EmailAddress: str,
DisplayName: str,
Description: str,
CreateTimestamp: str,
ModifiedTimestamp: str,
Tags: dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetContactAttributesResponseTypeDef#
# GetContactAttributesResponseTypeDef definition
class GetContactAttributesResponseTypeDef(TypedDict):
Attributes: dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetFlowAssociationResponseTypeDef#
# GetFlowAssociationResponseTypeDef definition
class GetFlowAssociationResponseTypeDef(TypedDict):
ResourceId: str,
FlowId: str,
ResourceType: FlowAssociationResourceTypeType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetPromptFileResponseTypeDef#
# GetPromptFileResponseTypeDef definition
class GetPromptFileResponseTypeDef(TypedDict):
PromptPresignedUrl: str,
LastModifiedTime: datetime,
LastModifiedRegion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ImportPhoneNumberResponseTypeDef#
# ImportPhoneNumberResponseTypeDef definition
class ImportPhoneNumberResponseTypeDef(TypedDict):
PhoneNumberId: str,
PhoneNumberArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListApprovedOriginsResponseTypeDef#
# ListApprovedOriginsResponseTypeDef definition
class ListApprovedOriginsResponseTypeDef(TypedDict):
Origins: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
NextToken: NotRequired[str],ListLambdaFunctionsResponseTypeDef#
# ListLambdaFunctionsResponseTypeDef definition
class ListLambdaFunctionsResponseTypeDef(TypedDict):
LambdaFunctions: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
NextToken: NotRequired[str],ListSecurityProfilePermissionsResponseTypeDef#
# ListSecurityProfilePermissionsResponseTypeDef definition
class ListSecurityProfilePermissionsResponseTypeDef(TypedDict):
Permissions: list[str],
LastModifiedTime: datetime,
LastModifiedRegion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
NextToken: NotRequired[str],ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)MonitorContactResponseTypeDef#
# MonitorContactResponseTypeDef definition
class MonitorContactResponseTypeDef(TypedDict):
ContactId: str,
ContactArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ReplicateInstanceResponseTypeDef#
# ReplicateInstanceResponseTypeDef definition
class ReplicateInstanceResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)SendChatIntegrationEventResponseTypeDef#
# SendChatIntegrationEventResponseTypeDef definition
class SendChatIntegrationEventResponseTypeDef(TypedDict):
InitialContactId: str,
NewChatCreated: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartChatContactResponseTypeDef#
# StartChatContactResponseTypeDef definition
class StartChatContactResponseTypeDef(TypedDict):
ContactId: str,
ParticipantId: str,
ParticipantToken: str,
ContinuedFromContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartContactEvaluationResponseTypeDef#
# StartContactEvaluationResponseTypeDef definition
class StartContactEvaluationResponseTypeDef(TypedDict):
EvaluationId: str,
EvaluationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartContactStreamingResponseTypeDef#
# StartContactStreamingResponseTypeDef definition
class StartContactStreamingResponseTypeDef(TypedDict):
StreamingId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartEmailContactResponseTypeDef#
# StartEmailContactResponseTypeDef definition
class StartEmailContactResponseTypeDef(TypedDict):
ContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartOutboundChatContactResponseTypeDef#
# StartOutboundChatContactResponseTypeDef definition
class StartOutboundChatContactResponseTypeDef(TypedDict):
ContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartOutboundEmailContactResponseTypeDef#
# StartOutboundEmailContactResponseTypeDef definition
class StartOutboundEmailContactResponseTypeDef(TypedDict):
ContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartOutboundVoiceContactResponseTypeDef#
# StartOutboundVoiceContactResponseTypeDef definition
class StartOutboundVoiceContactResponseTypeDef(TypedDict):
ContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartTaskContactResponseTypeDef#
# StartTaskContactResponseTypeDef definition
class StartTaskContactResponseTypeDef(TypedDict):
ContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)SubmitContactEvaluationResponseTypeDef#
# SubmitContactEvaluationResponseTypeDef definition
class SubmitContactEvaluationResponseTypeDef(TypedDict):
EvaluationId: str,
EvaluationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)TransferContactResponseTypeDef#
# TransferContactResponseTypeDef definition
class TransferContactResponseTypeDef(TypedDict):
ContactId: str,
ContactArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateContactEvaluationResponseTypeDef#
# UpdateContactEvaluationResponseTypeDef definition
class UpdateContactEvaluationResponseTypeDef(TypedDict):
EvaluationId: str,
EvaluationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateEmailAddressMetadataResponseTypeDef#
# UpdateEmailAddressMetadataResponseTypeDef definition
class UpdateEmailAddressMetadataResponseTypeDef(TypedDict):
EmailAddressId: str,
EmailAddressArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateEvaluationFormResponseTypeDef#
# UpdateEvaluationFormResponseTypeDef definition
class UpdateEvaluationFormResponseTypeDef(TypedDict):
EvaluationFormId: str,
EvaluationFormArn: str,
EvaluationFormVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdatePhoneNumberResponseTypeDef#
# UpdatePhoneNumberResponseTypeDef definition
class UpdatePhoneNumberResponseTypeDef(TypedDict):
PhoneNumberId: str,
PhoneNumberArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdatePromptResponseTypeDef#
# UpdatePromptResponseTypeDef definition
class UpdatePromptResponseTypeDef(TypedDict):
PromptARN: str,
PromptId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AdditionalEmailRecipientsTypeDef#
# AdditionalEmailRecipientsTypeDef definition
class AdditionalEmailRecipientsTypeDef(TypedDict):
ToList: NotRequired[list[EmailRecipientTypeDef]], # (1)
CcList: NotRequired[list[EmailRecipientTypeDef]], # (1)AgentConfigOutputTypeDef#
# AgentConfigOutputTypeDef definition
class AgentConfigOutputTypeDef(TypedDict):
Distributions: list[DistributionTypeDef], # (1)AgentConfigTypeDef#
# AgentConfigTypeDef definition
class AgentConfigTypeDef(TypedDict):
Distributions: Sequence[DistributionTypeDef], # (1)TelephonyConfigOutputTypeDef#
# TelephonyConfigOutputTypeDef definition
class TelephonyConfigOutputTypeDef(TypedDict):
Distributions: list[DistributionTypeDef], # (1)TelephonyConfigTypeDef#
# TelephonyConfigTypeDef definition
class TelephonyConfigTypeDef(TypedDict):
Distributions: Sequence[DistributionTypeDef], # (1)AgentContactReferenceTypeDef#
# AgentContactReferenceTypeDef definition
class AgentContactReferenceTypeDef(TypedDict):
ContactId: NotRequired[str],
Channel: NotRequired[ChannelType], # (1)
InitiationMethod: NotRequired[ContactInitiationMethodType], # (2)
AgentContactState: NotRequired[ContactStateType], # (3)
StateStartTimestamp: NotRequired[datetime],
ConnectedToAgentTimestamp: NotRequired[datetime],
Queue: NotRequired[QueueReferenceTypeDef], # (4)- See ChannelType
- See ContactInitiationMethodType
- See ContactStateType
- See QueueReferenceTypeDef
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)- See AgentHierarchyGroupTypeDef
- See AgentHierarchyGroupTypeDef
- See AgentHierarchyGroupTypeDef
- See AgentHierarchyGroupTypeDef
- See AgentHierarchyGroupTypeDef
AllowedCapabilitiesTypeDef#
# AllowedCapabilitiesTypeDef definition
class AllowedCapabilitiesTypeDef(TypedDict):
Customer: NotRequired[ParticipantCapabilitiesTypeDef], # (1)
Agent: NotRequired[ParticipantCapabilitiesTypeDef], # (1)CustomerTypeDef#
# CustomerTypeDef definition
class CustomerTypeDef(TypedDict):
DeviceInfo: NotRequired[DeviceInfoTypeDef], # (1)
Capabilities: NotRequired[ParticipantCapabilitiesTypeDef], # (2)AgentQualityMetricsTypeDef#
# AgentQualityMetricsTypeDef definition
class AgentQualityMetricsTypeDef(TypedDict):
Audio: NotRequired[AudioQualityMetricsInfoTypeDef], # (1)CustomerQualityMetricsTypeDef#
# CustomerQualityMetricsTypeDef definition
class CustomerQualityMetricsTypeDef(TypedDict):
Audio: NotRequired[AudioQualityMetricsInfoTypeDef], # (1)AgentStatusSearchCriteriaPaginatorTypeDef#
# AgentStatusSearchCriteriaPaginatorTypeDef definition
class AgentStatusSearchCriteriaPaginatorTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)AgentStatusSearchCriteriaTypeDef#
# AgentStatusSearchCriteriaTypeDef definition
class AgentStatusSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)ContactFlowModuleSearchCriteriaPaginatorTypeDef#
# ContactFlowModuleSearchCriteriaPaginatorTypeDef definition
class ContactFlowModuleSearchCriteriaPaginatorTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)
StateCondition: NotRequired[ContactFlowModuleStateType], # (2)
StatusCondition: NotRequired[ContactFlowModuleStatusType], # (3)ContactFlowModuleSearchCriteriaTypeDef#
# ContactFlowModuleSearchCriteriaTypeDef definition
class ContactFlowModuleSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)
StateCondition: NotRequired[ContactFlowModuleStateType], # (2)
StatusCondition: NotRequired[ContactFlowModuleStatusType], # (3)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)- See StringConditionTypeDef
- See ContactFlowTypeType
- See ContactFlowStateType
- 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)- See StringConditionTypeDef
- See ContactFlowTypeType
- See ContactFlowStateType
- See ContactFlowStatusType
EmailAddressSearchCriteriaTypeDef#
# EmailAddressSearchCriteriaTypeDef definition
class EmailAddressSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)HoursOfOperationSearchCriteriaPaginatorTypeDef#
# HoursOfOperationSearchCriteriaPaginatorTypeDef definition
class HoursOfOperationSearchCriteriaPaginatorTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)HoursOfOperationSearchCriteriaTypeDef#
# HoursOfOperationSearchCriteriaTypeDef definition
class HoursOfOperationSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)PredefinedAttributeSearchCriteriaPaginatorTypeDef#
# PredefinedAttributeSearchCriteriaPaginatorTypeDef definition
class PredefinedAttributeSearchCriteriaPaginatorTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)PredefinedAttributeSearchCriteriaTypeDef#
# PredefinedAttributeSearchCriteriaTypeDef definition
class PredefinedAttributeSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)PromptSearchCriteriaPaginatorTypeDef#
# PromptSearchCriteriaPaginatorTypeDef definition
class PromptSearchCriteriaPaginatorTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)PromptSearchCriteriaTypeDef#
# PromptSearchCriteriaTypeDef definition
class PromptSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)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)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)QuickConnectSearchCriteriaPaginatorTypeDef#
# QuickConnectSearchCriteriaPaginatorTypeDef definition
class QuickConnectSearchCriteriaPaginatorTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)QuickConnectSearchCriteriaTypeDef#
# QuickConnectSearchCriteriaTypeDef definition
class QuickConnectSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)RoutingProfileSearchCriteriaPaginatorTypeDef#
# RoutingProfileSearchCriteriaPaginatorTypeDef definition
class RoutingProfileSearchCriteriaPaginatorTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)RoutingProfileSearchCriteriaTypeDef#
# RoutingProfileSearchCriteriaTypeDef definition
class RoutingProfileSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)SecurityProfileSearchCriteriaPaginatorTypeDef#
# SecurityProfileSearchCriteriaPaginatorTypeDef definition
class SecurityProfileSearchCriteriaPaginatorTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)SecurityProfileSearchCriteriaTypeDef#
# SecurityProfileSearchCriteriaTypeDef definition
class SecurityProfileSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)UserHierarchyGroupSearchCriteriaPaginatorTypeDef#
# UserHierarchyGroupSearchCriteriaPaginatorTypeDef definition
class UserHierarchyGroupSearchCriteriaPaginatorTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)UserHierarchyGroupSearchCriteriaTypeDef#
# UserHierarchyGroupSearchCriteriaTypeDef definition
class UserHierarchyGroupSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)ListAgentStatusResponseTypeDef#
# ListAgentStatusResponseTypeDef definition
class ListAgentStatusResponseTypeDef(TypedDict):
AgentStatusSummaryList: list[AgentStatusSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeAgentStatusResponseTypeDef#
# DescribeAgentStatusResponseTypeDef definition
class DescribeAgentStatusResponseTypeDef(TypedDict):
AgentStatus: AgentStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchAgentStatusesResponseTypeDef#
# SearchAgentStatusesResponseTypeDef definition
class SearchAgentStatusesResponseTypeDef(TypedDict):
AgentStatuses: list[AgentStatusTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],MatchCriteriaOutputTypeDef#
# MatchCriteriaOutputTypeDef definition
class MatchCriteriaOutputTypeDef(TypedDict):
AgentsCriteria: NotRequired[AgentsCriteriaOutputTypeDef], # (1)ListAnalyticsDataAssociationsResponseTypeDef#
# ListAnalyticsDataAssociationsResponseTypeDef definition
class ListAnalyticsDataAssociationsResponseTypeDef(TypedDict):
Results: list[AnalyticsDataAssociationResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListSecurityProfileApplicationsResponseTypeDef#
# ListSecurityProfileApplicationsResponseTypeDef definition
class ListSecurityProfileApplicationsResponseTypeDef(TypedDict):
Applications: list[ApplicationOutputTypeDef], # (1)
LastModifiedTime: datetime,
LastModifiedRegion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],UpdateSecurityProfileRequestRequestTypeDef#
# UpdateSecurityProfileRequestRequestTypeDef definition
class UpdateSecurityProfileRequestRequestTypeDef(TypedDict):
SecurityProfileId: str,
InstanceId: str,
Description: NotRequired[str],
Permissions: NotRequired[Sequence[str]],
AllowedAccessControlTags: NotRequired[Mapping[str, str]],
TagRestrictedResources: NotRequired[Sequence[str]],
Applications: NotRequired[Sequence[ApplicationTypeDef]], # (1)
HierarchyRestrictedResources: NotRequired[Sequence[str]],
AllowedAccessControlHierarchyGroupId: NotRequired[str],AssociateLexBotRequestRequestTypeDef#
# AssociateLexBotRequestRequestTypeDef definition
class AssociateLexBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
LexBot: LexBotTypeDef, # (1)- See LexBotTypeDef
ListLexBotsResponseTypeDef#
# ListLexBotsResponseTypeDef definition
class ListLexBotsResponseTypeDef(TypedDict):
LexBots: list[LexBotTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See LexBotTypeDef
- See ResponseMetadataTypeDef
AssociateBotRequestRequestTypeDef#
# AssociateBotRequestRequestTypeDef definition
class AssociateBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
LexBot: NotRequired[LexBotTypeDef], # (1)
LexV2Bot: NotRequired[LexV2BotTypeDef], # (2)- See LexBotTypeDef
- See LexV2BotTypeDef
DisassociateBotRequestRequestTypeDef#
# DisassociateBotRequestRequestTypeDef definition
class DisassociateBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
LexBot: NotRequired[LexBotTypeDef], # (1)
LexV2Bot: NotRequired[LexV2BotTypeDef], # (2)- See LexBotTypeDef
- See LexV2BotTypeDef
LexBotConfigTypeDef#
# LexBotConfigTypeDef definition
class LexBotConfigTypeDef(TypedDict):
LexBot: NotRequired[LexBotTypeDef], # (1)
LexV2Bot: NotRequired[LexV2BotTypeDef], # (2)- See LexBotTypeDef
- See LexV2BotTypeDef
AssociateUserProficienciesRequestRequestTypeDef#
# AssociateUserProficienciesRequestRequestTypeDef definition
class AssociateUserProficienciesRequestRequestTypeDef(TypedDict):
InstanceId: str,
UserId: str,
UserProficiencies: Sequence[UserProficiencyTypeDef], # (1)ListUserProficienciesResponseTypeDef#
# ListUserProficienciesResponseTypeDef definition
class ListUserProficienciesResponseTypeDef(TypedDict):
UserProficiencyList: list[UserProficiencyTypeDef], # (1)
LastModifiedTime: datetime,
LastModifiedRegion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],UpdateUserProficienciesRequestRequestTypeDef#
# UpdateUserProficienciesRequestRequestTypeDef definition
class UpdateUserProficienciesRequestRequestTypeDef(TypedDict):
InstanceId: str,
UserId: str,
UserProficiencies: Sequence[UserProficiencyTypeDef], # (1)ListAssociatedContactsResponseTypeDef#
# ListAssociatedContactsResponseTypeDef definition
class ListAssociatedContactsResponseTypeDef(TypedDict):
ContactSummaryList: list[AssociatedContactSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],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]],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]],AttributeAndConditionTypeDef#
# AttributeAndConditionTypeDef definition
class AttributeAndConditionTypeDef(TypedDict):
TagConditions: NotRequired[Sequence[TagConditionTypeDef]], # (1)
HierarchyGroupCondition: NotRequired[HierarchyGroupConditionTypeDef], # (2)CommonAttributeAndConditionTypeDef#
# CommonAttributeAndConditionTypeDef definition
class CommonAttributeAndConditionTypeDef(TypedDict):
TagConditions: NotRequired[Sequence[TagConditionTypeDef]], # (1)ControlPlaneTagFilterTypeDef#
# ControlPlaneTagFilterTypeDef definition
class ControlPlaneTagFilterTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Sequence[TagConditionTypeDef]]], # (1)
AndConditions: NotRequired[Sequence[TagConditionTypeDef]], # (2)
TagCondition: NotRequired[TagConditionTypeDef], # (3)DescribeInstanceAttributeResponseTypeDef#
# DescribeInstanceAttributeResponseTypeDef definition
class DescribeInstanceAttributeResponseTypeDef(TypedDict):
Attribute: AttributeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListInstanceAttributesResponseTypeDef#
# ListInstanceAttributesResponseTypeDef definition
class ListInstanceAttributesResponseTypeDef(TypedDict):
Attributes: list[AttributeTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],MeetingFeaturesConfigurationTypeDef#
# MeetingFeaturesConfigurationTypeDef definition
class MeetingFeaturesConfigurationTypeDef(TypedDict):
Audio: NotRequired[AudioFeaturesTypeDef], # (1)ListAuthenticationProfilesResponseTypeDef#
# ListAuthenticationProfilesResponseTypeDef definition
class ListAuthenticationProfilesResponseTypeDef(TypedDict):
AuthenticationProfileSummaryList: list[AuthenticationProfileSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeAuthenticationProfileResponseTypeDef#
# DescribeAuthenticationProfileResponseTypeDef definition
class DescribeAuthenticationProfileResponseTypeDef(TypedDict):
AuthenticationProfile: AuthenticationProfileTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchAvailablePhoneNumbersResponseTypeDef#
# SearchAvailablePhoneNumbersResponseTypeDef definition
class SearchAvailablePhoneNumbersResponseTypeDef(TypedDict):
AvailableNumbersList: list[AvailableNumberSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],BatchAssociateAnalyticsDataSetResponseTypeDef#
# BatchAssociateAnalyticsDataSetResponseTypeDef definition
class BatchAssociateAnalyticsDataSetResponseTypeDef(TypedDict):
Created: list[AnalyticsDataAssociationResultTypeDef], # (1)
Errors: list[ErrorResultTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)BatchDisassociateAnalyticsDataSetResponseTypeDef#
# BatchDisassociateAnalyticsDataSetResponseTypeDef definition
class BatchDisassociateAnalyticsDataSetResponseTypeDef(TypedDict):
Deleted: list[str],
Errors: list[ErrorResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)BatchGetFlowAssociationResponseTypeDef#
# BatchGetFlowAssociationResponseTypeDef definition
class BatchGetFlowAssociationResponseTypeDef(TypedDict):
FlowAssociationSummaryList: list[FlowAssociationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListFlowAssociationsResponseTypeDef#
# ListFlowAssociationsResponseTypeDef definition
class ListFlowAssociationsResponseTypeDef(TypedDict):
FlowAssociationSummaryList: list[FlowAssociationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],BatchPutContactResponseTypeDef#
# BatchPutContactResponseTypeDef definition
class BatchPutContactResponseTypeDef(TypedDict):
SuccessfulRequestList: list[SuccessfulRequestTypeDef], # (1)
FailedRequestList: list[FailedRequestTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)StartContactStreamingRequestRequestTypeDef#
# StartContactStreamingRequestRequestTypeDef definition
class StartContactStreamingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ChatStreamingConfiguration: ChatStreamingConfigurationTypeDef, # (1)
ClientToken: str,ClaimedPhoneNumberSummaryTypeDef#
# ClaimedPhoneNumberSummaryTypeDef definition
class ClaimedPhoneNumberSummaryTypeDef(TypedDict):
PhoneNumberId: NotRequired[str],
PhoneNumberArn: NotRequired[str],
PhoneNumber: NotRequired[str],
PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType], # (1)
PhoneNumberType: NotRequired[PhoneNumberTypeType], # (2)
PhoneNumberDescription: NotRequired[str],
TargetArn: NotRequired[str],
InstanceId: NotRequired[str],
Tags: NotRequired[dict[str, str]],
PhoneNumberStatus: NotRequired[PhoneNumberStatusTypeDef], # (3)
SourcePhoneNumberArn: NotRequired[str],ConditionTypeDef#
# ConditionTypeDef definition
class ConditionTypeDef(TypedDict):
StringCondition: NotRequired[StringConditionTypeDef], # (1)
NumberCondition: NotRequired[NumberConditionTypeDef], # (2)CreatePushNotificationRegistrationRequestRequestTypeDef#
# CreatePushNotificationRegistrationRequestRequestTypeDef definition
class CreatePushNotificationRegistrationRequestRequestTypeDef(TypedDict):
InstanceId: str,
PinpointAppArn: str,
DeviceToken: str,
DeviceType: DeviceTypeType, # (1)
ContactConfiguration: ContactConfigurationTypeDef, # (2)
ClientToken: NotRequired[str],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)- See EndpointTypeDef
- See EndpointTypeDef
- 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]],ListContactFlowModulesResponseTypeDef#
# ListContactFlowModulesResponseTypeDef definition
class ListContactFlowModulesResponseTypeDef(TypedDict):
ContactFlowModulesSummaryList: list[ContactFlowModuleSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeContactFlowModuleResponseTypeDef#
# DescribeContactFlowModuleResponseTypeDef definition
class DescribeContactFlowModuleResponseTypeDef(TypedDict):
ContactFlowModule: ContactFlowModuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchContactFlowModulesResponseTypeDef#
# SearchContactFlowModulesResponseTypeDef definition
class SearchContactFlowModulesResponseTypeDef(TypedDict):
ContactFlowModules: list[ContactFlowModuleTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListContactFlowsResponseTypeDef#
# ListContactFlowsResponseTypeDef definition
class ListContactFlowsResponseTypeDef(TypedDict):
ContactFlowSummaryList: list[ContactFlowSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeContactFlowResponseTypeDef#
# DescribeContactFlowResponseTypeDef definition
class DescribeContactFlowResponseTypeDef(TypedDict):
ContactFlow: ContactFlowTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchContactFlowsResponseTypeDef#
# SearchContactFlowsResponseTypeDef definition
class SearchContactFlowsResponseTypeDef(TypedDict):
ContactFlows: list[ContactFlowTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListContactFlowVersionsResponseTypeDef#
# ListContactFlowVersionsResponseTypeDef definition
class ListContactFlowVersionsResponseTypeDef(TypedDict):
ContactFlowVersionSummaryList: list[ContactFlowVersionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],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],
SegmentAttributes: NotRequired[dict[str, ContactSearchSummarySegmentAttributeValueTypeDef]], # (5)- See ContactInitiationMethodType
- See ChannelType
- See ContactSearchSummaryQueueInfoTypeDef
- See ContactSearchSummaryAgentInfoTypeDef
- See ContactSearchSummarySegmentAttributeValueTypeDef
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,UpdateContactScheduleRequestRequestTypeDef#
# UpdateContactScheduleRequestRequestTypeDef definition
class UpdateContactScheduleRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ScheduledTime: TimestampTypeDef,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)TaskActionDefinitionOutputTypeDef#
# TaskActionDefinitionOutputTypeDef definition
class TaskActionDefinitionOutputTypeDef(TypedDict):
Name: str,
ContactFlowId: str,
Description: NotRequired[str],
References: NotRequired[dict[str, ReferenceTypeDef]], # (1)- See ReferenceTypeDef
TaskActionDefinitionTypeDef#
# TaskActionDefinitionTypeDef definition
class TaskActionDefinitionTypeDef(TypedDict):
Name: str,
ContactFlowId: str,
Description: NotRequired[str],
References: NotRequired[Mapping[str, ReferenceTypeDef]], # (1)- See ReferenceTypeDef
CreateParticipantRequestRequestTypeDef#
# CreateParticipantRequestRequestTypeDef definition
class CreateParticipantRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ParticipantDetails: ParticipantDetailsToAddTypeDef, # (1)
ClientToken: NotRequired[str],CreateParticipantResponseTypeDef#
# CreateParticipantResponseTypeDef definition
class CreateParticipantResponseTypeDef(TypedDict):
ParticipantCredentials: ParticipantTokenCredentialsTypeDef, # (1)
ParticipantId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreatePredefinedAttributeRequestRequestTypeDef#
# CreatePredefinedAttributeRequestRequestTypeDef definition
class CreatePredefinedAttributeRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
Values: PredefinedAttributeValuesTypeDef, # (1)UpdatePredefinedAttributeRequestRequestTypeDef#
# UpdatePredefinedAttributeRequestRequestTypeDef definition
class UpdatePredefinedAttributeRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
Values: NotRequired[PredefinedAttributeValuesTypeDef], # (1)UpdateQueueOutboundCallerConfigRequestRequestTypeDef#
# UpdateQueueOutboundCallerConfigRequestRequestTypeDef definition
class UpdateQueueOutboundCallerConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
OutboundCallerConfig: OutboundCallerConfigTypeDef, # (1)CreateQueueRequestRequestTypeDef#
# CreateQueueRequestRequestTypeDef definition
class CreateQueueRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
HoursOfOperationId: str,
Description: NotRequired[str],
OutboundCallerConfig: NotRequired[OutboundCallerConfigTypeDef], # (1)
OutboundEmailConfig: NotRequired[OutboundEmailConfigTypeDef], # (2)
MaxContacts: NotRequired[int],
QuickConnectIds: NotRequired[Sequence[str]],
Tags: NotRequired[Mapping[str, str]],QueueTypeDef#
# QueueTypeDef definition
class QueueTypeDef(TypedDict):
Name: NotRequired[str],
QueueArn: NotRequired[str],
QueueId: NotRequired[str],
Description: NotRequired[str],
OutboundCallerConfig: NotRequired[OutboundCallerConfigTypeDef], # (1)
OutboundEmailConfig: NotRequired[OutboundEmailConfigTypeDef], # (2)
HoursOfOperationId: NotRequired[str],
MaxContacts: NotRequired[int],
Status: NotRequired[QueueStatusType], # (3)
Tags: NotRequired[dict[str, str]],
LastModifiedTime: NotRequired[datetime],
LastModifiedRegion: NotRequired[str],UpdateQueueOutboundEmailConfigRequestRequestTypeDef#
# UpdateQueueOutboundEmailConfigRequestRequestTypeDef definition
class UpdateQueueOutboundEmailConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
OutboundEmailConfig: OutboundEmailConfigTypeDef, # (1)UpdateUserIdentityInfoRequestRequestTypeDef#
# UpdateUserIdentityInfoRequestRequestTypeDef definition
class UpdateUserIdentityInfoRequestRequestTypeDef(TypedDict):
IdentityInfo: UserIdentityInfoTypeDef, # (1)
UserId: str,
InstanceId: str,CreateUserRequestRequestTypeDef#
# CreateUserRequestRequestTypeDef definition
class CreateUserRequestRequestTypeDef(TypedDict):
Username: str,
PhoneConfig: UserPhoneConfigTypeDef, # (1)
SecurityProfileIds: Sequence[str],
RoutingProfileId: str,
InstanceId: str,
Password: NotRequired[str],
IdentityInfo: NotRequired[UserIdentityInfoTypeDef], # (2)
DirectoryUserId: NotRequired[str],
HierarchyGroupId: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],UpdateUserPhoneConfigRequestRequestTypeDef#
# UpdateUserPhoneConfigRequestRequestTypeDef definition
class UpdateUserPhoneConfigRequestRequestTypeDef(TypedDict):
PhoneConfig: UserPhoneConfigTypeDef, # (1)
UserId: str,
InstanceId: str,UserTypeDef#
# UserTypeDef definition
class UserTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Username: NotRequired[str],
IdentityInfo: NotRequired[UserIdentityInfoTypeDef], # (1)
PhoneConfig: NotRequired[UserPhoneConfigTypeDef], # (2)
DirectoryUserId: NotRequired[str],
SecurityProfileIds: NotRequired[list[str]],
RoutingProfileId: NotRequired[str],
HierarchyGroupId: NotRequired[str],
Tags: NotRequired[dict[str, str]],
LastModifiedTime: NotRequired[datetime],
LastModifiedRegion: NotRequired[str],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]],UpdateViewContentRequestRequestTypeDef#
# UpdateViewContentRequestRequestTypeDef definition
class UpdateViewContentRequestRequestTypeDef(TypedDict):
InstanceId: str,
ViewId: str,
Status: ViewStatusType, # (1)
Content: ViewInputContentTypeDef, # (2)GetFederationTokenResponseTypeDef#
# GetFederationTokenResponseTypeDef definition
class GetFederationTokenResponseTypeDef(TypedDict):
Credentials: CredentialsTypeDef, # (1)
SignInUrl: str,
UserArn: str,
UserId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)MediaConcurrencyTypeDef#
# MediaConcurrencyTypeDef definition
class MediaConcurrencyTypeDef(TypedDict):
Channel: ChannelType, # (1)
Concurrency: int,
CrossChannelBehavior: NotRequired[CrossChannelBehaviorTypeDef], # (2)CurrentMetricDataTypeDef#
# CurrentMetricDataTypeDef definition
class CurrentMetricDataTypeDef(TypedDict):
Metric: NotRequired[CurrentMetricTypeDef], # (1)
Value: NotRequired[float],HoursOfOperationOverrideSearchCriteriaPaginatorTypeDef#
# HoursOfOperationOverrideSearchCriteriaPaginatorTypeDef definition
class HoursOfOperationOverrideSearchCriteriaPaginatorTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)
DateCondition: NotRequired[DateConditionTypeDef], # (2)HoursOfOperationOverrideSearchCriteriaTypeDef#
# HoursOfOperationOverrideSearchCriteriaTypeDef definition
class HoursOfOperationOverrideSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Mapping[str, Any]]],
AndConditions: NotRequired[Sequence[Mapping[str, Any]]],
StringCondition: NotRequired[StringConditionTypeDef], # (1)
DateCondition: NotRequired[DateConditionTypeDef], # (2)ListDefaultVocabulariesResponseTypeDef#
# ListDefaultVocabulariesResponseTypeDef definition
class ListDefaultVocabulariesResponseTypeDef(TypedDict):
DefaultVocabularyList: list[DefaultVocabularyTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribePromptResponseTypeDef#
# DescribePromptResponseTypeDef definition
class DescribePromptResponseTypeDef(TypedDict):
Prompt: PromptTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See PromptTypeDef
- See ResponseMetadataTypeDef
SearchPromptsResponseTypeDef#
# SearchPromptsResponseTypeDef definition
class SearchPromptsResponseTypeDef(TypedDict):
Prompts: list[PromptTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See PromptTypeDef
- See ResponseMetadataTypeDef
DescribeSecurityProfileResponseTypeDef#
# DescribeSecurityProfileResponseTypeDef definition
class DescribeSecurityProfileResponseTypeDef(TypedDict):
SecurityProfile: SecurityProfileTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeTrafficDistributionGroupResponseTypeDef#
# DescribeTrafficDistributionGroupResponseTypeDef definition
class DescribeTrafficDistributionGroupResponseTypeDef(TypedDict):
TrafficDistributionGroup: TrafficDistributionGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeVocabularyResponseTypeDef#
# DescribeVocabularyResponseTypeDef definition
class DescribeVocabularyResponseTypeDef(TypedDict):
Vocabulary: VocabularyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DimensionsTypeDef#
# DimensionsTypeDef definition
class DimensionsTypeDef(TypedDict):
Queue: NotRequired[QueueReferenceTypeDef], # (1)
Channel: NotRequired[ChannelType], # (2)
RoutingProfile: NotRequired[RoutingProfileReferenceTypeDef], # (3)
RoutingStepExpression: NotRequired[str],DisassociateRoutingProfileQueuesRequestRequestTypeDef#
# DisassociateRoutingProfileQueuesRequestRequestTypeDef definition
class DisassociateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
QueueReferences: Sequence[RoutingProfileQueueReferenceTypeDef], # (1)RoutingProfileQueueConfigTypeDef#
# RoutingProfileQueueConfigTypeDef definition
class RoutingProfileQueueConfigTypeDef(TypedDict):
QueueReference: RoutingProfileQueueReferenceTypeDef, # (1)
Priority: int,
Delay: int,DisassociateUserProficienciesRequestRequestTypeDef#
# DisassociateUserProficienciesRequestRequestTypeDef definition
class DisassociateUserProficienciesRequestRequestTypeDef(TypedDict):
InstanceId: str,
UserId: str,
UserProficiencies: Sequence[UserProficiencyDisassociateTypeDef], # (1)StopContactRequestRequestTypeDef#
# StopContactRequestRequestTypeDef definition
class StopContactRequestRequestTypeDef(TypedDict):
ContactId: str,
InstanceId: str,
DisconnectReason: NotRequired[DisconnectReasonTypeDef], # (1)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)- See FileStatusTypeType
- See FileUseCaseTypeType
- See CreatedByInfoTypeDef
- See DownloadUrlMetadataTypeDef
- See ResponseMetadataTypeDef
InboundAdditionalRecipientsTypeDef#
# InboundAdditionalRecipientsTypeDef definition
class InboundAdditionalRecipientsTypeDef(TypedDict):
ToAddresses: NotRequired[Sequence[EmailAddressInfoTypeDef]], # (1)
CcAddresses: NotRequired[Sequence[EmailAddressInfoTypeDef]], # (1)OutboundAdditionalRecipientsTypeDef#
# OutboundAdditionalRecipientsTypeDef definition
class OutboundAdditionalRecipientsTypeDef(TypedDict):
CcEmailAddresses: NotRequired[Sequence[EmailAddressInfoTypeDef]], # (1)SearchEmailAddressesResponseTypeDef#
# SearchEmailAddressesResponseTypeDef definition
class SearchEmailAddressesResponseTypeDef(TypedDict):
EmailAddresses: list[EmailAddressMetadataTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],KinesisVideoStreamConfigTypeDef#
# KinesisVideoStreamConfigTypeDef definition
class KinesisVideoStreamConfigTypeDef(TypedDict):
Prefix: str,
RetentionPeriodHours: int,
EncryptionConfig: EncryptionConfigTypeDef, # (1)S3ConfigTypeDef#
# S3ConfigTypeDef definition
class S3ConfigTypeDef(TypedDict):
BucketName: str,
BucketPrefix: str,
EncryptionConfig: NotRequired[EncryptionConfigTypeDef], # (1)EvaluationAnswerInputTypeDef#
# EvaluationAnswerInputTypeDef definition
class EvaluationAnswerInputTypeDef(TypedDict):
Value: NotRequired[EvaluationAnswerDataTypeDef], # (1)EvaluationAnswerOutputTypeDef#
# EvaluationAnswerOutputTypeDef definition
class EvaluationAnswerOutputTypeDef(TypedDict):
Value: NotRequired[EvaluationAnswerDataTypeDef], # (1)
SystemSuggestedValue: NotRequired[EvaluationAnswerDataTypeDef], # (1)EvaluationFormNumericQuestionAutomationTypeDef#
# EvaluationFormNumericQuestionAutomationTypeDef definition
class EvaluationFormNumericQuestionAutomationTypeDef(TypedDict):
PropertyValue: NotRequired[NumericQuestionPropertyValueAutomationTypeDef], # (1)EvaluationFormSingleSelectQuestionAutomationOptionTypeDef#
# EvaluationFormSingleSelectQuestionAutomationOptionTypeDef definition
class EvaluationFormSingleSelectQuestionAutomationOptionTypeDef(TypedDict):
RuleCategory: NotRequired[SingleSelectQuestionRuleCategoryAutomationTypeDef], # (1)ListEvaluationFormsResponseTypeDef#
# ListEvaluationFormsResponseTypeDef definition
class ListEvaluationFormsResponseTypeDef(TypedDict):
EvaluationFormSummaryList: list[EvaluationFormSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListEvaluationFormVersionsResponseTypeDef#
# ListEvaluationFormVersionsResponseTypeDef definition
class ListEvaluationFormVersionsResponseTypeDef(TypedDict):
EvaluationFormVersionSummaryList: list[EvaluationFormVersionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],EvaluationMetadataTypeDef#
# EvaluationMetadataTypeDef definition
class EvaluationMetadataTypeDef(TypedDict):
ContactId: str,
EvaluatorArn: str,
ContactAgentId: NotRequired[str],
Score: NotRequired[EvaluationScoreTypeDef], # (1)EvaluationSummaryTypeDef#
# EvaluationSummaryTypeDef definition
class EvaluationSummaryTypeDef(TypedDict):
EvaluationId: str,
EvaluationArn: str,
EvaluationFormTitle: str,
EvaluationFormId: str,
Status: EvaluationStatusType, # (1)
EvaluatorArn: str,
CreatedTime: datetime,
LastModifiedTime: datetime,
Score: NotRequired[EvaluationScoreTypeDef], # (2)FieldValueOutputTypeDef#
# FieldValueOutputTypeDef definition
class FieldValueOutputTypeDef(TypedDict):
Id: str,
Value: FieldValueUnionOutputTypeDef, # (1)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)ListAgentStatusRequestPaginateTypeDef#
# ListAgentStatusRequestPaginateTypeDef definition
class ListAgentStatusRequestPaginateTypeDef(TypedDict):
InstanceId: str,
AgentStatusTypes: NotRequired[Sequence[AgentStatusTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListApprovedOriginsRequestPaginateTypeDef#
# ListApprovedOriginsRequestPaginateTypeDef definition
class ListApprovedOriginsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListAuthenticationProfilesRequestPaginateTypeDef#
# ListAuthenticationProfilesRequestPaginateTypeDef definition
class ListAuthenticationProfilesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListBotsRequestPaginateTypeDef#
# ListBotsRequestPaginateTypeDef definition
class ListBotsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
LexVersion: LexVersionType, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See LexVersionType
- See PaginatorConfigTypeDef
ListContactEvaluationsRequestPaginateTypeDef#
# ListContactEvaluationsRequestPaginateTypeDef definition
class ListContactEvaluationsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListContactFlowModulesRequestPaginateTypeDef#
# ListContactFlowModulesRequestPaginateTypeDef definition
class ListContactFlowModulesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleState: NotRequired[ContactFlowModuleStateType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListContactFlowVersionsRequestPaginateTypeDef#
# ListContactFlowVersionsRequestPaginateTypeDef definition
class ListContactFlowVersionsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListContactFlowsRequestPaginateTypeDef#
# ListContactFlowsRequestPaginateTypeDef definition
class ListContactFlowsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
ContactFlowTypes: NotRequired[Sequence[ContactFlowTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListContactReferencesRequestPaginateTypeDef#
# ListContactReferencesRequestPaginateTypeDef definition
class ListContactReferencesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ReferenceTypes: Sequence[ReferenceTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListDefaultVocabulariesRequestPaginateTypeDef#
# ListDefaultVocabulariesRequestPaginateTypeDef definition
class ListDefaultVocabulariesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
LanguageCode: NotRequired[VocabularyLanguageCodeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListEvaluationFormVersionsRequestPaginateTypeDef#
# ListEvaluationFormVersionsRequestPaginateTypeDef definition
class ListEvaluationFormVersionsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
EvaluationFormId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListEvaluationFormsRequestPaginateTypeDef#
# ListEvaluationFormsRequestPaginateTypeDef definition
class ListEvaluationFormsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListFlowAssociationsRequestPaginateTypeDef#
# ListFlowAssociationsRequestPaginateTypeDef definition
class ListFlowAssociationsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
ResourceType: NotRequired[ListFlowAssociationResourceTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListHoursOfOperationOverridesRequestPaginateTypeDef#
# ListHoursOfOperationOverridesRequestPaginateTypeDef definition
class ListHoursOfOperationOverridesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListHoursOfOperationsRequestPaginateTypeDef#
# ListHoursOfOperationsRequestPaginateTypeDef definition
class ListHoursOfOperationsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListInstanceAttributesRequestPaginateTypeDef#
# ListInstanceAttributesRequestPaginateTypeDef definition
class ListInstanceAttributesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListInstanceStorageConfigsRequestPaginateTypeDef#
# ListInstanceStorageConfigsRequestPaginateTypeDef definition
class ListInstanceStorageConfigsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListInstancesRequestPaginateTypeDef#
# ListInstancesRequestPaginateTypeDef definition
class ListInstancesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListIntegrationAssociationsRequestPaginateTypeDef#
# ListIntegrationAssociationsRequestPaginateTypeDef definition
class ListIntegrationAssociationsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
IntegrationType: NotRequired[IntegrationTypeType], # (1)
IntegrationArn: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListLambdaFunctionsRequestPaginateTypeDef#
# ListLambdaFunctionsRequestPaginateTypeDef definition
class ListLambdaFunctionsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListLexBotsRequestPaginateTypeDef#
# ListLexBotsRequestPaginateTypeDef definition
class ListLexBotsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPhoneNumbersRequestPaginateTypeDef#
# ListPhoneNumbersRequestPaginateTypeDef definition
class ListPhoneNumbersRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]], # (1)
PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)ListPhoneNumbersV2RequestPaginateTypeDef#
# ListPhoneNumbersV2RequestPaginateTypeDef definition
class ListPhoneNumbersV2RequestPaginateTypeDef(TypedDict):
TargetArn: NotRequired[str],
InstanceId: NotRequired[str],
PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]], # (1)
PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]], # (2)
PhoneNumberPrefix: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)ListPredefinedAttributesRequestPaginateTypeDef#
# ListPredefinedAttributesRequestPaginateTypeDef definition
class ListPredefinedAttributesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPromptsRequestPaginateTypeDef#
# ListPromptsRequestPaginateTypeDef definition
class ListPromptsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListQueueQuickConnectsRequestPaginateTypeDef#
# ListQueueQuickConnectsRequestPaginateTypeDef definition
class ListQueueQuickConnectsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListQueuesRequestPaginateTypeDef#
# ListQueuesRequestPaginateTypeDef definition
class ListQueuesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
QueueTypes: NotRequired[Sequence[QueueTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See QueueTypeType
- See PaginatorConfigTypeDef
ListQuickConnectsRequestPaginateTypeDef#
# ListQuickConnectsRequestPaginateTypeDef definition
class ListQuickConnectsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
QuickConnectTypes: NotRequired[Sequence[QuickConnectTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListRoutingProfileQueuesRequestPaginateTypeDef#
# ListRoutingProfileQueuesRequestPaginateTypeDef definition
class ListRoutingProfileQueuesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListRoutingProfilesRequestPaginateTypeDef#
# ListRoutingProfilesRequestPaginateTypeDef definition
class ListRoutingProfilesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListRulesRequestPaginateTypeDef#
# ListRulesRequestPaginateTypeDef definition
class ListRulesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PublishStatus: NotRequired[RulePublishStatusType], # (1)
EventSourceName: NotRequired[EventSourceNameType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)ListSecurityKeysRequestPaginateTypeDef#
# ListSecurityKeysRequestPaginateTypeDef definition
class ListSecurityKeysRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListSecurityProfileApplicationsRequestPaginateTypeDef#
# ListSecurityProfileApplicationsRequestPaginateTypeDef definition
class ListSecurityProfileApplicationsRequestPaginateTypeDef(TypedDict):
SecurityProfileId: str,
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListSecurityProfilePermissionsRequestPaginateTypeDef#
# ListSecurityProfilePermissionsRequestPaginateTypeDef definition
class ListSecurityProfilePermissionsRequestPaginateTypeDef(TypedDict):
SecurityProfileId: str,
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListSecurityProfilesRequestPaginateTypeDef#
# ListSecurityProfilesRequestPaginateTypeDef definition
class ListSecurityProfilesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListTaskTemplatesRequestPaginateTypeDef#
# ListTaskTemplatesRequestPaginateTypeDef definition
class ListTaskTemplatesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
Status: NotRequired[TaskTemplateStatusType], # (1)
Name: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListTrafficDistributionGroupUsersRequestPaginateTypeDef#
# ListTrafficDistributionGroupUsersRequestPaginateTypeDef definition
class ListTrafficDistributionGroupUsersRequestPaginateTypeDef(TypedDict):
TrafficDistributionGroupId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListTrafficDistributionGroupsRequestPaginateTypeDef#
# ListTrafficDistributionGroupsRequestPaginateTypeDef definition
class ListTrafficDistributionGroupsRequestPaginateTypeDef(TypedDict):
InstanceId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListUseCasesRequestPaginateTypeDef#
# ListUseCasesRequestPaginateTypeDef definition
class ListUseCasesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListUserHierarchyGroupsRequestPaginateTypeDef#
# ListUserHierarchyGroupsRequestPaginateTypeDef definition
class ListUserHierarchyGroupsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListUserProficienciesRequestPaginateTypeDef#
# ListUserProficienciesRequestPaginateTypeDef definition
class ListUserProficienciesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
UserId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListUsersRequestPaginateTypeDef#
# ListUsersRequestPaginateTypeDef definition
class ListUsersRequestPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListViewVersionsRequestPaginateTypeDef#
# ListViewVersionsRequestPaginateTypeDef definition
class ListViewVersionsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
ViewId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListViewsRequestPaginateTypeDef#
# ListViewsRequestPaginateTypeDef definition
class ListViewsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
Type: NotRequired[ViewTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See ViewTypeType
- See PaginatorConfigTypeDef
SearchAvailablePhoneNumbersRequestPaginateTypeDef#
# SearchAvailablePhoneNumbersRequestPaginateTypeDef definition
class SearchAvailablePhoneNumbersRequestPaginateTypeDef(TypedDict):
PhoneNumberCountryCode: PhoneNumberCountryCodeType, # (1)
PhoneNumberType: PhoneNumberTypeType, # (2)
TargetArn: NotRequired[str],
InstanceId: NotRequired[str],
PhoneNumberPrefix: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)SearchVocabulariesRequestPaginateTypeDef#
# SearchVocabulariesRequestPaginateTypeDef definition
class SearchVocabulariesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
State: NotRequired[VocabularyStateType], # (1)
NameStartsWith: NotRequired[str],
LanguageCode: NotRequired[VocabularyLanguageCodeType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)HierarchyPathReferenceTypeDef#
# HierarchyPathReferenceTypeDef definition
class HierarchyPathReferenceTypeDef(TypedDict):
LevelOne: NotRequired[HierarchyGroupSummaryReferenceTypeDef], # (1)
LevelTwo: NotRequired[HierarchyGroupSummaryReferenceTypeDef], # (1)
LevelThree: NotRequired[HierarchyGroupSummaryReferenceTypeDef], # (1)
LevelFour: NotRequired[HierarchyGroupSummaryReferenceTypeDef], # (1)
LevelFive: NotRequired[HierarchyGroupSummaryReferenceTypeDef], # (1)- See HierarchyGroupSummaryReferenceTypeDef
- See HierarchyGroupSummaryReferenceTypeDef
- See HierarchyGroupSummaryReferenceTypeDef
- See HierarchyGroupSummaryReferenceTypeDef
- See HierarchyGroupSummaryReferenceTypeDef
HierarchyPathTypeDef#
# HierarchyPathTypeDef definition
class HierarchyPathTypeDef(TypedDict):
LevelOne: NotRequired[HierarchyGroupSummaryTypeDef], # (1)
LevelTwo: NotRequired[HierarchyGroupSummaryTypeDef], # (1)
LevelThree: NotRequired[HierarchyGroupSummaryTypeDef], # (1)
LevelFour: NotRequired[HierarchyGroupSummaryTypeDef], # (1)
LevelFive: NotRequired[HierarchyGroupSummaryTypeDef], # (1)- See HierarchyGroupSummaryTypeDef
- See HierarchyGroupSummaryTypeDef
- See HierarchyGroupSummaryTypeDef
- See HierarchyGroupSummaryTypeDef
- See HierarchyGroupSummaryTypeDef
ListUserHierarchyGroupsResponseTypeDef#
# ListUserHierarchyGroupsResponseTypeDef definition
class ListUserHierarchyGroupsResponseTypeDef(TypedDict):
UserHierarchyGroupSummaryList: list[HierarchyGroupSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],HierarchyStructureTypeDef#
# HierarchyStructureTypeDef definition
class HierarchyStructureTypeDef(TypedDict):
LevelOne: NotRequired[HierarchyLevelTypeDef], # (1)
LevelTwo: NotRequired[HierarchyLevelTypeDef], # (1)
LevelThree: NotRequired[HierarchyLevelTypeDef], # (1)
LevelFour: NotRequired[HierarchyLevelTypeDef], # (1)
LevelFive: NotRequired[HierarchyLevelTypeDef], # (1)- See HierarchyLevelTypeDef
- See HierarchyLevelTypeDef
- See HierarchyLevelTypeDef
- See HierarchyLevelTypeDef
- See HierarchyLevelTypeDef
HierarchyStructureUpdateTypeDef#
# HierarchyStructureUpdateTypeDef definition
class HierarchyStructureUpdateTypeDef(TypedDict):
LevelOne: NotRequired[HierarchyLevelUpdateTypeDef], # (1)
LevelTwo: NotRequired[HierarchyLevelUpdateTypeDef], # (1)
LevelThree: NotRequired[HierarchyLevelUpdateTypeDef], # (1)
LevelFour: NotRequired[HierarchyLevelUpdateTypeDef], # (1)
LevelFive: NotRequired[HierarchyLevelUpdateTypeDef], # (1)- See HierarchyLevelUpdateTypeDef
- See HierarchyLevelUpdateTypeDef
- See HierarchyLevelUpdateTypeDef
- See HierarchyLevelUpdateTypeDef
- See HierarchyLevelUpdateTypeDef
HistoricalMetricTypeDef#
# HistoricalMetricTypeDef definition
class HistoricalMetricTypeDef(TypedDict):
Name: NotRequired[HistoricalMetricNameType], # (1)
Threshold: NotRequired[ThresholdTypeDef], # (2)
Statistic: NotRequired[StatisticType], # (3)
Unit: NotRequired[UnitType], # (4)- See HistoricalMetricNameType
- See ThresholdTypeDef
- See StatisticType
- See UnitType
HoursOfOperationConfigTypeDef#
# HoursOfOperationConfigTypeDef definition
class HoursOfOperationConfigTypeDef(TypedDict):
Day: HoursOfOperationDaysType, # (1)
StartTime: HoursOfOperationTimeSliceTypeDef, # (2)
EndTime: HoursOfOperationTimeSliceTypeDef, # (2)- See HoursOfOperationDaysType
- See HoursOfOperationTimeSliceTypeDef
- See HoursOfOperationTimeSliceTypeDef
HoursOfOperationOverrideConfigTypeDef#
# HoursOfOperationOverrideConfigTypeDef definition
class HoursOfOperationOverrideConfigTypeDef(TypedDict):
Day: NotRequired[OverrideDaysType], # (1)
StartTime: NotRequired[OverrideTimeSliceTypeDef], # (2)
EndTime: NotRequired[OverrideTimeSliceTypeDef], # (2)OperationalHourTypeDef#
# OperationalHourTypeDef definition
class OperationalHourTypeDef(TypedDict):
Start: NotRequired[OverrideTimeSliceTypeDef], # (1)
End: NotRequired[OverrideTimeSliceTypeDef], # (1)ListHoursOfOperationsResponseTypeDef#
# ListHoursOfOperationsResponseTypeDef definition
class ListHoursOfOperationsResponseTypeDef(TypedDict):
HoursOfOperationSummaryList: list[HoursOfOperationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],InboundEmailContentTypeDef#
# InboundEmailContentTypeDef definition
class InboundEmailContentTypeDef(TypedDict):
MessageSourceType: InboundMessageSourceTypeType, # (1)
RawMessage: NotRequired[InboundRawMessageTypeDef], # (2)InstanceTypeDef#
# InstanceTypeDef definition
class InstanceTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
IdentityManagementType: NotRequired[DirectoryTypeType], # (1)
InstanceAlias: NotRequired[str],
CreatedTime: NotRequired[datetime],
ServiceRole: NotRequired[str],
InstanceStatus: NotRequired[InstanceStatusType], # (2)
StatusReason: NotRequired[InstanceStatusReasonTypeDef], # (3)
InboundCallsEnabled: NotRequired[bool],
OutboundCallsEnabled: NotRequired[bool],
InstanceAccessUrl: NotRequired[str],
Tags: NotRequired[dict[str, str]],ListInstancesResponseTypeDef#
# ListInstancesResponseTypeDef definition
class ListInstancesResponseTypeDef(TypedDict):
InstanceSummaryList: list[InstanceSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListIntegrationAssociationsResponseTypeDef#
# ListIntegrationAssociationsResponseTypeDef definition
class ListIntegrationAssociationsResponseTypeDef(TypedDict):
IntegrationAssociationSummaryList: list[IntegrationAssociationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],InvisibleFieldInfoTypeDef#
# InvisibleFieldInfoTypeDef definition
class InvisibleFieldInfoTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)ReadOnlyFieldInfoTypeDef#
# ReadOnlyFieldInfoTypeDef definition
class ReadOnlyFieldInfoTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)RequiredFieldInfoTypeDef#
# RequiredFieldInfoTypeDef definition
class RequiredFieldInfoTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)TaskTemplateDefaultFieldValueTypeDef#
# TaskTemplateDefaultFieldValueTypeDef definition
class TaskTemplateDefaultFieldValueTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)
DefaultValue: NotRequired[str],TaskTemplateFieldOutputTypeDef#
# TaskTemplateFieldOutputTypeDef definition
class TaskTemplateFieldOutputTypeDef(TypedDict):
Id: TaskTemplateFieldIdentifierTypeDef, # (1)
Description: NotRequired[str],
Type: NotRequired[TaskTemplateFieldTypeType], # (2)
SingleSelectOptions: NotRequired[list[str]],TaskTemplateFieldTypeDef#
# TaskTemplateFieldTypeDef definition
class TaskTemplateFieldTypeDef(TypedDict):
Id: TaskTemplateFieldIdentifierTypeDef, # (1)
Description: NotRequired[str],
Type: NotRequired[TaskTemplateFieldTypeType], # (2)
SingleSelectOptions: NotRequired[Sequence[str]],ListPhoneNumbersResponseTypeDef#
# ListPhoneNumbersResponseTypeDef definition
class ListPhoneNumbersResponseTypeDef(TypedDict):
PhoneNumberSummaryList: list[PhoneNumberSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListPhoneNumbersV2ResponseTypeDef#
# ListPhoneNumbersV2ResponseTypeDef definition
class ListPhoneNumbersV2ResponseTypeDef(TypedDict):
ListPhoneNumbersSummaryList: list[ListPhoneNumbersSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListPredefinedAttributesResponseTypeDef#
# ListPredefinedAttributesResponseTypeDef definition
class ListPredefinedAttributesResponseTypeDef(TypedDict):
PredefinedAttributeSummaryList: list[PredefinedAttributeSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListPromptsResponseTypeDef#
# ListPromptsResponseTypeDef definition
class ListPromptsResponseTypeDef(TypedDict):
PromptSummaryList: list[PromptSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListQueueQuickConnectsResponseTypeDef#
# ListQueueQuickConnectsResponseTypeDef definition
class ListQueueQuickConnectsResponseTypeDef(TypedDict):
QuickConnectSummaryList: list[QuickConnectSummaryTypeDef], # (1)
LastModifiedTime: datetime,
LastModifiedRegion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListQuickConnectsResponseTypeDef#
# ListQuickConnectsResponseTypeDef definition
class ListQuickConnectsResponseTypeDef(TypedDict):
QuickConnectSummaryList: list[QuickConnectSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListQueuesResponseTypeDef#
# ListQueuesResponseTypeDef definition
class ListQueuesResponseTypeDef(TypedDict):
QueueSummaryList: list[QueueSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListRoutingProfileQueuesResponseTypeDef#
# ListRoutingProfileQueuesResponseTypeDef definition
class ListRoutingProfileQueuesResponseTypeDef(TypedDict):
RoutingProfileQueueConfigSummaryList: list[RoutingProfileQueueConfigSummaryTypeDef], # (1)
LastModifiedTime: datetime,
LastModifiedRegion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListRoutingProfilesResponseTypeDef#
# ListRoutingProfilesResponseTypeDef definition
class ListRoutingProfilesResponseTypeDef(TypedDict):
RoutingProfileSummaryList: list[RoutingProfileSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListSecurityKeysResponseTypeDef#
# ListSecurityKeysResponseTypeDef definition
class ListSecurityKeysResponseTypeDef(TypedDict):
SecurityKeys: list[SecurityKeyTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListSecurityProfilesResponseTypeDef#
# ListSecurityProfilesResponseTypeDef definition
class ListSecurityProfilesResponseTypeDef(TypedDict):
SecurityProfileSummaryList: list[SecurityProfileSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListTaskTemplatesResponseTypeDef#
# ListTaskTemplatesResponseTypeDef definition
class ListTaskTemplatesResponseTypeDef(TypedDict):
TaskTemplates: list[TaskTemplateMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListTrafficDistributionGroupUsersResponseTypeDef#
# ListTrafficDistributionGroupUsersResponseTypeDef definition
class ListTrafficDistributionGroupUsersResponseTypeDef(TypedDict):
TrafficDistributionGroupUserSummaryList: list[TrafficDistributionGroupUserSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListTrafficDistributionGroupsResponseTypeDef#
# ListTrafficDistributionGroupsResponseTypeDef definition
class ListTrafficDistributionGroupsResponseTypeDef(TypedDict):
TrafficDistributionGroupSummaryList: list[TrafficDistributionGroupSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListUseCasesResponseTypeDef#
# ListUseCasesResponseTypeDef definition
class ListUseCasesResponseTypeDef(TypedDict):
UseCaseSummaryList: list[UseCaseTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListUsersResponseTypeDef#
# ListUsersResponseTypeDef definition
class ListUsersResponseTypeDef(TypedDict):
UserSummaryList: list[UserSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListViewVersionsResponseTypeDef#
# ListViewVersionsResponseTypeDef definition
class ListViewVersionsResponseTypeDef(TypedDict):
ViewVersionSummaryList: list[ViewVersionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListViewsResponseTypeDef#
# ListViewsResponseTypeDef definition
class ListViewsResponseTypeDef(TypedDict):
ViewsSummaryList: list[ViewSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],MetricV2OutputTypeDef#
# MetricV2OutputTypeDef definition
class MetricV2OutputTypeDef(TypedDict):
Name: NotRequired[str],
Threshold: NotRequired[list[ThresholdV2TypeDef]], # (1)
MetricFilters: NotRequired[list[MetricFilterV2OutputTypeDef]], # (2)NewSessionDetailsTypeDef#
# NewSessionDetailsTypeDef definition
class NewSessionDetailsTypeDef(TypedDict):
SupportedMessagingContentTypes: NotRequired[Sequence[str]],
ParticipantDetails: NotRequired[ParticipantDetailsTypeDef], # (1)
Attributes: NotRequired[Mapping[str, str]],
StreamingConfiguration: NotRequired[ChatStreamingConfigurationTypeDef], # (2)SendNotificationActionDefinitionOutputTypeDef#
# SendNotificationActionDefinitionOutputTypeDef definition
class SendNotificationActionDefinitionOutputTypeDef(TypedDict):
DeliveryMethod: NotificationDeliveryTypeType, # (1)
Content: str,
ContentType: NotificationContentTypeType, # (2)
Recipient: NotificationRecipientTypeOutputTypeDef, # (3)
Subject: NotRequired[str],- See NotificationDeliveryTypeType
- See NotificationContentTypeType
- See NotificationRecipientTypeOutputTypeDef
ParticipantTimerConfigurationTypeDef#
# ParticipantTimerConfigurationTypeDef definition
class ParticipantTimerConfigurationTypeDef(TypedDict):
ParticipantRole: TimerEligibleParticipantRolesType, # (1)
TimerType: ParticipantTimerTypeType, # (2)
TimerValue: ParticipantTimerValueTypeDef, # (3)PredefinedAttributeTypeDef#
# PredefinedAttributeTypeDef definition
class PredefinedAttributeTypeDef(TypedDict):
Name: NotRequired[str],
Values: NotRequired[PredefinedAttributeValuesOutputTypeDef], # (1)
LastModifiedTime: NotRequired[datetime],
LastModifiedRegion: NotRequired[str],QuickConnectConfigTypeDef#
# QuickConnectConfigTypeDef definition
class QuickConnectConfigTypeDef(TypedDict):
QuickConnectType: QuickConnectTypeType, # (1)
UserConfig: NotRequired[UserQuickConnectConfigTypeDef], # (2)
QueueConfig: NotRequired[QueueQuickConnectConfigTypeDef], # (3)
PhoneConfig: NotRequired[PhoneNumberQuickConnectConfigTypeDef], # (4)- See QuickConnectTypeType
- See UserQuickConnectConfigTypeDef
- See QueueQuickConnectConfigTypeDef
- See PhoneNumberQuickConnectConfigTypeDef
RealTimeContactAnalysisTranscriptItemRedactionTypeDef#
# RealTimeContactAnalysisTranscriptItemRedactionTypeDef definition
class RealTimeContactAnalysisTranscriptItemRedactionTypeDef(TypedDict):
CharacterOffsets: NotRequired[list[RealTimeContactAnalysisCharacterIntervalTypeDef]], # (1)RealTimeContactAnalysisTranscriptItemWithCharacterOffsetsTypeDef#
# RealTimeContactAnalysisTranscriptItemWithCharacterOffsetsTypeDef definition
class RealTimeContactAnalysisTranscriptItemWithCharacterOffsetsTypeDef(TypedDict):
Id: str,
CharacterOffsets: NotRequired[RealTimeContactAnalysisCharacterIntervalTypeDef], # (1)RealTimeContactAnalysisTranscriptItemWithContentTypeDef#
# RealTimeContactAnalysisTranscriptItemWithContentTypeDef definition
class RealTimeContactAnalysisTranscriptItemWithContentTypeDef(TypedDict):
Id: str,
Content: NotRequired[str],
CharacterOffsets: NotRequired[RealTimeContactAnalysisCharacterIntervalTypeDef], # (1)RealTimeContactAnalysisSegmentAttachmentsTypeDef#
# RealTimeContactAnalysisSegmentAttachmentsTypeDef definition
class RealTimeContactAnalysisSegmentAttachmentsTypeDef(TypedDict):
Id: str,
ParticipantId: str,
ParticipantRole: ParticipantRoleType, # (1)
Attachments: list[RealTimeContactAnalysisAttachmentTypeDef], # (2)
Time: RealTimeContactAnalysisTimeDataTypeDef, # (3)
DisplayName: NotRequired[str],- See ParticipantRoleType
- See RealTimeContactAnalysisAttachmentTypeDef
- 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],ReferenceSummaryTypeDef#
# ReferenceSummaryTypeDef definition
class ReferenceSummaryTypeDef(TypedDict):
Url: NotRequired[UrlReferenceTypeDef], # (1)
Attachment: NotRequired[AttachmentReferenceTypeDef], # (2)
EmailMessage: NotRequired[EmailMessageReferenceTypeDef], # (3)
String: NotRequired[StringReferenceTypeDef], # (4)
Number: NotRequired[NumberReferenceTypeDef], # (5)
Date: NotRequired[DateReferenceTypeDef], # (6)
Email: NotRequired[EmailReferenceTypeDef], # (7)- See UrlReferenceTypeDef
- See AttachmentReferenceTypeDef
- See EmailMessageReferenceTypeDef
- See StringReferenceTypeDef
- See NumberReferenceTypeDef
- See DateReferenceTypeDef
- See EmailReferenceTypeDef
ReplicationConfigurationTypeDef#
# ReplicationConfigurationTypeDef definition
class ReplicationConfigurationTypeDef(TypedDict):
ReplicationStatusSummaryList: NotRequired[list[ReplicationStatusSummaryTypeDef]], # (1)
SourceRegion: NotRequired[str],
GlobalSignInEndpoint: NotRequired[str],ResourceTagsSearchCriteriaTypeDef#
# ResourceTagsSearchCriteriaTypeDef definition
class ResourceTagsSearchCriteriaTypeDef(TypedDict):
TagSearchCondition: NotRequired[TagSearchConditionTypeDef], # (1)SearchResourceTagsResponseTypeDef#
# SearchResourceTagsResponseTypeDef definition
class SearchResourceTagsResponseTypeDef(TypedDict):
Tags: list[TagSetTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See TagSetTypeDef
- See ResponseMetadataTypeDef
SearchSecurityProfilesResponseTypeDef#
# SearchSecurityProfilesResponseTypeDef definition
class SearchSecurityProfilesResponseTypeDef(TypedDict):
SecurityProfiles: list[SecurityProfileSearchSummaryTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],SearchVocabulariesResponseTypeDef#
# SearchVocabulariesResponseTypeDef definition
class SearchVocabulariesResponseTypeDef(TypedDict):
VocabularySummaryList: list[VocabularySummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],SearchableContactAttributesTypeDef#
# SearchableContactAttributesTypeDef definition
class SearchableContactAttributesTypeDef(TypedDict):
Criteria: Sequence[SearchableContactAttributesCriteriaTypeDef], # (1)
MatchType: NotRequired[SearchContactsMatchTypeType], # (2)SearchableSegmentAttributesTypeDef#
# SearchableSegmentAttributesTypeDef definition
class SearchableSegmentAttributesTypeDef(TypedDict):
Criteria: Sequence[SearchableSegmentAttributesCriteriaTypeDef], # (1)
MatchType: NotRequired[SearchContactsMatchTypeType], # (2)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)
CustomerId: NotRequired[str],- See ParticipantDetailsTypeDef
- See ChatMessageTypeDef
- See PersistentChatTypeDef
- See SegmentAttributeValueTypeDef
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],- See EndpointTypeDef
- See EndpointTypeDef
- See SegmentAttributeValueTypeDef
- See ParticipantDetailsTypeDef
- See ChatMessageTypeDef
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],
SegmentAttributes: NotRequired[Mapping[str, SegmentAttributeValueTypeDef]], # (2)UpdateContactRequestRequestTypeDef#
# UpdateContactRequestRequestTypeDef definition
class UpdateContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
Name: NotRequired[str],
Description: NotRequired[str],
References: NotRequired[Mapping[str, ReferenceTypeDef]], # (1)
SegmentAttributes: NotRequired[Mapping[str, SegmentAttributeValueTypeDef]], # (2)
QueueInfo: NotRequired[QueueInfoInputTypeDef], # (3)
UserInfo: NotRequired[UserInfoTypeDef], # (4)
CustomerEndpoint: NotRequired[EndpointTypeDef], # (5)
SystemEndpoint: NotRequired[EndpointTypeDef], # (5)- See ReferenceTypeDef
- See SegmentAttributeValueTypeDef
- See QueueInfoInputTypeDef
- See UserInfoTypeDef
- See EndpointTypeDef
- See EndpointTypeDef
SignInConfigOutputTypeDef#
# SignInConfigOutputTypeDef definition
class SignInConfigOutputTypeDef(TypedDict):
Distributions: list[SignInDistributionTypeDef], # (1)SignInConfigTypeDef#
# SignInConfigTypeDef definition
class SignInConfigTypeDef(TypedDict):
Distributions: Sequence[SignInDistributionTypeDef], # (1)StartAttachedFileUploadResponseTypeDef#
# StartAttachedFileUploadResponseTypeDef definition
class StartAttachedFileUploadResponseTypeDef(TypedDict):
FileArn: str,
FileId: str,
CreationTime: str,
FileStatus: FileStatusTypeType, # (1)
CreatedBy: CreatedByInfoTypeDef, # (2)
UploadUrlMetadata: UploadUrlMetadataTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See FileStatusTypeType
- See CreatedByInfoTypeDef
- See UploadUrlMetadataTypeDef
- See ResponseMetadataTypeDef
StartContactRecordingRequestRequestTypeDef#
# StartContactRecordingRequestRequestTypeDef definition
class StartContactRecordingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
InitialContactId: str,
VoiceRecordingConfiguration: VoiceRecordingConfigurationTypeDef, # (1)TemplatedMessageConfigTypeDef#
# TemplatedMessageConfigTypeDef definition
class TemplatedMessageConfigTypeDef(TypedDict):
KnowledgeBaseId: str,
MessageTemplateId: str,
TemplateAttributes: TemplateAttributesTypeDef, # (1)TranscriptTypeDef#
# TranscriptTypeDef definition
class TranscriptTypeDef(TypedDict):
Criteria: Sequence[TranscriptCriteriaTypeDef], # (1)
MatchType: NotRequired[SearchContactsMatchTypeType], # (2)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],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],- See ViewStatusType
- See ViewTypeType
- See ViewContentTypeDef
ListRulesResponseTypeDef#
# ListRulesResponseTypeDef definition
class ListRulesResponseTypeDef(TypedDict):
RuleSummaryList: list[RuleSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],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)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],QualityMetricsTypeDef#
# QualityMetricsTypeDef definition
class QualityMetricsTypeDef(TypedDict):
Agent: NotRequired[AgentQualityMetricsTypeDef], # (1)
Customer: NotRequired[CustomerQualityMetricsTypeDef], # (2)SearchPredefinedAttributesRequestPaginateTypeDef#
# SearchPredefinedAttributesRequestPaginateTypeDef definition
class SearchPredefinedAttributesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchCriteria: NotRequired[PredefinedAttributeSearchCriteriaPaginatorTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)SearchPredefinedAttributesRequestRequestTypeDef#
# SearchPredefinedAttributesRequestRequestTypeDef definition
class SearchPredefinedAttributesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchCriteria: NotRequired[PredefinedAttributeSearchCriteriaTypeDef], # (1)AttributeConditionOutputTypeDef#
# AttributeConditionOutputTypeDef definition
class AttributeConditionOutputTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],
ProficiencyLevel: NotRequired[float],
Range: NotRequired[RangeTypeDef], # (1)
MatchCriteria: NotRequired[MatchCriteriaOutputTypeDef], # (2)
ComparisonOperator: NotRequired[str],MatchCriteriaTypeDef#
# MatchCriteriaTypeDef definition
class MatchCriteriaTypeDef(TypedDict):
AgentsCriteria: NotRequired[AgentsCriteriaUnionTypeDef], # (1)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],ListBotsResponseTypeDef#
# ListBotsResponseTypeDef definition
class ListBotsResponseTypeDef(TypedDict):
LexBots: list[LexBotConfigTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],BatchGetAttachedFileMetadataResponseTypeDef#
# BatchGetAttachedFileMetadataResponseTypeDef definition
class BatchGetAttachedFileMetadataResponseTypeDef(TypedDict):
Files: list[AttachedFileTypeDef], # (1)
Errors: list[AttachedFileErrorTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)ControlPlaneUserAttributeFilterTypeDef#
# ControlPlaneUserAttributeFilterTypeDef definition
class ControlPlaneUserAttributeFilterTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[AttributeAndConditionTypeDef]], # (1)
AndCondition: NotRequired[AttributeAndConditionTypeDef], # (2)
TagCondition: NotRequired[TagConditionTypeDef], # (3)
HierarchyGroupCondition: NotRequired[HierarchyGroupConditionTypeDef], # (4)- See AttributeAndConditionTypeDef
- See AttributeAndConditionTypeDef
- See TagConditionTypeDef
- See HierarchyGroupConditionTypeDef
ControlPlaneAttributeFilterTypeDef#
# ControlPlaneAttributeFilterTypeDef definition
class ControlPlaneAttributeFilterTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[CommonAttributeAndConditionTypeDef]], # (1)
AndCondition: NotRequired[CommonAttributeAndConditionTypeDef], # (2)
TagCondition: NotRequired[TagConditionTypeDef], # (3)- See CommonAttributeAndConditionTypeDef
- See CommonAttributeAndConditionTypeDef
- See TagConditionTypeDef
ContactFlowModuleSearchFilterTypeDef#
# ContactFlowModuleSearchFilterTypeDef definition
class ContactFlowModuleSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)ContactFlowSearchFilterTypeDef#
# ContactFlowSearchFilterTypeDef definition
class ContactFlowSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)EmailAddressSearchFilterTypeDef#
# EmailAddressSearchFilterTypeDef definition
class EmailAddressSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)HoursOfOperationSearchFilterTypeDef#
# HoursOfOperationSearchFilterTypeDef definition
class HoursOfOperationSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)PromptSearchFilterTypeDef#
# PromptSearchFilterTypeDef definition
class PromptSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)QueueSearchFilterTypeDef#
# QueueSearchFilterTypeDef definition
class QueueSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)QuickConnectSearchFilterTypeDef#
# QuickConnectSearchFilterTypeDef definition
class QuickConnectSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)RoutingProfileSearchFilterTypeDef#
# RoutingProfileSearchFilterTypeDef definition
class RoutingProfileSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)SecurityProfilesSearchFilterTypeDef#
# SecurityProfilesSearchFilterTypeDef definition
class SecurityProfilesSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)MeetingTypeDef#
# MeetingTypeDef definition
class MeetingTypeDef(TypedDict):
MediaRegion: NotRequired[str],
MediaPlacement: NotRequired[MediaPlacementTypeDef], # (1)
MeetingFeatures: NotRequired[MeetingFeaturesConfigurationTypeDef], # (2)
MeetingId: NotRequired[str],DescribePhoneNumberResponseTypeDef#
# DescribePhoneNumberResponseTypeDef definition
class DescribePhoneNumberResponseTypeDef(TypedDict):
ClaimedPhoneNumberSummary: ClaimedPhoneNumberSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListConditionTypeDef#
# ListConditionTypeDef definition
class ListConditionTypeDef(TypedDict):
TargetListType: NotRequired[TargetListTypeType], # (1)
Conditions: NotRequired[Sequence[ConditionTypeDef]], # (2)- See TargetListTypeType
- See ConditionTypeDef
BatchPutContactRequestRequestTypeDef#
# BatchPutContactRequestRequestTypeDef definition
class BatchPutContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactDataRequestList: Sequence[ContactDataRequestTypeDef], # (1)
ClientToken: NotRequired[str],GetCurrentUserDataRequestRequestTypeDef#
# GetCurrentUserDataRequestRequestTypeDef definition
class GetCurrentUserDataRequestRequestTypeDef(TypedDict):
InstanceId: str,
Filters: UserDataFiltersTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],SearchContactsResponseTypeDef#
# SearchContactsResponseTypeDef definition
class SearchContactsResponseTypeDef(TypedDict):
Contacts: list[ContactSearchSummaryTypeDef], # (1)
TotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeQueueResponseTypeDef#
# DescribeQueueResponseTypeDef definition
class DescribeQueueResponseTypeDef(TypedDict):
Queue: QueueTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See QueueTypeDef
- See ResponseMetadataTypeDef
SearchQueuesResponseTypeDef#
# SearchQueuesResponseTypeDef definition
class SearchQueuesResponseTypeDef(TypedDict):
Queues: list[QueueTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See QueueTypeDef
- See ResponseMetadataTypeDef
DescribeUserResponseTypeDef#
# DescribeUserResponseTypeDef definition
class DescribeUserResponseTypeDef(TypedDict):
User: UserTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See UserTypeDef
- See ResponseMetadataTypeDef
RoutingProfileTypeDef#
# RoutingProfileTypeDef definition
class RoutingProfileTypeDef(TypedDict):
InstanceId: NotRequired[str],
Name: NotRequired[str],
RoutingProfileArn: NotRequired[str],
RoutingProfileId: NotRequired[str],
Description: NotRequired[str],
MediaConcurrencies: NotRequired[list[MediaConcurrencyTypeDef]], # (1)
DefaultOutboundQueueId: NotRequired[str],
Tags: NotRequired[dict[str, str]],
NumberOfAssociatedQueues: NotRequired[int],
NumberOfAssociatedUsers: NotRequired[int],
AgentAvailabilityTimer: NotRequired[AgentAvailabilityTimerType], # (2)
LastModifiedTime: NotRequired[datetime],
LastModifiedRegion: NotRequired[str],
IsDefault: NotRequired[bool],
AssociatedQueueIds: NotRequired[list[str]],UpdateRoutingProfileConcurrencyRequestRequestTypeDef#
# UpdateRoutingProfileConcurrencyRequestRequestTypeDef definition
class UpdateRoutingProfileConcurrencyRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
MediaConcurrencies: Sequence[MediaConcurrencyTypeDef], # (1)CurrentMetricResultTypeDef#
# CurrentMetricResultTypeDef definition
class CurrentMetricResultTypeDef(TypedDict):
Dimensions: NotRequired[DimensionsTypeDef], # (1)
Collections: NotRequired[list[CurrentMetricDataTypeDef]], # (2)AssociateRoutingProfileQueuesRequestRequestTypeDef#
# AssociateRoutingProfileQueuesRequestRequestTypeDef definition
class AssociateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef], # (1)CreateRoutingProfileRequestRequestTypeDef#
# CreateRoutingProfileRequestRequestTypeDef definition
class CreateRoutingProfileRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
Description: str,
DefaultOutboundQueueId: str,
MediaConcurrencies: Sequence[MediaConcurrencyTypeDef], # (1)
QueueConfigs: NotRequired[Sequence[RoutingProfileQueueConfigTypeDef]], # (2)
Tags: NotRequired[Mapping[str, str]],
AgentAvailabilityTimer: NotRequired[AgentAvailabilityTimerType], # (3)UpdateRoutingProfileQueuesRequestRequestTypeDef#
# UpdateRoutingProfileQueuesRequestRequestTypeDef definition
class UpdateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef], # (1)InstanceStorageConfigTypeDef#
# InstanceStorageConfigTypeDef definition
class InstanceStorageConfigTypeDef(TypedDict):
StorageType: StorageTypeType, # (1)
AssociationId: NotRequired[str],
S3Config: NotRequired[S3ConfigTypeDef], # (2)
KinesisVideoStreamConfig: NotRequired[KinesisVideoStreamConfigTypeDef], # (3)
KinesisStreamConfig: NotRequired[KinesisStreamConfigTypeDef], # (4)
KinesisFirehoseConfig: NotRequired[KinesisFirehoseConfigTypeDef], # (5)- See StorageTypeType
- See S3ConfigTypeDef
- See KinesisVideoStreamConfigTypeDef
- See KinesisStreamConfigTypeDef
- See KinesisFirehoseConfigTypeDef
SubmitContactEvaluationRequestRequestTypeDef#
# SubmitContactEvaluationRequestRequestTypeDef definition
class SubmitContactEvaluationRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationId: str,
Answers: NotRequired[Mapping[str, EvaluationAnswerInputTypeDef]], # (1)
Notes: NotRequired[Mapping[str, EvaluationNoteTypeDef]], # (2)UpdateContactEvaluationRequestRequestTypeDef#
# UpdateContactEvaluationRequestRequestTypeDef definition
class UpdateContactEvaluationRequestRequestTypeDef(TypedDict):
InstanceId: str,
EvaluationId: str,
Answers: NotRequired[Mapping[str, EvaluationAnswerInputTypeDef]], # (1)
Notes: NotRequired[Mapping[str, EvaluationNoteTypeDef]], # (2)EvaluationFormNumericQuestionPropertiesOutputTypeDef#
# EvaluationFormNumericQuestionPropertiesOutputTypeDef definition
class EvaluationFormNumericQuestionPropertiesOutputTypeDef(TypedDict):
MinValue: int,
MaxValue: int,
Options: NotRequired[list[EvaluationFormNumericQuestionOptionTypeDef]], # (1)
Automation: NotRequired[EvaluationFormNumericQuestionAutomationTypeDef], # (2)EvaluationFormNumericQuestionPropertiesTypeDef#
# EvaluationFormNumericQuestionPropertiesTypeDef definition
class EvaluationFormNumericQuestionPropertiesTypeDef(TypedDict):
MinValue: int,
MaxValue: int,
Options: NotRequired[Sequence[EvaluationFormNumericQuestionOptionTypeDef]], # (1)
Automation: NotRequired[EvaluationFormNumericQuestionAutomationTypeDef], # (2)EvaluationFormSingleSelectQuestionAutomationOutputTypeDef#
# EvaluationFormSingleSelectQuestionAutomationOutputTypeDef definition
class EvaluationFormSingleSelectQuestionAutomationOutputTypeDef(TypedDict):
Options: list[EvaluationFormSingleSelectQuestionAutomationOptionTypeDef], # (1)
DefaultOptionRefId: NotRequired[str],EvaluationFormSingleSelectQuestionAutomationTypeDef#
# EvaluationFormSingleSelectQuestionAutomationTypeDef definition
class EvaluationFormSingleSelectQuestionAutomationTypeDef(TypedDict):
Options: Sequence[EvaluationFormSingleSelectQuestionAutomationOptionTypeDef], # (1)
DefaultOptionRefId: NotRequired[str],EvaluationTypeDef#
# EvaluationTypeDef definition
class EvaluationTypeDef(TypedDict):
EvaluationId: str,
EvaluationArn: str,
Metadata: EvaluationMetadataTypeDef, # (1)
Answers: dict[str, EvaluationAnswerOutputTypeDef], # (2)
Notes: dict[str, EvaluationNoteTypeDef], # (3)
Status: EvaluationStatusType, # (4)
CreatedTime: datetime,
LastModifiedTime: datetime,
Scores: NotRequired[dict[str, EvaluationScoreTypeDef]], # (5)
Tags: NotRequired[dict[str, str]],- See EvaluationMetadataTypeDef
- See EvaluationAnswerOutputTypeDef
- See EvaluationNoteTypeDef
- See EvaluationStatusType
- See EvaluationScoreTypeDef
ListContactEvaluationsResponseTypeDef#
# ListContactEvaluationsResponseTypeDef definition
class ListContactEvaluationsResponseTypeDef(TypedDict):
EvaluationSummaryList: list[EvaluationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],CreateCaseActionDefinitionOutputTypeDef#
# CreateCaseActionDefinitionOutputTypeDef definition
class CreateCaseActionDefinitionOutputTypeDef(TypedDict):
Fields: list[FieldValueOutputTypeDef], # (1)
TemplateId: str,UpdateCaseActionDefinitionOutputTypeDef#
# UpdateCaseActionDefinitionOutputTypeDef definition
class UpdateCaseActionDefinitionOutputTypeDef(TypedDict):
Fields: list[FieldValueOutputTypeDef], # (1)FieldValueTypeDef#
# FieldValueTypeDef definition
class FieldValueTypeDef(TypedDict):
Id: str,
Value: FieldValueUnionUnionTypeDef, # (1)UserDataTypeDef#
# UserDataTypeDef definition
class UserDataTypeDef(TypedDict):
User: NotRequired[UserReferenceTypeDef], # (1)
RoutingProfile: NotRequired[RoutingProfileReferenceTypeDef], # (2)
HierarchyPath: NotRequired[HierarchyPathReferenceTypeDef], # (3)
Status: NotRequired[AgentStatusReferenceTypeDef], # (4)
AvailableSlotsByChannel: NotRequired[dict[ChannelType, int]], # (5)
MaxSlotsByChannel: NotRequired[dict[ChannelType, int]], # (5)
ActiveSlotsByChannel: NotRequired[dict[ChannelType, int]], # (5)
Contacts: NotRequired[list[AgentContactReferenceTypeDef]], # (8)
NextStatus: NotRequired[str],- See UserReferenceTypeDef
- See RoutingProfileReferenceTypeDef
- See HierarchyPathReferenceTypeDef
- See AgentStatusReferenceTypeDef
- See ChannelType
- See ChannelType
- See ChannelType
- See AgentContactReferenceTypeDef
HierarchyGroupTypeDef#
# HierarchyGroupTypeDef definition
class HierarchyGroupTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
LevelId: NotRequired[str],
HierarchyPath: NotRequired[HierarchyPathTypeDef], # (1)
Tags: NotRequired[dict[str, str]],
LastModifiedTime: NotRequired[datetime],
LastModifiedRegion: NotRequired[str],DescribeUserHierarchyStructureResponseTypeDef#
# DescribeUserHierarchyStructureResponseTypeDef definition
class DescribeUserHierarchyStructureResponseTypeDef(TypedDict):
HierarchyStructure: HierarchyStructureTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateUserHierarchyStructureRequestRequestTypeDef#
# UpdateUserHierarchyStructureRequestRequestTypeDef definition
class UpdateUserHierarchyStructureRequestRequestTypeDef(TypedDict):
HierarchyStructure: HierarchyStructureUpdateTypeDef, # (1)
InstanceId: str,GetMetricDataRequestPaginateTypeDef#
# GetMetricDataRequestPaginateTypeDef definition
class GetMetricDataRequestPaginateTypeDef(TypedDict):
InstanceId: str,
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
Filters: FiltersTypeDef, # (1)
HistoricalMetrics: Sequence[HistoricalMetricTypeDef], # (2)
Groupings: NotRequired[Sequence[GroupingType]], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)- See FiltersTypeDef
- See HistoricalMetricTypeDef
- See GroupingType
- See PaginatorConfigTypeDef
GetMetricDataRequestRequestTypeDef#
# GetMetricDataRequestRequestTypeDef definition
class GetMetricDataRequestRequestTypeDef(TypedDict):
InstanceId: str,
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
Filters: FiltersTypeDef, # (1)
HistoricalMetrics: Sequence[HistoricalMetricTypeDef], # (2)
Groupings: NotRequired[Sequence[GroupingType]], # (3)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],- See FiltersTypeDef
- See HistoricalMetricTypeDef
- See GroupingType
HistoricalMetricDataTypeDef#
# HistoricalMetricDataTypeDef definition
class HistoricalMetricDataTypeDef(TypedDict):
Metric: NotRequired[HistoricalMetricTypeDef], # (1)
Value: NotRequired[float],CreateHoursOfOperationRequestRequestTypeDef#
# CreateHoursOfOperationRequestRequestTypeDef definition
class CreateHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
TimeZone: str,
Config: Sequence[HoursOfOperationConfigTypeDef], # (1)
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],HoursOfOperationTypeDef#
# HoursOfOperationTypeDef definition
class HoursOfOperationTypeDef(TypedDict):
HoursOfOperationId: NotRequired[str],
HoursOfOperationArn: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
TimeZone: NotRequired[str],
Config: NotRequired[list[HoursOfOperationConfigTypeDef]], # (1)
Tags: NotRequired[dict[str, str]],
LastModifiedTime: NotRequired[datetime],
LastModifiedRegion: NotRequired[str],UpdateHoursOfOperationRequestRequestTypeDef#
# UpdateHoursOfOperationRequestRequestTypeDef definition
class UpdateHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
Name: NotRequired[str],
Description: NotRequired[str],
TimeZone: NotRequired[str],
Config: NotRequired[Sequence[HoursOfOperationConfigTypeDef]], # (1)CreateHoursOfOperationOverrideRequestRequestTypeDef#
# CreateHoursOfOperationOverrideRequestRequestTypeDef definition
class CreateHoursOfOperationOverrideRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
Name: str,
Config: Sequence[HoursOfOperationOverrideConfigTypeDef], # (1)
EffectiveFrom: str,
EffectiveTill: str,
Description: NotRequired[str],HoursOfOperationOverrideTypeDef#
# HoursOfOperationOverrideTypeDef definition
class HoursOfOperationOverrideTypeDef(TypedDict):
HoursOfOperationOverrideId: NotRequired[str],
HoursOfOperationId: NotRequired[str],
HoursOfOperationArn: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
Config: NotRequired[list[HoursOfOperationOverrideConfigTypeDef]], # (1)
EffectiveFrom: NotRequired[str],
EffectiveTill: NotRequired[str],UpdateHoursOfOperationOverrideRequestRequestTypeDef#
# UpdateHoursOfOperationOverrideRequestRequestTypeDef definition
class UpdateHoursOfOperationOverrideRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
HoursOfOperationOverrideId: str,
Name: NotRequired[str],
Description: NotRequired[str],
Config: NotRequired[Sequence[HoursOfOperationOverrideConfigTypeDef]], # (1)
EffectiveFrom: NotRequired[str],
EffectiveTill: NotRequired[str],EffectiveHoursOfOperationsTypeDef#
# EffectiveHoursOfOperationsTypeDef definition
class EffectiveHoursOfOperationsTypeDef(TypedDict):
Date: NotRequired[str],
OperationalHours: NotRequired[list[OperationalHourTypeDef]], # (1)StartEmailContactRequestRequestTypeDef#
# StartEmailContactRequestRequestTypeDef definition
class StartEmailContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
FromEmailAddress: EmailAddressInfoTypeDef, # (1)
DestinationEmailAddress: str,
EmailMessage: InboundEmailContentTypeDef, # (2)
Description: NotRequired[str],
References: NotRequired[Mapping[str, ReferenceTypeDef]], # (3)
Name: NotRequired[str],
AdditionalRecipients: NotRequired[InboundAdditionalRecipientsTypeDef], # (4)
Attachments: NotRequired[Sequence[EmailAttachmentTypeDef]], # (5)
ContactFlowId: NotRequired[str],
RelatedContactId: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
SegmentAttributes: NotRequired[Mapping[str, SegmentAttributeValueTypeDef]], # (6)
ClientToken: NotRequired[str],- See EmailAddressInfoTypeDef
- See InboundEmailContentTypeDef
- See ReferenceTypeDef
- See InboundAdditionalRecipientsTypeDef
- See EmailAttachmentTypeDef
- See SegmentAttributeValueTypeDef
TaskTemplateConstraintsOutputTypeDef#
# TaskTemplateConstraintsOutputTypeDef definition
class TaskTemplateConstraintsOutputTypeDef(TypedDict):
RequiredFields: NotRequired[list[RequiredFieldInfoTypeDef]], # (1)
ReadOnlyFields: NotRequired[list[ReadOnlyFieldInfoTypeDef]], # (2)
InvisibleFields: NotRequired[list[InvisibleFieldInfoTypeDef]], # (3)TaskTemplateConstraintsTypeDef#
# TaskTemplateConstraintsTypeDef definition
class TaskTemplateConstraintsTypeDef(TypedDict):
RequiredFields: NotRequired[Sequence[RequiredFieldInfoTypeDef]], # (1)
ReadOnlyFields: NotRequired[Sequence[ReadOnlyFieldInfoTypeDef]], # (2)
InvisibleFields: NotRequired[Sequence[InvisibleFieldInfoTypeDef]], # (3)TaskTemplateDefaultsOutputTypeDef#
# TaskTemplateDefaultsOutputTypeDef definition
class TaskTemplateDefaultsOutputTypeDef(TypedDict):
DefaultFieldValues: NotRequired[list[TaskTemplateDefaultFieldValueTypeDef]], # (1)TaskTemplateDefaultsTypeDef#
# TaskTemplateDefaultsTypeDef definition
class TaskTemplateDefaultsTypeDef(TypedDict):
DefaultFieldValues: NotRequired[Sequence[TaskTemplateDefaultFieldValueTypeDef]], # (1)MetricV2TypeDef#
# MetricV2TypeDef definition
class MetricV2TypeDef(TypedDict):
Name: NotRequired[str],
Threshold: NotRequired[Sequence[ThresholdV2TypeDef]], # (1)
MetricFilters: NotRequired[Sequence[MetricFilterV2UnionTypeDef]], # (2)MetricDataV2TypeDef#
# MetricDataV2TypeDef definition
class MetricDataV2TypeDef(TypedDict):
Metric: NotRequired[MetricV2OutputTypeDef], # (1)
Value: NotRequired[float],SendChatIntegrationEventRequestRequestTypeDef#
# SendChatIntegrationEventRequestRequestTypeDef definition
class SendChatIntegrationEventRequestRequestTypeDef(TypedDict):
SourceId: str,
DestinationId: str,
Event: ChatEventTypeDef, # (1)
Subtype: NotRequired[str],
NewSessionDetails: NotRequired[NewSessionDetailsTypeDef], # (2)SendNotificationActionDefinitionTypeDef#
# SendNotificationActionDefinitionTypeDef definition
class SendNotificationActionDefinitionTypeDef(TypedDict):
DeliveryMethod: NotificationDeliveryTypeType, # (1)
Content: str,
ContentType: NotificationContentTypeType, # (2)
Recipient: NotificationRecipientTypeUnionTypeDef, # (3)
Subject: NotRequired[str],- See NotificationDeliveryTypeType
- See NotificationContentTypeType
- See NotificationRecipientTypeTypeDef NotificationRecipientTypeOutputTypeDef
ChatParticipantRoleConfigTypeDef#
# ChatParticipantRoleConfigTypeDef definition
class ChatParticipantRoleConfigTypeDef(TypedDict):
ParticipantTimerConfigList: Sequence[ParticipantTimerConfigurationTypeDef], # (1)DescribePredefinedAttributeResponseTypeDef#
# DescribePredefinedAttributeResponseTypeDef definition
class DescribePredefinedAttributeResponseTypeDef(TypedDict):
PredefinedAttribute: PredefinedAttributeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchPredefinedAttributesResponseTypeDef#
# SearchPredefinedAttributesResponseTypeDef definition
class SearchPredefinedAttributesResponseTypeDef(TypedDict):
PredefinedAttributes: list[PredefinedAttributeTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],CreateQuickConnectRequestRequestTypeDef#
# CreateQuickConnectRequestRequestTypeDef definition
class CreateQuickConnectRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
QuickConnectConfig: QuickConnectConfigTypeDef, # (1)
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],QuickConnectTypeDef#
# QuickConnectTypeDef definition
class QuickConnectTypeDef(TypedDict):
QuickConnectARN: NotRequired[str],
QuickConnectId: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
QuickConnectConfig: NotRequired[QuickConnectConfigTypeDef], # (1)
Tags: NotRequired[dict[str, str]],
LastModifiedTime: NotRequired[datetime],
LastModifiedRegion: NotRequired[str],UpdateQuickConnectConfigRequestRequestTypeDef#
# UpdateQuickConnectConfigRequestRequestTypeDef definition
class UpdateQuickConnectConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
QuickConnectId: str,
QuickConnectConfig: QuickConnectConfigTypeDef, # (1)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)- See ParticipantRoleType
- See RealTimeContactAnalysisTimeDataTypeDef
- See RealTimeContactAnalysisTranscriptItemRedactionTypeDef
- See RealTimeContactAnalysisSentimentLabelType
RealTimeContactAnalysisPointOfInterestTypeDef#
# RealTimeContactAnalysisPointOfInterestTypeDef definition
class RealTimeContactAnalysisPointOfInterestTypeDef(TypedDict):
TranscriptItems: NotRequired[list[RealTimeContactAnalysisTranscriptItemWithCharacterOffsetsTypeDef]], # (1)RealTimeContactAnalysisIssueDetectedTypeDef#
# RealTimeContactAnalysisIssueDetectedTypeDef definition
class RealTimeContactAnalysisIssueDetectedTypeDef(TypedDict):
TranscriptItems: list[RealTimeContactAnalysisTranscriptItemWithContentTypeDef], # (1)ListContactReferencesResponseTypeDef#
# ListContactReferencesResponseTypeDef definition
class ListContactReferencesResponseTypeDef(TypedDict):
ReferenceSummaryList: list[ReferenceSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeInstanceResponseTypeDef#
# DescribeInstanceResponseTypeDef definition
class DescribeInstanceResponseTypeDef(TypedDict):
Instance: InstanceTypeDef, # (1)
ReplicationConfiguration: ReplicationConfigurationTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)SearchResourceTagsRequestPaginateTypeDef#
# SearchResourceTagsRequestPaginateTypeDef definition
class SearchResourceTagsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
ResourceTypes: NotRequired[Sequence[str]],
SearchCriteria: NotRequired[ResourceTagsSearchCriteriaTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)SearchResourceTagsRequestRequestTypeDef#
# SearchResourceTagsRequestRequestTypeDef definition
class SearchResourceTagsRequestRequestTypeDef(TypedDict):
InstanceId: str,
ResourceTypes: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchCriteria: NotRequired[ResourceTagsSearchCriteriaTypeDef], # (1)CreateContactRequestRequestTypeDef#
# CreateContactRequestRequestTypeDef definition
class CreateContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
Channel: ChannelType, # (1)
InitiationMethod: ContactInitiationMethodType, # (2)
ClientToken: NotRequired[str],
RelatedContactId: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
References: NotRequired[Mapping[str, ReferenceTypeDef]], # (3)
ExpiryDurationInMinutes: NotRequired[int],
UserInfo: NotRequired[UserInfoTypeDef], # (4)
InitiateAs: NotRequired[InitiateAsType], # (5)
Name: NotRequired[str],
Description: NotRequired[str],
SegmentAttributes: NotRequired[Mapping[str, SegmentAttributeValueUnionTypeDef]], # (6)- See ChannelType
- See ContactInitiationMethodType
- See ReferenceTypeDef
- See UserInfoTypeDef
- See InitiateAsType
- See SegmentAttributeValueTypeDef SegmentAttributeValueOutputTypeDef
GetTrafficDistributionResponseTypeDef#
# GetTrafficDistributionResponseTypeDef definition
class GetTrafficDistributionResponseTypeDef(TypedDict):
TelephonyConfig: TelephonyConfigOutputTypeDef, # (1)
Id: str,
Arn: str,
SignInConfig: SignInConfigOutputTypeDef, # (2)
AgentConfig: AgentConfigOutputTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See TelephonyConfigOutputTypeDef
- See SignInConfigOutputTypeDef
- See AgentConfigOutputTypeDef
- See ResponseMetadataTypeDef
UpdateTrafficDistributionRequestRequestTypeDef#
# UpdateTrafficDistributionRequestRequestTypeDef definition
class UpdateTrafficDistributionRequestRequestTypeDef(TypedDict):
Id: str,
TelephonyConfig: NotRequired[TelephonyConfigTypeDef], # (1)
SignInConfig: NotRequired[SignInConfigTypeDef], # (2)
AgentConfig: NotRequired[AgentConfigTypeDef], # (3)OutboundEmailContentTypeDef#
# OutboundEmailContentTypeDef definition
class OutboundEmailContentTypeDef(TypedDict):
MessageSourceType: OutboundMessageSourceTypeType, # (1)
TemplatedMessageConfig: NotRequired[TemplatedMessageConfigTypeDef], # (2)
RawMessage: NotRequired[OutboundRawMessageTypeDef], # (3)ContactAnalysisTypeDef#
# ContactAnalysisTypeDef definition
class ContactAnalysisTypeDef(TypedDict):
Transcript: NotRequired[TranscriptTypeDef], # (1)SearchUsersResponseTypeDef#
# SearchUsersResponseTypeDef definition
class SearchUsersResponseTypeDef(TypedDict):
Users: list[UserSearchSummaryTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],CreateViewResponseTypeDef#
# CreateViewResponseTypeDef definition
class CreateViewResponseTypeDef(TypedDict):
View: ViewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See ViewTypeDef
- See ResponseMetadataTypeDef
CreateViewVersionResponseTypeDef#
# CreateViewVersionResponseTypeDef definition
class CreateViewVersionResponseTypeDef(TypedDict):
View: ViewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See ViewTypeDef
- See ResponseMetadataTypeDef
DescribeViewResponseTypeDef#
# DescribeViewResponseTypeDef definition
class DescribeViewResponseTypeDef(TypedDict):
View: ViewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See ViewTypeDef
- See ResponseMetadataTypeDef
UpdateViewContentResponseTypeDef#
# UpdateViewContentResponseTypeDef definition
class UpdateViewContentResponseTypeDef(TypedDict):
View: ViewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See ViewTypeDef
- See ResponseMetadataTypeDef
ExpressionOutputTypeDef#
# ExpressionOutputTypeDef definition
class ExpressionOutputTypeDef(TypedDict):
AttributeCondition: NotRequired[AttributeConditionOutputTypeDef], # (1)
AndExpression: NotRequired[list[dict[str, Any]]],
OrExpression: NotRequired[list[dict[str, Any]]],
NotAttributeCondition: NotRequired[AttributeConditionOutputTypeDef], # (1)UserSearchFilterTypeDef#
# UserSearchFilterTypeDef definition
class UserSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)
UserAttributeFilter: NotRequired[ControlPlaneUserAttributeFilterTypeDef], # (2)AgentStatusSearchFilterTypeDef#
# AgentStatusSearchFilterTypeDef definition
class AgentStatusSearchFilterTypeDef(TypedDict):
AttributeFilter: NotRequired[ControlPlaneAttributeFilterTypeDef], # (1)UserHierarchyGroupSearchFilterTypeDef#
# UserHierarchyGroupSearchFilterTypeDef definition
class UserHierarchyGroupSearchFilterTypeDef(TypedDict):
AttributeFilter: NotRequired[ControlPlaneAttributeFilterTypeDef], # (1)SearchContactFlowModulesRequestPaginateTypeDef#
# SearchContactFlowModulesRequestPaginateTypeDef definition
class SearchContactFlowModulesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[ContactFlowModuleSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[ContactFlowModuleSearchCriteriaPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See ContactFlowModuleSearchFilterTypeDef
- See ContactFlowModuleSearchCriteriaPaginatorTypeDef
- See PaginatorConfigTypeDef
SearchContactFlowModulesRequestRequestTypeDef#
# SearchContactFlowModulesRequestRequestTypeDef definition
class SearchContactFlowModulesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[ContactFlowModuleSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[ContactFlowModuleSearchCriteriaTypeDef], # (2)SearchContactFlowsRequestPaginateTypeDef#
# SearchContactFlowsRequestPaginateTypeDef definition
class SearchContactFlowsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[ContactFlowSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[ContactFlowSearchCriteriaPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See ContactFlowSearchFilterTypeDef
- See ContactFlowSearchCriteriaPaginatorTypeDef
- See PaginatorConfigTypeDef
SearchContactFlowsRequestRequestTypeDef#
# SearchContactFlowsRequestRequestTypeDef definition
class SearchContactFlowsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[ContactFlowSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[ContactFlowSearchCriteriaTypeDef], # (2)SearchEmailAddressesRequestRequestTypeDef#
# SearchEmailAddressesRequestRequestTypeDef definition
class SearchEmailAddressesRequestRequestTypeDef(TypedDict):
InstanceId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SearchCriteria: NotRequired[EmailAddressSearchCriteriaTypeDef], # (1)
SearchFilter: NotRequired[EmailAddressSearchFilterTypeDef], # (2)SearchHoursOfOperationOverridesRequestPaginateTypeDef#
# SearchHoursOfOperationOverridesRequestPaginateTypeDef definition
class SearchHoursOfOperationOverridesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[HoursOfOperationSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[HoursOfOperationOverrideSearchCriteriaPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See HoursOfOperationSearchFilterTypeDef
- See HoursOfOperationOverrideSearchCriteriaPaginatorTypeDef
- See PaginatorConfigTypeDef
SearchHoursOfOperationOverridesRequestRequestTypeDef#
# SearchHoursOfOperationOverridesRequestRequestTypeDef definition
class SearchHoursOfOperationOverridesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[HoursOfOperationSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[HoursOfOperationOverrideSearchCriteriaTypeDef], # (2)SearchHoursOfOperationsRequestPaginateTypeDef#
# SearchHoursOfOperationsRequestPaginateTypeDef definition
class SearchHoursOfOperationsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[HoursOfOperationSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[HoursOfOperationSearchCriteriaPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See HoursOfOperationSearchFilterTypeDef
- See HoursOfOperationSearchCriteriaPaginatorTypeDef
- See PaginatorConfigTypeDef
SearchHoursOfOperationsRequestRequestTypeDef#
# SearchHoursOfOperationsRequestRequestTypeDef definition
class SearchHoursOfOperationsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[HoursOfOperationSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[HoursOfOperationSearchCriteriaTypeDef], # (2)SearchPromptsRequestPaginateTypeDef#
# SearchPromptsRequestPaginateTypeDef definition
class SearchPromptsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[PromptSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[PromptSearchCriteriaPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)SearchPromptsRequestRequestTypeDef#
# SearchPromptsRequestRequestTypeDef definition
class SearchPromptsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[PromptSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[PromptSearchCriteriaTypeDef], # (2)SearchQueuesRequestPaginateTypeDef#
# SearchQueuesRequestPaginateTypeDef definition
class SearchQueuesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[QueueSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[QueueSearchCriteriaPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)SearchQueuesRequestRequestTypeDef#
# SearchQueuesRequestRequestTypeDef definition
class SearchQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[QueueSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[QueueSearchCriteriaTypeDef], # (2)SearchQuickConnectsRequestPaginateTypeDef#
# SearchQuickConnectsRequestPaginateTypeDef definition
class SearchQuickConnectsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[QuickConnectSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[QuickConnectSearchCriteriaPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See QuickConnectSearchFilterTypeDef
- See QuickConnectSearchCriteriaPaginatorTypeDef
- See PaginatorConfigTypeDef
SearchQuickConnectsRequestRequestTypeDef#
# SearchQuickConnectsRequestRequestTypeDef definition
class SearchQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[QuickConnectSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[QuickConnectSearchCriteriaTypeDef], # (2)SearchRoutingProfilesRequestPaginateTypeDef#
# SearchRoutingProfilesRequestPaginateTypeDef definition
class SearchRoutingProfilesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[RoutingProfileSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[RoutingProfileSearchCriteriaPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See RoutingProfileSearchFilterTypeDef
- See RoutingProfileSearchCriteriaPaginatorTypeDef
- See PaginatorConfigTypeDef
SearchRoutingProfilesRequestRequestTypeDef#
# SearchRoutingProfilesRequestRequestTypeDef definition
class SearchRoutingProfilesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[RoutingProfileSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[RoutingProfileSearchCriteriaTypeDef], # (2)SearchSecurityProfilesRequestPaginateTypeDef#
# SearchSecurityProfilesRequestPaginateTypeDef definition
class SearchSecurityProfilesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchCriteria: NotRequired[SecurityProfileSearchCriteriaPaginatorTypeDef], # (1)
SearchFilter: NotRequired[SecurityProfilesSearchFilterTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See SecurityProfileSearchCriteriaPaginatorTypeDef
- See SecurityProfilesSearchFilterTypeDef
- See PaginatorConfigTypeDef
SearchSecurityProfilesRequestRequestTypeDef#
# SearchSecurityProfilesRequestRequestTypeDef definition
class SearchSecurityProfilesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchCriteria: NotRequired[SecurityProfileSearchCriteriaTypeDef], # (1)
SearchFilter: NotRequired[SecurityProfilesSearchFilterTypeDef], # (2)ConnectionDataTypeDef#
# ConnectionDataTypeDef definition
class ConnectionDataTypeDef(TypedDict):
Attendee: NotRequired[AttendeeTypeDef], # (1)
Meeting: NotRequired[MeetingTypeDef], # (2)- See AttendeeTypeDef
- 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)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)DescribeRoutingProfileResponseTypeDef#
# DescribeRoutingProfileResponseTypeDef definition
class DescribeRoutingProfileResponseTypeDef(TypedDict):
RoutingProfile: RoutingProfileTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchRoutingProfilesResponseTypeDef#
# SearchRoutingProfilesResponseTypeDef definition
class SearchRoutingProfilesResponseTypeDef(TypedDict):
RoutingProfiles: list[RoutingProfileTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],GetCurrentMetricDataResponseTypeDef#
# GetCurrentMetricDataResponseTypeDef definition
class GetCurrentMetricDataResponseTypeDef(TypedDict):
MetricResults: list[CurrentMetricResultTypeDef], # (1)
DataSnapshotTime: datetime,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],AssociateInstanceStorageConfigRequestRequestTypeDef#
# AssociateInstanceStorageConfigRequestRequestTypeDef definition
class AssociateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
StorageConfig: InstanceStorageConfigTypeDef, # (2)DescribeInstanceStorageConfigResponseTypeDef#
# DescribeInstanceStorageConfigResponseTypeDef definition
class DescribeInstanceStorageConfigResponseTypeDef(TypedDict):
StorageConfig: InstanceStorageConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListInstanceStorageConfigsResponseTypeDef#
# ListInstanceStorageConfigsResponseTypeDef definition
class ListInstanceStorageConfigsResponseTypeDef(TypedDict):
StorageConfigs: list[InstanceStorageConfigTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],UpdateInstanceStorageConfigRequestRequestTypeDef#
# UpdateInstanceStorageConfigRequestRequestTypeDef definition
class UpdateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
StorageConfig: InstanceStorageConfigTypeDef, # (2)EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef#
# EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef definition
class EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef(TypedDict):
Options: list[EvaluationFormSingleSelectQuestionOptionTypeDef], # (1)
DisplayAs: NotRequired[EvaluationFormSingleSelectQuestionDisplayModeType], # (2)
Automation: NotRequired[EvaluationFormSingleSelectQuestionAutomationOutputTypeDef], # (3)- See EvaluationFormSingleSelectQuestionOptionTypeDef
- See EvaluationFormSingleSelectQuestionDisplayModeType
- 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)- See ActionTypeType
- See TaskActionDefinitionOutputTypeDef
- See EventBridgeActionDefinitionTypeDef
- See SendNotificationActionDefinitionOutputTypeDef
- See CreateCaseActionDefinitionOutputTypeDef
- See UpdateCaseActionDefinitionOutputTypeDef
- See SubmitAutoEvaluationActionDefinitionTypeDef
CreateCaseActionDefinitionTypeDef#
# CreateCaseActionDefinitionTypeDef definition
class CreateCaseActionDefinitionTypeDef(TypedDict):
Fields: Sequence[FieldValueTypeDef], # (1)
TemplateId: str,GetCurrentUserDataResponseTypeDef#
# GetCurrentUserDataResponseTypeDef definition
class GetCurrentUserDataResponseTypeDef(TypedDict):
UserDataList: list[UserDataTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeUserHierarchyGroupResponseTypeDef#
# DescribeUserHierarchyGroupResponseTypeDef definition
class DescribeUserHierarchyGroupResponseTypeDef(TypedDict):
HierarchyGroup: HierarchyGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchUserHierarchyGroupsResponseTypeDef#
# SearchUserHierarchyGroupsResponseTypeDef definition
class SearchUserHierarchyGroupsResponseTypeDef(TypedDict):
UserHierarchyGroups: list[HierarchyGroupTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],HistoricalMetricResultTypeDef#
# HistoricalMetricResultTypeDef definition
class HistoricalMetricResultTypeDef(TypedDict):
Dimensions: NotRequired[DimensionsTypeDef], # (1)
Collections: NotRequired[list[HistoricalMetricDataTypeDef]], # (2)DescribeHoursOfOperationResponseTypeDef#
# DescribeHoursOfOperationResponseTypeDef definition
class DescribeHoursOfOperationResponseTypeDef(TypedDict):
HoursOfOperation: HoursOfOperationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchHoursOfOperationsResponseTypeDef#
# SearchHoursOfOperationsResponseTypeDef definition
class SearchHoursOfOperationsResponseTypeDef(TypedDict):
HoursOfOperations: list[HoursOfOperationTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeHoursOfOperationOverrideResponseTypeDef#
# DescribeHoursOfOperationOverrideResponseTypeDef definition
class DescribeHoursOfOperationOverrideResponseTypeDef(TypedDict):
HoursOfOperationOverride: HoursOfOperationOverrideTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListHoursOfOperationOverridesResponseTypeDef#
# ListHoursOfOperationOverridesResponseTypeDef definition
class ListHoursOfOperationOverridesResponseTypeDef(TypedDict):
HoursOfOperationOverrideList: list[HoursOfOperationOverrideTypeDef], # (1)
LastModifiedRegion: str,
LastModifiedTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],SearchHoursOfOperationOverridesResponseTypeDef#
# SearchHoursOfOperationOverridesResponseTypeDef definition
class SearchHoursOfOperationOverridesResponseTypeDef(TypedDict):
HoursOfOperationOverrides: list[HoursOfOperationOverrideTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],GetEffectiveHoursOfOperationsResponseTypeDef#
# GetEffectiveHoursOfOperationsResponseTypeDef definition
class GetEffectiveHoursOfOperationsResponseTypeDef(TypedDict):
EffectiveHoursOfOperationList: list[EffectiveHoursOfOperationsTypeDef], # (1)
TimeZone: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetTaskTemplateResponseTypeDef#
# GetTaskTemplateResponseTypeDef definition
class GetTaskTemplateResponseTypeDef(TypedDict):
InstanceId: str,
Id: str,
Arn: str,
Name: str,
Description: str,
ContactFlowId: str,
SelfAssignFlowId: 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)- See TaskTemplateConstraintsOutputTypeDef
- See TaskTemplateDefaultsOutputTypeDef
- See TaskTemplateFieldOutputTypeDef
- See TaskTemplateStatusType
- See ResponseMetadataTypeDef
UpdateTaskTemplateResponseTypeDef#
# UpdateTaskTemplateResponseTypeDef definition
class UpdateTaskTemplateResponseTypeDef(TypedDict):
InstanceId: str,
Id: str,
Arn: str,
Name: str,
Description: str,
ContactFlowId: str,
SelfAssignFlowId: str,
Constraints: TaskTemplateConstraintsOutputTypeDef, # (1)
Defaults: TaskTemplateDefaultsOutputTypeDef, # (2)
Fields: list[TaskTemplateFieldOutputTypeDef], # (3)
Status: TaskTemplateStatusType, # (4)
LastModifiedTime: datetime,
CreatedTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See TaskTemplateConstraintsOutputTypeDef
- See TaskTemplateDefaultsOutputTypeDef
- See TaskTemplateFieldOutputTypeDef
- See TaskTemplateStatusType
- See ResponseMetadataTypeDef
UpdateTaskTemplateRequestRequestTypeDef#
# UpdateTaskTemplateRequestRequestTypeDef definition
class UpdateTaskTemplateRequestRequestTypeDef(TypedDict):
TaskTemplateId: str,
InstanceId: str,
Name: NotRequired[str],
Description: NotRequired[str],
ContactFlowId: NotRequired[str],
SelfAssignFlowId: NotRequired[str],
Constraints: NotRequired[TaskTemplateConstraintsTypeDef], # (1)
Defaults: NotRequired[TaskTemplateDefaultsTypeDef], # (2)
Status: NotRequired[TaskTemplateStatusType], # (3)
Fields: NotRequired[Sequence[TaskTemplateFieldTypeDef]], # (4)- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateStatusType
- See TaskTemplateFieldTypeDef
CreateTaskTemplateRequestRequestTypeDef#
# CreateTaskTemplateRequestRequestTypeDef definition
class CreateTaskTemplateRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
Fields: Sequence[TaskTemplateFieldUnionTypeDef], # (1)
Description: NotRequired[str],
ContactFlowId: NotRequired[str],
SelfAssignFlowId: NotRequired[str],
Constraints: NotRequired[TaskTemplateConstraintsTypeDef], # (2)
Defaults: NotRequired[TaskTemplateDefaultsTypeDef], # (3)
Status: NotRequired[TaskTemplateStatusType], # (4)
ClientToken: NotRequired[str],- See TaskTemplateFieldTypeDef TaskTemplateFieldOutputTypeDef
- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateStatusType
MetricResultV2TypeDef#
# MetricResultV2TypeDef definition
class MetricResultV2TypeDef(TypedDict):
Dimensions: NotRequired[dict[str, str]],
MetricInterval: NotRequired[MetricIntervalTypeDef], # (1)
Collections: NotRequired[list[MetricDataV2TypeDef]], # (2)UpdateParticipantRoleConfigChannelInfoTypeDef#
# UpdateParticipantRoleConfigChannelInfoTypeDef definition
class UpdateParticipantRoleConfigChannelInfoTypeDef(TypedDict):
Chat: NotRequired[ChatParticipantRoleConfigTypeDef], # (1)DescribeQuickConnectResponseTypeDef#
# DescribeQuickConnectResponseTypeDef definition
class DescribeQuickConnectResponseTypeDef(TypedDict):
QuickConnect: QuickConnectTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchQuickConnectsResponseTypeDef#
# SearchQuickConnectsResponseTypeDef definition
class SearchQuickConnectsResponseTypeDef(TypedDict):
QuickConnects: list[QuickConnectTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],RealTimeContactAnalysisCategoryDetailsTypeDef#
# RealTimeContactAnalysisCategoryDetailsTypeDef definition
class RealTimeContactAnalysisCategoryDetailsTypeDef(TypedDict):
PointsOfInterest: list[RealTimeContactAnalysisPointOfInterestTypeDef], # (1)RealTimeContactAnalysisSegmentIssuesTypeDef#
# RealTimeContactAnalysisSegmentIssuesTypeDef definition
class RealTimeContactAnalysisSegmentIssuesTypeDef(TypedDict):
IssuesDetected: list[RealTimeContactAnalysisIssueDetectedTypeDef], # (1)SendOutboundEmailRequestRequestTypeDef#
# SendOutboundEmailRequestRequestTypeDef definition
class SendOutboundEmailRequestRequestTypeDef(TypedDict):
InstanceId: str,
FromEmailAddress: EmailAddressInfoTypeDef, # (1)
DestinationEmailAddress: EmailAddressInfoTypeDef, # (1)
EmailMessage: OutboundEmailContentTypeDef, # (3)
TrafficType: TrafficTypeType, # (4)
AdditionalRecipients: NotRequired[OutboundAdditionalRecipientsTypeDef], # (5)
SourceCampaign: NotRequired[SourceCampaignTypeDef], # (6)
ClientToken: NotRequired[str],- See EmailAddressInfoTypeDef
- See EmailAddressInfoTypeDef
- See OutboundEmailContentTypeDef
- See TrafficTypeType
- See OutboundAdditionalRecipientsTypeDef
- See SourceCampaignTypeDef
StartOutboundEmailContactRequestRequestTypeDef#
# StartOutboundEmailContactRequestRequestTypeDef definition
class StartOutboundEmailContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
DestinationEmailAddress: EmailAddressInfoTypeDef, # (1)
EmailMessage: OutboundEmailContentTypeDef, # (2)
FromEmailAddress: NotRequired[EmailAddressInfoTypeDef], # (1)
AdditionalRecipients: NotRequired[OutboundAdditionalRecipientsTypeDef], # (4)
ClientToken: NotRequired[str],- See EmailAddressInfoTypeDef
- See OutboundEmailContentTypeDef
- See EmailAddressInfoTypeDef
- See OutboundAdditionalRecipientsTypeDef
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)
SearchableSegmentAttributes: NotRequired[SearchableSegmentAttributesTypeDef], # (6)- See AgentHierarchyGroupsTypeDef
- See ChannelType
- See ContactAnalysisTypeDef
- See ContactInitiationMethodType
- See SearchableContactAttributesTypeDef
- See SearchableSegmentAttributesTypeDef
StepTypeDef#
# StepTypeDef definition
class StepTypeDef(TypedDict):
Expiry: NotRequired[ExpiryTypeDef], # (1)
Expression: NotRequired[ExpressionOutputTypeDef], # (2)
Status: NotRequired[RoutingCriteriaStepStatusType], # (3)AttributeConditionTypeDef#
# AttributeConditionTypeDef definition
class AttributeConditionTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],
ProficiencyLevel: NotRequired[float],
Range: NotRequired[RangeTypeDef], # (1)
MatchCriteria: NotRequired[MatchCriteriaUnionTypeDef], # (2)
ComparisonOperator: NotRequired[str],SearchAgentStatusesRequestPaginateTypeDef#
# SearchAgentStatusesRequestPaginateTypeDef definition
class SearchAgentStatusesRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[AgentStatusSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[AgentStatusSearchCriteriaPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See AgentStatusSearchFilterTypeDef
- See AgentStatusSearchCriteriaPaginatorTypeDef
- See PaginatorConfigTypeDef
SearchAgentStatusesRequestRequestTypeDef#
# SearchAgentStatusesRequestRequestTypeDef definition
class SearchAgentStatusesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[AgentStatusSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[AgentStatusSearchCriteriaTypeDef], # (2)SearchUserHierarchyGroupsRequestPaginateTypeDef#
# SearchUserHierarchyGroupsRequestPaginateTypeDef definition
class SearchUserHierarchyGroupsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[UserHierarchyGroupSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[UserHierarchyGroupSearchCriteriaPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See UserHierarchyGroupSearchFilterTypeDef
- See UserHierarchyGroupSearchCriteriaPaginatorTypeDef
- See PaginatorConfigTypeDef
SearchUserHierarchyGroupsRequestRequestTypeDef#
# SearchUserHierarchyGroupsRequestRequestTypeDef definition
class SearchUserHierarchyGroupsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[UserHierarchyGroupSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[UserHierarchyGroupSearchCriteriaTypeDef], # (2)StartWebRTCContactResponseTypeDef#
# StartWebRTCContactResponseTypeDef definition
class StartWebRTCContactResponseTypeDef(TypedDict):
ConnectionData: ConnectionDataTypeDef, # (1)
ContactId: str,
ParticipantId: str,
ParticipantToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchUsersRequestPaginateTypeDef#
# SearchUsersRequestPaginateTypeDef definition
class SearchUsersRequestPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[UserSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[UserSearchCriteriaPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)SearchUsersRequestRequestTypeDef#
# SearchUsersRequestRequestTypeDef definition
class SearchUsersRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[UserSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[UserSearchCriteriaTypeDef], # (2)EvaluationFormQuestionTypePropertiesOutputTypeDef#
# EvaluationFormQuestionTypePropertiesOutputTypeDef definition
class EvaluationFormQuestionTypePropertiesOutputTypeDef(TypedDict):
Numeric: NotRequired[EvaluationFormNumericQuestionPropertiesOutputTypeDef], # (1)
SingleSelect: NotRequired[EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef], # (2)- See EvaluationFormNumericQuestionPropertiesOutputTypeDef
- See EvaluationFormSingleSelectQuestionPropertiesOutputTypeDef
EvaluationFormSingleSelectQuestionPropertiesTypeDef#
# EvaluationFormSingleSelectQuestionPropertiesTypeDef definition
class EvaluationFormSingleSelectQuestionPropertiesTypeDef(TypedDict):
Options: Sequence[EvaluationFormSingleSelectQuestionOptionTypeDef], # (1)
DisplayAs: NotRequired[EvaluationFormSingleSelectQuestionDisplayModeType], # (2)
Automation: NotRequired[EvaluationFormSingleSelectQuestionAutomationUnionTypeDef], # (3)- See EvaluationFormSingleSelectQuestionOptionTypeDef
- See EvaluationFormSingleSelectQuestionDisplayModeType
- 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]],UpdateCaseActionDefinitionTypeDef#
# UpdateCaseActionDefinitionTypeDef definition
class UpdateCaseActionDefinitionTypeDef(TypedDict):
Fields: Sequence[FieldValueExtraUnionTypeDef], # (1)GetMetricDataResponseTypeDef#
# GetMetricDataResponseTypeDef definition
class GetMetricDataResponseTypeDef(TypedDict):
MetricResults: list[HistoricalMetricResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],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],GetMetricDataV2ResponseTypeDef#
# GetMetricDataV2ResponseTypeDef definition
class GetMetricDataV2ResponseTypeDef(TypedDict):
MetricResults: list[MetricResultV2TypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],UpdateParticipantRoleConfigRequestRequestTypeDef#
# UpdateParticipantRoleConfigRequestRequestTypeDef definition
class UpdateParticipantRoleConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ChannelConfiguration: UpdateParticipantRoleConfigChannelInfoTypeDef, # (1)RealTimeContactAnalysisSegmentCategoriesTypeDef#
# RealTimeContactAnalysisSegmentCategoriesTypeDef definition
class RealTimeContactAnalysisSegmentCategoriesTypeDef(TypedDict):
MatchedDetails: dict[str, RealTimeContactAnalysisCategoryDetailsTypeDef], # (1)SearchContactsRequestPaginateTypeDef#
# SearchContactsRequestPaginateTypeDef definition
class SearchContactsRequestPaginateTypeDef(TypedDict):
InstanceId: str,
TimeRange: SearchContactsTimeRangeTypeDef, # (1)
SearchCriteria: NotRequired[SearchCriteriaTypeDef], # (2)
Sort: NotRequired[SortTypeDef], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)- See SearchContactsTimeRangeTypeDef
- See SearchCriteriaTypeDef
- See SortTypeDef
- See PaginatorConfigTypeDef
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)RoutingCriteriaTypeDef#
# RoutingCriteriaTypeDef definition
class RoutingCriteriaTypeDef(TypedDict):
Steps: NotRequired[list[StepTypeDef]], # (1)
ActivationTimestamp: NotRequired[datetime],
Index: NotRequired[int],- 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],DescribeRuleResponseTypeDef#
# DescribeRuleResponseTypeDef definition
class DescribeRuleResponseTypeDef(TypedDict):
Rule: RuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See RuleTypeDef
- 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)- See RealTimeContactAnalysisSegmentTranscriptTypeDef
- See RealTimeContactAnalysisSegmentCategoriesTypeDef
- See RealTimeContactAnalysisSegmentIssuesTypeDef
- See RealTimeContactAnalysisSegmentEventTypeDef
- See RealTimeContactAnalysisSegmentAttachmentsTypeDef
- See RealTimeContactAnalysisSegmentPostContactSummaryTypeDef
ContactTypeDef#
# ContactTypeDef definition
class ContactTypeDef(TypedDict):
Arn: NotRequired[str],
Id: NotRequired[str],
InitialContactId: NotRequired[str],
PreviousContactId: NotRequired[str],
ContactAssociationId: 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)
CustomerId: NotRequired[str],
CustomerEndpoint: NotRequired[EndpointInfoTypeDef], # (6)
SystemEndpoint: NotRequired[EndpointInfoTypeDef], # (6)
QueueTimeAdjustmentSeconds: NotRequired[int],
QueuePriority: NotRequired[int],
Tags: NotRequired[dict[str, str]],
ConnectedToSystemTimestamp: NotRequired[datetime],
RoutingCriteria: NotRequired[RoutingCriteriaTypeDef], # (8)
Customer: NotRequired[CustomerTypeDef], # (9)
Campaign: NotRequired[CampaignTypeDef], # (10)
AnsweringMachineDetectionStatus: NotRequired[AnsweringMachineDetectionStatusType], # (11)
CustomerVoiceActivity: NotRequired[CustomerVoiceActivityTypeDef], # (12)
QualityMetrics: NotRequired[QualityMetricsTypeDef], # (13)
DisconnectDetails: NotRequired[DisconnectDetailsTypeDef], # (14)
AdditionalEmailRecipients: NotRequired[AdditionalEmailRecipientsTypeDef], # (15)
SegmentAttributes: NotRequired[dict[str, SegmentAttributeValueOutputTypeDef]], # (16)- See ContactInitiationMethodType
- See ChannelType
- See QueueInfoTypeDef
- See AgentInfoTypeDef
- See WisdomInfoTypeDef
- See EndpointInfoTypeDef
- See EndpointInfoTypeDef
- See RoutingCriteriaTypeDef
- See CustomerTypeDef
- See CampaignTypeDef
- See AnsweringMachineDetectionStatusType
- See CustomerVoiceActivityTypeDef
- See QualityMetricsTypeDef
- See DisconnectDetailsTypeDef
- See AdditionalEmailRecipientsTypeDef
- See SegmentAttributeValueOutputTypeDef
ExpressionTypeDef#
# ExpressionTypeDef definition
class ExpressionTypeDef(TypedDict):
AttributeCondition: NotRequired[AttributeConditionUnionTypeDef], # (1)
AndExpression: NotRequired[Sequence[Mapping[str, Any]]],
OrExpression: NotRequired[Sequence[Mapping[str, Any]]],
NotAttributeCondition: NotRequired[AttributeConditionUnionTypeDef], # (1)- See AttributeConditionTypeDef AttributeConditionOutputTypeDef
- See AttributeConditionTypeDef AttributeConditionOutputTypeDef
EvaluationFormItemOutputTypeDef#
# EvaluationFormItemOutputTypeDef definition
class EvaluationFormItemOutputTypeDef(TypedDict):
Section: NotRequired[EvaluationFormSectionOutputTypeDef], # (1)
Question: NotRequired[EvaluationFormQuestionOutputTypeDef], # (2)EvaluationFormQuestionTypePropertiesTypeDef#
# EvaluationFormQuestionTypePropertiesTypeDef definition
class EvaluationFormQuestionTypePropertiesTypeDef(TypedDict):
Numeric: NotRequired[EvaluationFormNumericQuestionPropertiesUnionTypeDef], # (1)
SingleSelect: NotRequired[EvaluationFormSingleSelectQuestionPropertiesUnionTypeDef], # (2)- See EvaluationFormNumericQuestionPropertiesTypeDef EvaluationFormNumericQuestionPropertiesOutputTypeDef
- 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)- See ActionTypeType
- See TaskActionDefinitionTypeDef TaskActionDefinitionOutputTypeDef
- See EventBridgeActionDefinitionTypeDef
- See SendNotificationActionDefinitionTypeDef SendNotificationActionDefinitionOutputTypeDef
- See CreateCaseActionDefinitionTypeDef CreateCaseActionDefinitionOutputTypeDef
- See UpdateCaseActionDefinitionTypeDef UpdateCaseActionDefinitionOutputTypeDef
- See SubmitAutoEvaluationActionDefinitionTypeDef
ListRealtimeContactAnalysisSegmentsV2ResponseTypeDef#
# ListRealtimeContactAnalysisSegmentsV2ResponseTypeDef definition
class ListRealtimeContactAnalysisSegmentsV2ResponseTypeDef(TypedDict):
Channel: RealTimeContactAnalysisSupportedChannelType, # (1)
Status: RealTimeContactAnalysisStatusType, # (2)
Segments: list[RealtimeContactAnalysisSegmentTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
NextToken: NotRequired[str],- See RealTimeContactAnalysisSupportedChannelType
- See RealTimeContactAnalysisStatusType
- See RealtimeContactAnalysisSegmentTypeDef
- See ResponseMetadataTypeDef
DescribeContactResponseTypeDef#
# DescribeContactResponseTypeDef definition
class DescribeContactResponseTypeDef(TypedDict):
Contact: ContactTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)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)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]],- See EvaluationFormVersionStatusType
- See EvaluationFormItemOutputTypeDef
- See EvaluationFormScoringStrategyTypeDef
UpdateRuleRequestRequestTypeDef#
# UpdateRuleRequestRequestTypeDef definition
class UpdateRuleRequestRequestTypeDef(TypedDict):
RuleId: str,
InstanceId: str,
Name: str,
Function: str,
Actions: Sequence[RuleActionTypeDef], # (1)
PublishStatus: RulePublishStatusType, # (2)RoutingCriteriaInputStepTypeDef#
# RoutingCriteriaInputStepTypeDef definition
class RoutingCriteriaInputStepTypeDef(TypedDict):
Expiry: NotRequired[RoutingCriteriaInputStepExpiryTypeDef], # (1)
Expression: NotRequired[ExpressionUnionTypeDef], # (2)DescribeContactEvaluationResponseTypeDef#
# DescribeContactEvaluationResponseTypeDef definition
class DescribeContactEvaluationResponseTypeDef(TypedDict):
Evaluation: EvaluationTypeDef, # (1)
EvaluationForm: EvaluationFormContentTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)DescribeEvaluationFormResponseTypeDef#
# DescribeEvaluationFormResponseTypeDef definition
class DescribeEvaluationFormResponseTypeDef(TypedDict):
EvaluationForm: EvaluationFormTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)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],- See EvaluationFormQuestionTypeType
- 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],- See RuleTriggerEventSourceTypeDef
- See RuleActionTypeDef RuleActionOutputTypeDef
- See RulePublishStatusType
RoutingCriteriaInputTypeDef#
# RoutingCriteriaInputTypeDef definition
class RoutingCriteriaInputTypeDef(TypedDict):
Steps: NotRequired[Sequence[RoutingCriteriaInputStepTypeDef]], # (1)UpdateContactRoutingDataRequestRequestTypeDef#
# UpdateContactRoutingDataRequestRequestTypeDef definition
class UpdateContactRoutingDataRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
QueueTimeAdjustmentSeconds: NotRequired[int],
QueuePriority: NotRequired[int],
RoutingCriteria: NotRequired[RoutingCriteriaInputTypeDef], # (1)EvaluationFormItemTypeDef#
# EvaluationFormItemTypeDef definition
class EvaluationFormItemTypeDef(TypedDict):
Section: NotRequired[EvaluationFormSectionUnionTypeDef], # (1)
Question: NotRequired[EvaluationFormQuestionUnionTypeDef], # (2)- See EvaluationFormSectionTypeDef EvaluationFormSectionOutputTypeDef
- 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],CreateEvaluationFormRequestRequestTypeDef#
# CreateEvaluationFormRequestRequestTypeDef definition
class CreateEvaluationFormRequestRequestTypeDef(TypedDict):
InstanceId: str,
Title: str,
Items: Sequence[EvaluationFormItemUnionTypeDef], # (1)
Description: NotRequired[str],
ScoringStrategy: NotRequired[EvaluationFormScoringStrategyTypeDef], # (2)
ClientToken: NotRequired[str],