Typed dictionaries
Auto-generated documentation for Connect type annotations stubs module mypy-boto3-connect.
ActionSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ActionSummaryTypeDef
def get_value() -> ActionSummaryTypeDef:
return {
"ActionType": ...,
}
- See ActionTypeType
QueueReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import QueueReferenceTypeDef
def get_value() -> QueueReferenceTypeDef:
return {
"Id": ...,
}
AgentInfoTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AgentInfoTypeDef
def get_value() -> AgentInfoTypeDef:
return {
"Id": ...,
}
Definition
class AgentInfoTypeDef(TypedDict):
Id: NotRequired[str],
ConnectedToAgentTimestamp: NotRequired[datetime],
AgentStatusReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AgentStatusReferenceTypeDef
def get_value() -> AgentStatusReferenceTypeDef:
return {
"StatusStartTimestamp": ...,
}
Definition
class AgentStatusReferenceTypeDef(TypedDict):
StatusStartTimestamp: NotRequired[datetime],
StatusArn: NotRequired[str],
StatusName: NotRequired[str],
AgentStatusSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AgentStatusSummaryTypeDef
def get_value() -> AgentStatusSummaryTypeDef:
return {
"Id": ...,
}
Definition
class AgentStatusSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
Type: NotRequired[AgentStatusTypeType], # (1)
AgentStatusTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AgentStatusTypeDef
def get_value() -> AgentStatusTypeDef:
return {
"AgentStatusARN": ...,
}
Definition
class AgentStatusTypeDef(TypedDict):
AgentStatusARN: NotRequired[str],
AgentStatusId: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
Type: NotRequired[AgentStatusTypeType], # (1)
DisplayOrder: NotRequired[int],
State: NotRequired[AgentStatusStateType], # (2)
Tags: NotRequired[Dict[str, str]],
AnswerMachineDetectionConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AnswerMachineDetectionConfigTypeDef
def get_value() -> AnswerMachineDetectionConfigTypeDef:
return {
"EnableAnswerMachineDetection": ...,
}
Definition
class AnswerMachineDetectionConfigTypeDef(TypedDict):
EnableAnswerMachineDetection: NotRequired[bool],
AwaitAnswerMachinePrompt: NotRequired[bool],
AssociateApprovedOriginRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociateApprovedOriginRequestRequestTypeDef
def get_value() -> AssociateApprovedOriginRequestRequestTypeDef:
return {
"InstanceId": ...,
"Origin": ...,
}
Definition
class AssociateApprovedOriginRequestRequestTypeDef(TypedDict):
InstanceId: str,
Origin: str,
LexBotTypeDef
Usage Example
from mypy_boto3_connect.type_defs import LexBotTypeDef
def get_value() -> LexBotTypeDef:
return {
"Name": ...,
"LexRegion": ...,
}
LexV2BotTypeDef
Usage Example
from mypy_boto3_connect.type_defs import LexV2BotTypeDef
def get_value() -> LexV2BotTypeDef:
return {
"AliasArn": ...,
}
AssociateDefaultVocabularyRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociateDefaultVocabularyRequestRequestTypeDef
def get_value() -> AssociateDefaultVocabularyRequestRequestTypeDef:
return {
"InstanceId": ...,
"LanguageCode": ...,
}
Definition
class AssociateDefaultVocabularyRequestRequestTypeDef(TypedDict):
InstanceId: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
VocabularyId: NotRequired[str],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
AssociateLambdaFunctionRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociateLambdaFunctionRequestRequestTypeDef
def get_value() -> AssociateLambdaFunctionRequestRequestTypeDef:
return {
"InstanceId": ...,
"FunctionArn": ...,
}
Definition
class AssociateLambdaFunctionRequestRequestTypeDef(TypedDict):
InstanceId: str,
FunctionArn: str,
AssociatePhoneNumberContactFlowRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociatePhoneNumberContactFlowRequestRequestTypeDef
def get_value() -> AssociatePhoneNumberContactFlowRequestRequestTypeDef:
return {
"PhoneNumberId": ...,
"InstanceId": ...,
"ContactFlowId": ...,
}
Definition
class AssociatePhoneNumberContactFlowRequestRequestTypeDef(TypedDict):
PhoneNumberId: str,
InstanceId: str,
ContactFlowId: str,
AssociateQueueQuickConnectsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociateQueueQuickConnectsRequestRequestTypeDef
def get_value() -> AssociateQueueQuickConnectsRequestRequestTypeDef:
return {
"InstanceId": ...,
"QueueId": ...,
"QuickConnectIds": ...,
}
Definition
class AssociateQueueQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
QuickConnectIds: Sequence[str],
AssociateSecurityKeyRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociateSecurityKeyRequestRequestTypeDef
def get_value() -> AssociateSecurityKeyRequestRequestTypeDef:
return {
"InstanceId": ...,
"Key": ...,
}
AttachmentReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AttachmentReferenceTypeDef
def get_value() -> AttachmentReferenceTypeDef:
return {
"Name": ...,
}
Definition
class AttachmentReferenceTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],
Status: NotRequired[ReferenceStatusType], # (1)
AttributeTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AttributeTypeDef
def get_value() -> AttributeTypeDef:
return {
"AttributeType": ...,
}
Definition
class AttributeTypeDef(TypedDict):
AttributeType: NotRequired[InstanceAttributeTypeType], # (1)
Value: NotRequired[str],
AvailableNumberSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AvailableNumberSummaryTypeDef
def get_value() -> AvailableNumberSummaryTypeDef:
return {
"PhoneNumber": ...,
}
Definition
class AvailableNumberSummaryTypeDef(TypedDict):
PhoneNumber: NotRequired[str],
PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType], # (1)
PhoneNumberType: NotRequired[PhoneNumberTypeType], # (2)
ChatMessageTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ChatMessageTypeDef
def get_value() -> ChatMessageTypeDef:
return {
"ContentType": ...,
"Content": ...,
}
ChatStreamingConfigurationTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ChatStreamingConfigurationTypeDef
def get_value() -> ChatStreamingConfigurationTypeDef:
return {
"StreamingEndpointArn": ...,
}
ClaimPhoneNumberRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ClaimPhoneNumberRequestRequestTypeDef
def get_value() -> ClaimPhoneNumberRequestRequestTypeDef:
return {
"TargetArn": ...,
"PhoneNumber": ...,
}
Definition
class ClaimPhoneNumberRequestRequestTypeDef(TypedDict):
TargetArn: str,
PhoneNumber: str,
PhoneNumberDescription: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
ClientToken: NotRequired[str],
PhoneNumberStatusTypeDef
Usage Example
from mypy_boto3_connect.type_defs import PhoneNumberStatusTypeDef
def get_value() -> PhoneNumberStatusTypeDef:
return {
"Status": ...,
}
Definition
class PhoneNumberStatusTypeDef(TypedDict):
Status: NotRequired[PhoneNumberWorkflowStatusType], # (1)
Message: NotRequired[str],
ContactFilterTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ContactFilterTypeDef
def get_value() -> ContactFilterTypeDef:
return {
"ContactStates": ...,
}
Definition
class ContactFilterTypeDef(TypedDict):
ContactStates: NotRequired[Sequence[ContactStateType]], # (1)
- See ContactStateType
ContactFlowModuleSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ContactFlowModuleSummaryTypeDef
def get_value() -> ContactFlowModuleSummaryTypeDef:
return {
"Id": ...,
}
Definition
class ContactFlowModuleSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
State: NotRequired[ContactFlowModuleStateType], # (1)
ContactFlowModuleTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ContactFlowModuleTypeDef
def get_value() -> ContactFlowModuleTypeDef:
return {
"Arn": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import ContactFlowSummaryTypeDef
def get_value() -> ContactFlowSummaryTypeDef:
return {
"Id": ...,
}
Definition
class ContactFlowSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
ContactFlowType: NotRequired[ContactFlowTypeType], # (1)
ContactFlowState: NotRequired[ContactFlowStateType], # (2)
ContactFlowTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ContactFlowTypeDef
def get_value() -> ContactFlowTypeDef:
return {
"Arn": ...,
}
Definition
class ContactFlowTypeDef(TypedDict):
Arn: NotRequired[str],
Id: NotRequired[str],
Name: NotRequired[str],
Type: NotRequired[ContactFlowTypeType], # (1)
State: NotRequired[ContactFlowStateType], # (2)
Description: NotRequired[str],
Content: NotRequired[str],
Tags: NotRequired[Dict[str, str]],
QueueInfoTypeDef
Usage Example
from mypy_boto3_connect.type_defs import QueueInfoTypeDef
def get_value() -> QueueInfoTypeDef:
return {
"Id": ...,
}
Definition
class QueueInfoTypeDef(TypedDict):
Id: NotRequired[str],
EnqueueTimestamp: NotRequired[datetime],
WisdomInfoTypeDef
Usage Example
from mypy_boto3_connect.type_defs import WisdomInfoTypeDef
def get_value() -> WisdomInfoTypeDef:
return {
"SessionArn": ...,
}
TagConditionTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TagConditionTypeDef
def get_value() -> TagConditionTypeDef:
return {
"TagKey": ...,
}
Definition
class TagConditionTypeDef(TypedDict):
TagKey: NotRequired[str],
TagValue: NotRequired[str],
CreateAgentStatusRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateAgentStatusRequestRequestTypeDef
def get_value() -> CreateAgentStatusRequestRequestTypeDef:
return {
"InstanceId": ...,
"Name": ...,
"State": ...,
}
Definition
class CreateAgentStatusRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
State: AgentStatusStateType, # (1)
Description: NotRequired[str],
DisplayOrder: NotRequired[int],
Tags: NotRequired[Mapping[str, str]],
CreateContactFlowModuleRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateContactFlowModuleRequestRequestTypeDef
def get_value() -> CreateContactFlowModuleRequestRequestTypeDef:
return {
"InstanceId": ...,
"Name": ...,
"Content": ...,
}
Definition
class CreateContactFlowModuleRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
Content: str,
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
ClientToken: NotRequired[str],
CreateContactFlowRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateContactFlowRequestRequestTypeDef
def get_value() -> CreateContactFlowRequestRequestTypeDef:
return {
"InstanceId": ...,
"Name": ...,
"Type": ...,
"Content": ...,
}
Definition
class CreateContactFlowRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
Type: ContactFlowTypeType, # (1)
Content: str,
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
CreateInstanceRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateInstanceRequestRequestTypeDef
def get_value() -> CreateInstanceRequestRequestTypeDef:
return {
"IdentityManagementType": ...,
"InboundCallsEnabled": ...,
"OutboundCallsEnabled": ...,
}
Definition
class CreateInstanceRequestRequestTypeDef(TypedDict):
IdentityManagementType: DirectoryTypeType, # (1)
InboundCallsEnabled: bool,
OutboundCallsEnabled: bool,
ClientToken: NotRequired[str],
InstanceAlias: NotRequired[str],
DirectoryId: NotRequired[str],
CreateIntegrationAssociationRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateIntegrationAssociationRequestRequestTypeDef
def get_value() -> CreateIntegrationAssociationRequestRequestTypeDef:
return {
"InstanceId": ...,
"IntegrationType": ...,
"IntegrationArn": ...,
}
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
OutboundCallerConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import OutboundCallerConfigTypeDef
def get_value() -> OutboundCallerConfigTypeDef:
return {
"OutboundCallerIdName": ...,
}
Definition
class OutboundCallerConfigTypeDef(TypedDict):
OutboundCallerIdName: NotRequired[str],
OutboundCallerIdNumberId: NotRequired[str],
OutboundFlowId: NotRequired[str],
MediaConcurrencyTypeDef
Usage Example
from mypy_boto3_connect.type_defs import MediaConcurrencyTypeDef
def get_value() -> MediaConcurrencyTypeDef:
return {
"Channel": ...,
"Concurrency": ...,
}
- See ChannelType
RuleTriggerEventSourceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RuleTriggerEventSourceTypeDef
def get_value() -> RuleTriggerEventSourceTypeDef:
return {
"EventSourceName": ...,
}
Definition
class RuleTriggerEventSourceTypeDef(TypedDict):
EventSourceName: EventSourceNameType, # (1)
IntegrationAssociationId: NotRequired[str],
CreateSecurityProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateSecurityProfileRequestRequestTypeDef
def get_value() -> CreateSecurityProfileRequestRequestTypeDef:
return {
"SecurityProfileName": ...,
"InstanceId": ...,
}
Definition
class CreateSecurityProfileRequestRequestTypeDef(TypedDict):
SecurityProfileName: str,
InstanceId: str,
Description: NotRequired[str],
Permissions: NotRequired[Sequence[str]],
Tags: NotRequired[Mapping[str, str]],
AllowedAccessControlTags: NotRequired[Mapping[str, str]],
TagRestrictedResources: NotRequired[Sequence[str]],
CreateTrafficDistributionGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateTrafficDistributionGroupRequestRequestTypeDef
def get_value() -> CreateTrafficDistributionGroupRequestRequestTypeDef:
return {
"Name": ...,
"InstanceId": ...,
}
Definition
class CreateTrafficDistributionGroupRequestRequestTypeDef(TypedDict):
Name: str,
InstanceId: str,
Description: NotRequired[str],
ClientToken: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
CreateUseCaseRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateUseCaseRequestRequestTypeDef
def get_value() -> CreateUseCaseRequestRequestTypeDef:
return {
"InstanceId": ...,
"IntegrationAssociationId": ...,
"UseCaseType": ...,
}
Definition
class CreateUseCaseRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
UseCaseType: UseCaseTypeType, # (1)
Tags: NotRequired[Mapping[str, str]],
- See UseCaseTypeType
CreateUserHierarchyGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateUserHierarchyGroupRequestRequestTypeDef
def get_value() -> CreateUserHierarchyGroupRequestRequestTypeDef:
return {
"Name": ...,
"InstanceId": ...,
}
Definition
class CreateUserHierarchyGroupRequestRequestTypeDef(TypedDict):
Name: str,
InstanceId: str,
ParentGroupId: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
UserIdentityInfoTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserIdentityInfoTypeDef
def get_value() -> UserIdentityInfoTypeDef:
return {
"FirstName": ...,
}
Definition
class UserIdentityInfoTypeDef(TypedDict):
FirstName: NotRequired[str],
LastName: NotRequired[str],
Email: NotRequired[str],
SecondaryEmail: NotRequired[str],
Mobile: NotRequired[str],
UserPhoneConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserPhoneConfigTypeDef
def get_value() -> UserPhoneConfigTypeDef:
return {
"PhoneType": ...,
}
Definition
class UserPhoneConfigTypeDef(TypedDict):
PhoneType: PhoneTypeType, # (1)
AutoAccept: NotRequired[bool],
AfterContactWorkTimeLimit: NotRequired[int],
DeskPhoneNumber: NotRequired[str],
- See PhoneTypeType
CreateVocabularyRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateVocabularyRequestRequestTypeDef
def get_value() -> CreateVocabularyRequestRequestTypeDef:
return {
"InstanceId": ...,
"VocabularyName": ...,
"LanguageCode": ...,
"Content": ...,
}
Definition
class CreateVocabularyRequestRequestTypeDef(TypedDict):
InstanceId: str,
VocabularyName: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
Content: str,
ClientToken: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
CredentialsTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CredentialsTypeDef
def get_value() -> CredentialsTypeDef:
return {
"AccessToken": ...,
}
Definition
class CredentialsTypeDef(TypedDict):
AccessToken: NotRequired[str],
AccessTokenExpiration: NotRequired[datetime],
RefreshToken: NotRequired[str],
RefreshTokenExpiration: NotRequired[datetime],
CurrentMetricTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CurrentMetricTypeDef
def get_value() -> CurrentMetricTypeDef:
return {
"Name": ...,
}
Definition
class CurrentMetricTypeDef(TypedDict):
Name: NotRequired[CurrentMetricNameType], # (1)
Unit: NotRequired[UnitType], # (2)
- See CurrentMetricNameType
- See UnitType
CurrentMetricSortCriteriaTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CurrentMetricSortCriteriaTypeDef
def get_value() -> CurrentMetricSortCriteriaTypeDef:
return {
"SortByMetric": ...,
}
Definition
class CurrentMetricSortCriteriaTypeDef(TypedDict):
SortByMetric: NotRequired[CurrentMetricNameType], # (1)
SortOrder: NotRequired[SortOrderType], # (2)
- See CurrentMetricNameType
- See SortOrderType
DateReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DateReferenceTypeDef
def get_value() -> DateReferenceTypeDef:
return {
"Name": ...,
}
DefaultVocabularyTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DefaultVocabularyTypeDef
def get_value() -> DefaultVocabularyTypeDef:
return {
"InstanceId": ...,
"LanguageCode": ...,
"VocabularyId": ...,
"VocabularyName": ...,
}
Definition
class DefaultVocabularyTypeDef(TypedDict):
InstanceId: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
VocabularyId: str,
VocabularyName: str,
DeleteContactFlowModuleRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteContactFlowModuleRequestRequestTypeDef
def get_value() -> DeleteContactFlowModuleRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactFlowModuleId": ...,
}
Definition
class DeleteContactFlowModuleRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleId: str,
DeleteContactFlowRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteContactFlowRequestRequestTypeDef
def get_value() -> DeleteContactFlowRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactFlowId": ...,
}
Definition
class DeleteContactFlowRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,
DeleteHoursOfOperationRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteHoursOfOperationRequestRequestTypeDef
def get_value() -> DeleteHoursOfOperationRequestRequestTypeDef:
return {
"InstanceId": ...,
"HoursOfOperationId": ...,
}
Definition
class DeleteHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
DeleteInstanceRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteInstanceRequestRequestTypeDef
def get_value() -> DeleteInstanceRequestRequestTypeDef:
return {
"InstanceId": ...,
}
DeleteIntegrationAssociationRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteIntegrationAssociationRequestRequestTypeDef
def get_value() -> DeleteIntegrationAssociationRequestRequestTypeDef:
return {
"InstanceId": ...,
"IntegrationAssociationId": ...,
}
Definition
class DeleteIntegrationAssociationRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
DeleteQuickConnectRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteQuickConnectRequestRequestTypeDef
def get_value() -> DeleteQuickConnectRequestRequestTypeDef:
return {
"InstanceId": ...,
"QuickConnectId": ...,
}
Definition
class DeleteQuickConnectRequestRequestTypeDef(TypedDict):
InstanceId: str,
QuickConnectId: str,
DeleteRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteRuleRequestRequestTypeDef
def get_value() -> DeleteRuleRequestRequestTypeDef:
return {
"InstanceId": ...,
"RuleId": ...,
}
DeleteSecurityProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteSecurityProfileRequestRequestTypeDef
def get_value() -> DeleteSecurityProfileRequestRequestTypeDef:
return {
"InstanceId": ...,
"SecurityProfileId": ...,
}
Definition
class DeleteSecurityProfileRequestRequestTypeDef(TypedDict):
InstanceId: str,
SecurityProfileId: str,
DeleteTaskTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteTaskTemplateRequestRequestTypeDef
def get_value() -> DeleteTaskTemplateRequestRequestTypeDef:
return {
"InstanceId": ...,
"TaskTemplateId": ...,
}
Definition
class DeleteTaskTemplateRequestRequestTypeDef(TypedDict):
InstanceId: str,
TaskTemplateId: str,
DeleteTrafficDistributionGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteTrafficDistributionGroupRequestRequestTypeDef
def get_value() -> DeleteTrafficDistributionGroupRequestRequestTypeDef:
return {
"TrafficDistributionGroupId": ...,
}
Definition
class DeleteTrafficDistributionGroupRequestRequestTypeDef(TypedDict):
TrafficDistributionGroupId: str,
DeleteUseCaseRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteUseCaseRequestRequestTypeDef
def get_value() -> DeleteUseCaseRequestRequestTypeDef:
return {
"InstanceId": ...,
"IntegrationAssociationId": ...,
"UseCaseId": ...,
}
Definition
class DeleteUseCaseRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
UseCaseId: str,
DeleteUserHierarchyGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteUserHierarchyGroupRequestRequestTypeDef
def get_value() -> DeleteUserHierarchyGroupRequestRequestTypeDef:
return {
"HierarchyGroupId": ...,
"InstanceId": ...,
}
Definition
class DeleteUserHierarchyGroupRequestRequestTypeDef(TypedDict):
HierarchyGroupId: str,
InstanceId: str,
DeleteUserRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteUserRequestRequestTypeDef
def get_value() -> DeleteUserRequestRequestTypeDef:
return {
"InstanceId": ...,
"UserId": ...,
}
DeleteVocabularyRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteVocabularyRequestRequestTypeDef
def get_value() -> DeleteVocabularyRequestRequestTypeDef:
return {
"InstanceId": ...,
"VocabularyId": ...,
}
Definition
class DeleteVocabularyRequestRequestTypeDef(TypedDict):
InstanceId: str,
VocabularyId: str,
DescribeAgentStatusRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeAgentStatusRequestRequestTypeDef
def get_value() -> DescribeAgentStatusRequestRequestTypeDef:
return {
"InstanceId": ...,
"AgentStatusId": ...,
}
Definition
class DescribeAgentStatusRequestRequestTypeDef(TypedDict):
InstanceId: str,
AgentStatusId: str,
DescribeContactFlowModuleRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeContactFlowModuleRequestRequestTypeDef
def get_value() -> DescribeContactFlowModuleRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactFlowModuleId": ...,
}
Definition
class DescribeContactFlowModuleRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleId: str,
DescribeContactFlowRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeContactFlowRequestRequestTypeDef
def get_value() -> DescribeContactFlowRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactFlowId": ...,
}
Definition
class DescribeContactFlowRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,
DescribeContactRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeContactRequestRequestTypeDef
def get_value() -> DescribeContactRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
}
DescribeHoursOfOperationRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeHoursOfOperationRequestRequestTypeDef
def get_value() -> DescribeHoursOfOperationRequestRequestTypeDef:
return {
"InstanceId": ...,
"HoursOfOperationId": ...,
}
Definition
class DescribeHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
DescribeInstanceAttributeRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeInstanceAttributeRequestRequestTypeDef
def get_value() -> DescribeInstanceAttributeRequestRequestTypeDef:
return {
"InstanceId": ...,
"AttributeType": ...,
}
Definition
class DescribeInstanceAttributeRequestRequestTypeDef(TypedDict):
InstanceId: str,
AttributeType: InstanceAttributeTypeType, # (1)
DescribeInstanceRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeInstanceRequestRequestTypeDef
def get_value() -> DescribeInstanceRequestRequestTypeDef:
return {
"InstanceId": ...,
}
DescribeInstanceStorageConfigRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeInstanceStorageConfigRequestRequestTypeDef
def get_value() -> DescribeInstanceStorageConfigRequestRequestTypeDef:
return {
"InstanceId": ...,
"AssociationId": ...,
"ResourceType": ...,
}
Definition
class DescribeInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
DescribePhoneNumberRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribePhoneNumberRequestRequestTypeDef
def get_value() -> DescribePhoneNumberRequestRequestTypeDef:
return {
"PhoneNumberId": ...,
}
DescribeQueueRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeQueueRequestRequestTypeDef
def get_value() -> DescribeQueueRequestRequestTypeDef:
return {
"InstanceId": ...,
"QueueId": ...,
}
DescribeQuickConnectRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeQuickConnectRequestRequestTypeDef
def get_value() -> DescribeQuickConnectRequestRequestTypeDef:
return {
"InstanceId": ...,
"QuickConnectId": ...,
}
Definition
class DescribeQuickConnectRequestRequestTypeDef(TypedDict):
InstanceId: str,
QuickConnectId: str,
DescribeRoutingProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeRoutingProfileRequestRequestTypeDef
def get_value() -> DescribeRoutingProfileRequestRequestTypeDef:
return {
"InstanceId": ...,
"RoutingProfileId": ...,
}
Definition
class DescribeRoutingProfileRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
DescribeRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeRuleRequestRequestTypeDef
def get_value() -> DescribeRuleRequestRequestTypeDef:
return {
"InstanceId": ...,
"RuleId": ...,
}
DescribeSecurityProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeSecurityProfileRequestRequestTypeDef
def get_value() -> DescribeSecurityProfileRequestRequestTypeDef:
return {
"SecurityProfileId": ...,
"InstanceId": ...,
}
Definition
class DescribeSecurityProfileRequestRequestTypeDef(TypedDict):
SecurityProfileId: str,
InstanceId: str,
SecurityProfileTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SecurityProfileTypeDef
def get_value() -> SecurityProfileTypeDef:
return {
"Id": ...,
}
Definition
class SecurityProfileTypeDef(TypedDict):
Id: NotRequired[str],
OrganizationResourceId: NotRequired[str],
Arn: NotRequired[str],
SecurityProfileName: NotRequired[str],
Description: NotRequired[str],
Tags: NotRequired[Dict[str, str]],
AllowedAccessControlTags: NotRequired[Dict[str, str]],
TagRestrictedResources: NotRequired[List[str]],
DescribeTrafficDistributionGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeTrafficDistributionGroupRequestRequestTypeDef
def get_value() -> DescribeTrafficDistributionGroupRequestRequestTypeDef:
return {
"TrafficDistributionGroupId": ...,
}
Definition
class DescribeTrafficDistributionGroupRequestRequestTypeDef(TypedDict):
TrafficDistributionGroupId: str,
TrafficDistributionGroupTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TrafficDistributionGroupTypeDef
def get_value() -> TrafficDistributionGroupTypeDef:
return {
"Id": ...,
}
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]],
DescribeUserHierarchyGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeUserHierarchyGroupRequestRequestTypeDef
def get_value() -> DescribeUserHierarchyGroupRequestRequestTypeDef:
return {
"HierarchyGroupId": ...,
"InstanceId": ...,
}
Definition
class DescribeUserHierarchyGroupRequestRequestTypeDef(TypedDict):
HierarchyGroupId: str,
InstanceId: str,
DescribeUserHierarchyStructureRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeUserHierarchyStructureRequestRequestTypeDef
def get_value() -> DescribeUserHierarchyStructureRequestRequestTypeDef:
return {
"InstanceId": ...,
}
DescribeUserRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeUserRequestRequestTypeDef
def get_value() -> DescribeUserRequestRequestTypeDef:
return {
"UserId": ...,
"InstanceId": ...,
}
DescribeVocabularyRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeVocabularyRequestRequestTypeDef
def get_value() -> DescribeVocabularyRequestRequestTypeDef:
return {
"InstanceId": ...,
"VocabularyId": ...,
}
Definition
class DescribeVocabularyRequestRequestTypeDef(TypedDict):
InstanceId: str,
VocabularyId: str,
VocabularyTypeDef
Usage Example
from mypy_boto3_connect.type_defs import VocabularyTypeDef
def get_value() -> VocabularyTypeDef:
return {
"Name": ...,
"Id": ...,
"Arn": ...,
"LanguageCode": ...,
"State": ...,
"LastModifiedTime": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import RoutingProfileReferenceTypeDef
def get_value() -> RoutingProfileReferenceTypeDef:
return {
"Id": ...,
}
Definition
class RoutingProfileReferenceTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
DisassociateApprovedOriginRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DisassociateApprovedOriginRequestRequestTypeDef
def get_value() -> DisassociateApprovedOriginRequestRequestTypeDef:
return {
"InstanceId": ...,
"Origin": ...,
}
Definition
class DisassociateApprovedOriginRequestRequestTypeDef(TypedDict):
InstanceId: str,
Origin: str,
DisassociateInstanceStorageConfigRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DisassociateInstanceStorageConfigRequestRequestTypeDef
def get_value() -> DisassociateInstanceStorageConfigRequestRequestTypeDef:
return {
"InstanceId": ...,
"AssociationId": ...,
"ResourceType": ...,
}
Definition
class DisassociateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
DisassociateLambdaFunctionRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DisassociateLambdaFunctionRequestRequestTypeDef
def get_value() -> DisassociateLambdaFunctionRequestRequestTypeDef:
return {
"InstanceId": ...,
"FunctionArn": ...,
}
Definition
class DisassociateLambdaFunctionRequestRequestTypeDef(TypedDict):
InstanceId: str,
FunctionArn: str,
DisassociateLexBotRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DisassociateLexBotRequestRequestTypeDef
def get_value() -> DisassociateLexBotRequestRequestTypeDef:
return {
"InstanceId": ...,
"BotName": ...,
"LexRegion": ...,
}
Definition
class DisassociateLexBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
BotName: str,
LexRegion: str,
DisassociatePhoneNumberContactFlowRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DisassociatePhoneNumberContactFlowRequestRequestTypeDef
def get_value() -> DisassociatePhoneNumberContactFlowRequestRequestTypeDef:
return {
"PhoneNumberId": ...,
"InstanceId": ...,
}
Definition
class DisassociatePhoneNumberContactFlowRequestRequestTypeDef(TypedDict):
PhoneNumberId: str,
InstanceId: str,
DisassociateQueueQuickConnectsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DisassociateQueueQuickConnectsRequestRequestTypeDef
def get_value() -> DisassociateQueueQuickConnectsRequestRequestTypeDef:
return {
"InstanceId": ...,
"QueueId": ...,
"QuickConnectIds": ...,
}
Definition
class DisassociateQueueQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
QuickConnectIds: Sequence[str],
RoutingProfileQueueReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RoutingProfileQueueReferenceTypeDef
def get_value() -> RoutingProfileQueueReferenceTypeDef:
return {
"QueueId": ...,
"Channel": ...,
}
Definition
class RoutingProfileQueueReferenceTypeDef(TypedDict):
QueueId: str,
Channel: ChannelType, # (1)
- See ChannelType
DisassociateSecurityKeyRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DisassociateSecurityKeyRequestRequestTypeDef
def get_value() -> DisassociateSecurityKeyRequestRequestTypeDef:
return {
"InstanceId": ...,
"AssociationId": ...,
}
Definition
class DisassociateSecurityKeyRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,
DismissUserContactRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DismissUserContactRequestRequestTypeDef
def get_value() -> DismissUserContactRequestRequestTypeDef:
return {
"UserId": ...,
"InstanceId": ...,
"ContactId": ...,
}
Definition
class DismissUserContactRequestRequestTypeDef(TypedDict):
UserId: str,
InstanceId: str,
ContactId: str,
DistributionTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DistributionTypeDef
def get_value() -> DistributionTypeDef:
return {
"Region": ...,
"Percentage": ...,
}
EmailReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import EmailReferenceTypeDef
def get_value() -> EmailReferenceTypeDef:
return {
"Name": ...,
}
EncryptionConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import EncryptionConfigTypeDef
def get_value() -> EncryptionConfigTypeDef:
return {
"EncryptionType": ...,
"KeyId": ...,
}
Definition
class EncryptionConfigTypeDef(TypedDict):
EncryptionType: EncryptionTypeType, # (1)
KeyId: str,
EventBridgeActionDefinitionTypeDef
Usage Example
from mypy_boto3_connect.type_defs import EventBridgeActionDefinitionTypeDef
def get_value() -> EventBridgeActionDefinitionTypeDef:
return {
"Name": ...,
}
FilterV2TypeDef
Usage Example
from mypy_boto3_connect.type_defs import FilterV2TypeDef
def get_value() -> FilterV2TypeDef:
return {
"FilterKey": ...,
}
Definition
class FilterV2TypeDef(TypedDict):
FilterKey: NotRequired[str],
FilterValues: NotRequired[Sequence[str]],
FiltersTypeDef
Usage Example
from mypy_boto3_connect.type_defs import FiltersTypeDef
def get_value() -> FiltersTypeDef:
return {
"Queues": ...,
}
Definition
class FiltersTypeDef(TypedDict):
Queues: NotRequired[Sequence[str]],
Channels: NotRequired[Sequence[ChannelType]], # (1)
RoutingProfiles: NotRequired[Sequence[str]],
- See ChannelType
GetContactAttributesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetContactAttributesRequestRequestTypeDef
def get_value() -> GetContactAttributesRequestRequestTypeDef:
return {
"InstanceId": ...,
"InitialContactId": ...,
}
Definition
class GetContactAttributesRequestRequestTypeDef(TypedDict):
InstanceId: str,
InitialContactId: str,
GetFederationTokenRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetFederationTokenRequestRequestTypeDef
def get_value() -> GetFederationTokenRequestRequestTypeDef:
return {
"InstanceId": ...,
}
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
GetTaskTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetTaskTemplateRequestRequestTypeDef
def get_value() -> GetTaskTemplateRequestRequestTypeDef:
return {
"InstanceId": ...,
"TaskTemplateId": ...,
}
Definition
class GetTaskTemplateRequestRequestTypeDef(TypedDict):
InstanceId: str,
TaskTemplateId: str,
SnapshotVersion: NotRequired[str],
GetTrafficDistributionRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetTrafficDistributionRequestRequestTypeDef
def get_value() -> GetTrafficDistributionRequestRequestTypeDef:
return {
"Id": ...,
}
HierarchyGroupConditionTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HierarchyGroupConditionTypeDef
def get_value() -> HierarchyGroupConditionTypeDef:
return {
"Value": ...,
}
Definition
class HierarchyGroupConditionTypeDef(TypedDict):
Value: NotRequired[str],
HierarchyGroupMatchType: NotRequired[HierarchyGroupMatchTypeType], # (1)
HierarchyGroupSummaryReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HierarchyGroupSummaryReferenceTypeDef
def get_value() -> HierarchyGroupSummaryReferenceTypeDef:
return {
"Id": ...,
}
Definition
class HierarchyGroupSummaryReferenceTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
HierarchyGroupSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HierarchyGroupSummaryTypeDef
def get_value() -> HierarchyGroupSummaryTypeDef:
return {
"Id": ...,
}
Definition
class HierarchyGroupSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
HierarchyLevelTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HierarchyLevelTypeDef
def get_value() -> HierarchyLevelTypeDef:
return {
"Id": ...,
}
Definition
class HierarchyLevelTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
HierarchyLevelUpdateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HierarchyLevelUpdateTypeDef
def get_value() -> HierarchyLevelUpdateTypeDef:
return {
"Name": ...,
}
ThresholdTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ThresholdTypeDef
def get_value() -> ThresholdTypeDef:
return {
"Comparison": ...,
}
Definition
class ThresholdTypeDef(TypedDict):
Comparison: NotRequired[ComparisonType], # (1)
ThresholdValue: NotRequired[float],
- See ComparisonType
HoursOfOperationTimeSliceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HoursOfOperationTimeSliceTypeDef
def get_value() -> HoursOfOperationTimeSliceTypeDef:
return {
"Hours": ...,
"Minutes": ...,
}
HoursOfOperationSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HoursOfOperationSummaryTypeDef
def get_value() -> HoursOfOperationSummaryTypeDef:
return {
"Id": ...,
}
Definition
class HoursOfOperationSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
InstanceStatusReasonTypeDef
Usage Example
from mypy_boto3_connect.type_defs import InstanceStatusReasonTypeDef
def get_value() -> InstanceStatusReasonTypeDef:
return {
"Message": ...,
}
KinesisFirehoseConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import KinesisFirehoseConfigTypeDef
def get_value() -> KinesisFirehoseConfigTypeDef:
return {
"FirehoseArn": ...,
}
KinesisStreamConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import KinesisStreamConfigTypeDef
def get_value() -> KinesisStreamConfigTypeDef:
return {
"StreamArn": ...,
}
InstanceSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import InstanceSummaryTypeDef
def get_value() -> InstanceSummaryTypeDef:
return {
"Id": ...,
}
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],
- See DirectoryTypeType
- See InstanceStatusType
IntegrationAssociationSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import IntegrationAssociationSummaryTypeDef
def get_value() -> IntegrationAssociationSummaryTypeDef:
return {
"IntegrationAssociationId": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import TaskTemplateFieldIdentifierTypeDef
def get_value() -> TaskTemplateFieldIdentifierTypeDef:
return {
"Name": ...,
}
ListAgentStatusRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListAgentStatusRequestRequestTypeDef
def get_value() -> ListAgentStatusRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListAgentStatusRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
AgentStatusTypes: NotRequired[Sequence[AgentStatusTypeType]], # (1)
ListApprovedOriginsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListApprovedOriginsRequestRequestTypeDef
def get_value() -> ListApprovedOriginsRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListApprovedOriginsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListBotsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListBotsRequestRequestTypeDef
def get_value() -> ListBotsRequestRequestTypeDef:
return {
"InstanceId": ...,
"LexVersion": ...,
}
Definition
class ListBotsRequestRequestTypeDef(TypedDict):
InstanceId: str,
LexVersion: LexVersionType, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See LexVersionType
ListContactFlowModulesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListContactFlowModulesRequestRequestTypeDef
def get_value() -> ListContactFlowModulesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListContactFlowModulesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ContactFlowModuleState: NotRequired[ContactFlowModuleStateType], # (1)
ListContactFlowsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListContactFlowsRequestRequestTypeDef
def get_value() -> ListContactFlowsRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListContactFlowsRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowTypes: NotRequired[Sequence[ContactFlowTypeType]], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListContactReferencesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListContactReferencesRequestRequestTypeDef
def get_value() -> ListContactReferencesRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"ReferenceTypes": ...,
}
Definition
class ListContactReferencesRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ReferenceTypes: Sequence[ReferenceTypeType], # (1)
NextToken: NotRequired[str],
ListDefaultVocabulariesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListDefaultVocabulariesRequestRequestTypeDef
def get_value() -> ListDefaultVocabulariesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListDefaultVocabulariesRequestRequestTypeDef(TypedDict):
InstanceId: str,
LanguageCode: NotRequired[VocabularyLanguageCodeType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListHoursOfOperationsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListHoursOfOperationsRequestRequestTypeDef
def get_value() -> ListHoursOfOperationsRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListHoursOfOperationsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListInstanceAttributesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListInstanceAttributesRequestRequestTypeDef
def get_value() -> ListInstanceAttributesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListInstanceAttributesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListInstanceStorageConfigsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListInstanceStorageConfigsRequestRequestTypeDef
def get_value() -> ListInstanceStorageConfigsRequestRequestTypeDef:
return {
"InstanceId": ...,
"ResourceType": ...,
}
Definition
class ListInstanceStorageConfigsRequestRequestTypeDef(TypedDict):
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListInstancesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListInstancesRequestRequestTypeDef
def get_value() -> ListInstancesRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListInstancesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListIntegrationAssociationsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListIntegrationAssociationsRequestRequestTypeDef
def get_value() -> ListIntegrationAssociationsRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListIntegrationAssociationsRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationType: NotRequired[IntegrationTypeType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListLambdaFunctionsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListLambdaFunctionsRequestRequestTypeDef
def get_value() -> ListLambdaFunctionsRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListLambdaFunctionsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListLexBotsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListLexBotsRequestRequestTypeDef
def get_value() -> ListLexBotsRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListLexBotsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListPhoneNumbersRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListPhoneNumbersRequestRequestTypeDef
def get_value() -> ListPhoneNumbersRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListPhoneNumbersRequestRequestTypeDef(TypedDict):
InstanceId: str,
PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]], # (1)
PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]], # (2)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PhoneNumberSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import PhoneNumberSummaryTypeDef
def get_value() -> PhoneNumberSummaryTypeDef:
return {
"Id": ...,
}
Definition
class PhoneNumberSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
PhoneNumber: NotRequired[str],
PhoneNumberType: NotRequired[PhoneNumberTypeType], # (1)
PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType], # (2)
ListPhoneNumbersSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListPhoneNumbersSummaryTypeDef
def get_value() -> ListPhoneNumbersSummaryTypeDef:
return {
"PhoneNumberId": ...,
}
Definition
class ListPhoneNumbersSummaryTypeDef(TypedDict):
PhoneNumberId: NotRequired[str],
PhoneNumberArn: NotRequired[str],
PhoneNumber: NotRequired[str],
PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType], # (1)
PhoneNumberType: NotRequired[PhoneNumberTypeType], # (2)
TargetArn: NotRequired[str],
ListPhoneNumbersV2RequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListPhoneNumbersV2RequestRequestTypeDef
def get_value() -> ListPhoneNumbersV2RequestRequestTypeDef:
return {
"TargetArn": ...,
}
Definition
class ListPhoneNumbersV2RequestRequestTypeDef(TypedDict):
TargetArn: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]], # (1)
PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]], # (2)
PhoneNumberPrefix: NotRequired[str],
ListPromptsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListPromptsRequestRequestTypeDef
def get_value() -> ListPromptsRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListPromptsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PromptSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import PromptSummaryTypeDef
def get_value() -> PromptSummaryTypeDef:
return {
"Id": ...,
}
Definition
class PromptSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
ListQueueQuickConnectsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListQueueQuickConnectsRequestRequestTypeDef
def get_value() -> ListQueueQuickConnectsRequestRequestTypeDef:
return {
"InstanceId": ...,
"QueueId": ...,
}
Definition
class ListQueueQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
QuickConnectSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import QuickConnectSummaryTypeDef
def get_value() -> QuickConnectSummaryTypeDef:
return {
"Id": ...,
}
Definition
class QuickConnectSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
QuickConnectType: NotRequired[QuickConnectTypeType], # (1)
ListQueuesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListQueuesRequestRequestTypeDef
def get_value() -> ListQueuesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueTypes: NotRequired[Sequence[QueueTypeType]], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See QueueTypeType
QueueSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import QueueSummaryTypeDef
def get_value() -> QueueSummaryTypeDef:
return {
"Id": ...,
}
Definition
class QueueSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
QueueType: NotRequired[QueueTypeType], # (1)
- See QueueTypeType
ListQuickConnectsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListQuickConnectsRequestRequestTypeDef
def get_value() -> ListQuickConnectsRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListQuickConnectsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
QuickConnectTypes: NotRequired[Sequence[QuickConnectTypeType]], # (1)
ListRoutingProfileQueuesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListRoutingProfileQueuesRequestRequestTypeDef
def get_value() -> ListRoutingProfileQueuesRequestRequestTypeDef:
return {
"InstanceId": ...,
"RoutingProfileId": ...,
}
Definition
class ListRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
RoutingProfileQueueConfigSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RoutingProfileQueueConfigSummaryTypeDef
def get_value() -> RoutingProfileQueueConfigSummaryTypeDef:
return {
"QueueId": ...,
"QueueArn": ...,
"QueueName": ...,
"Priority": ...,
"Delay": ...,
"Channel": ...,
}
Definition
class RoutingProfileQueueConfigSummaryTypeDef(TypedDict):
QueueId: str,
QueueArn: str,
QueueName: str,
Priority: int,
Delay: int,
Channel: ChannelType, # (1)
- See ChannelType
ListRoutingProfilesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListRoutingProfilesRequestRequestTypeDef
def get_value() -> ListRoutingProfilesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListRoutingProfilesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
RoutingProfileSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RoutingProfileSummaryTypeDef
def get_value() -> RoutingProfileSummaryTypeDef:
return {
"Id": ...,
}
Definition
class RoutingProfileSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
ListRulesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListRulesRequestRequestTypeDef
def get_value() -> ListRulesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListRulesRequestRequestTypeDef(TypedDict):
InstanceId: str,
PublishStatus: NotRequired[RulePublishStatusType], # (1)
EventSourceName: NotRequired[EventSourceNameType], # (2)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListSecurityKeysRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListSecurityKeysRequestRequestTypeDef
def get_value() -> ListSecurityKeysRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListSecurityKeysRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SecurityKeyTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SecurityKeyTypeDef
def get_value() -> SecurityKeyTypeDef:
return {
"AssociationId": ...,
}
Definition
class SecurityKeyTypeDef(TypedDict):
AssociationId: NotRequired[str],
Key: NotRequired[str],
CreationTime: NotRequired[datetime],
ListSecurityProfilePermissionsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListSecurityProfilePermissionsRequestRequestTypeDef
def get_value() -> ListSecurityProfilePermissionsRequestRequestTypeDef:
return {
"SecurityProfileId": ...,
"InstanceId": ...,
}
Definition
class ListSecurityProfilePermissionsRequestRequestTypeDef(TypedDict):
SecurityProfileId: str,
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListSecurityProfilesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListSecurityProfilesRequestRequestTypeDef
def get_value() -> ListSecurityProfilesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListSecurityProfilesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SecurityProfileSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SecurityProfileSummaryTypeDef
def get_value() -> SecurityProfileSummaryTypeDef:
return {
"Id": ...,
}
Definition
class SecurityProfileSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
ListTaskTemplatesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListTaskTemplatesRequestRequestTypeDef
def get_value() -> ListTaskTemplatesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListTaskTemplatesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Status: NotRequired[TaskTemplateStatusType], # (1)
Name: NotRequired[str],
TaskTemplateMetadataTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TaskTemplateMetadataTypeDef
def get_value() -> TaskTemplateMetadataTypeDef:
return {
"Id": ...,
}
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],
ListTrafficDistributionGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListTrafficDistributionGroupsRequestRequestTypeDef
def get_value() -> ListTrafficDistributionGroupsRequestRequestTypeDef:
return {
"MaxResults": ...,
}
Definition
class ListTrafficDistributionGroupsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
InstanceId: NotRequired[str],
TrafficDistributionGroupSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TrafficDistributionGroupSummaryTypeDef
def get_value() -> TrafficDistributionGroupSummaryTypeDef:
return {
"Id": ...,
}
Definition
class TrafficDistributionGroupSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
InstanceArn: NotRequired[str],
Status: NotRequired[TrafficDistributionGroupStatusType], # (1)
ListUseCasesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListUseCasesRequestRequestTypeDef
def get_value() -> ListUseCasesRequestRequestTypeDef:
return {
"InstanceId": ...,
"IntegrationAssociationId": ...,
}
Definition
class ListUseCasesRequestRequestTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
UseCaseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UseCaseTypeDef
def get_value() -> UseCaseTypeDef:
return {
"UseCaseId": ...,
}
Definition
class UseCaseTypeDef(TypedDict):
UseCaseId: NotRequired[str],
UseCaseArn: NotRequired[str],
UseCaseType: NotRequired[UseCaseTypeType], # (1)
- See UseCaseTypeType
ListUserHierarchyGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListUserHierarchyGroupsRequestRequestTypeDef
def get_value() -> ListUserHierarchyGroupsRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListUserHierarchyGroupsRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListUsersRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListUsersRequestRequestTypeDef
def get_value() -> ListUsersRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListUsersRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
UserSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserSummaryTypeDef
def get_value() -> UserSummaryTypeDef:
return {
"Id": ...,
}
Definition
class UserSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Username: NotRequired[str],
MetricFilterV2TypeDef
Usage Example
from mypy_boto3_connect.type_defs import MetricFilterV2TypeDef
def get_value() -> MetricFilterV2TypeDef:
return {
"MetricFilterKey": ...,
}
Definition
class MetricFilterV2TypeDef(TypedDict):
MetricFilterKey: NotRequired[str],
MetricFilterValues: NotRequired[Sequence[str]],
ThresholdV2TypeDef
Usage Example
from mypy_boto3_connect.type_defs import ThresholdV2TypeDef
def get_value() -> ThresholdV2TypeDef:
return {
"Comparison": ...,
}
Definition
class ThresholdV2TypeDef(TypedDict):
Comparison: NotRequired[str],
ThresholdValue: NotRequired[float],
MonitorContactRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import MonitorContactRequestRequestTypeDef
def get_value() -> MonitorContactRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"UserId": ...,
}
Definition
class MonitorContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
UserId: str,
AllowedMonitorCapabilities: NotRequired[Sequence[MonitorCapabilityType]], # (1)
ClientToken: NotRequired[str],
NotificationRecipientTypeTypeDef
Usage Example
from mypy_boto3_connect.type_defs import NotificationRecipientTypeTypeDef
def get_value() -> NotificationRecipientTypeTypeDef:
return {
"UserTags": ...,
}
Definition
class NotificationRecipientTypeTypeDef(TypedDict):
UserTags: NotRequired[Mapping[str, str]],
UserIds: NotRequired[Sequence[str]],
NumberReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import NumberReferenceTypeDef
def get_value() -> NumberReferenceTypeDef:
return {
"Name": ...,
}
ParticipantDetailsTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ParticipantDetailsTypeDef
def get_value() -> ParticipantDetailsTypeDef:
return {
"DisplayName": ...,
}
ParticipantTimerValueTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ParticipantTimerValueTypeDef
def get_value() -> ParticipantTimerValueTypeDef:
return {
"ParticipantTimerAction": ...,
}
Definition
class ParticipantTimerValueTypeDef(TypedDict):
ParticipantTimerAction: NotRequired[ParticipantTimerActionType], # (1)
ParticipantTimerDurationInMinutes: NotRequired[int],
PersistentChatTypeDef
Usage Example
from mypy_boto3_connect.type_defs import PersistentChatTypeDef
def get_value() -> PersistentChatTypeDef:
return {
"RehydrationType": ...,
}
Definition
class PersistentChatTypeDef(TypedDict):
RehydrationType: NotRequired[RehydrationTypeType], # (1)
SourceContactId: NotRequired[str],
PhoneNumberQuickConnectConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import PhoneNumberQuickConnectConfigTypeDef
def get_value() -> PhoneNumberQuickConnectConfigTypeDef:
return {
"PhoneNumber": ...,
}
PutUserStatusRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import PutUserStatusRequestRequestTypeDef
def get_value() -> PutUserStatusRequestRequestTypeDef:
return {
"UserId": ...,
"InstanceId": ...,
"AgentStatusId": ...,
}
Definition
class PutUserStatusRequestRequestTypeDef(TypedDict):
UserId: str,
InstanceId: str,
AgentStatusId: str,
QueueQuickConnectConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import QueueQuickConnectConfigTypeDef
def get_value() -> QueueQuickConnectConfigTypeDef:
return {
"QueueId": ...,
"ContactFlowId": ...,
}
StringConditionTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StringConditionTypeDef
def get_value() -> StringConditionTypeDef:
return {
"FieldName": ...,
}
Definition
class StringConditionTypeDef(TypedDict):
FieldName: NotRequired[str],
Value: NotRequired[str],
ComparisonType: NotRequired[StringComparisonTypeType], # (1)
UserQuickConnectConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserQuickConnectConfigTypeDef
def get_value() -> UserQuickConnectConfigTypeDef:
return {
"UserId": ...,
"ContactFlowId": ...,
}
StringReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StringReferenceTypeDef
def get_value() -> StringReferenceTypeDef:
return {
"Name": ...,
}
UrlReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UrlReferenceTypeDef
def get_value() -> UrlReferenceTypeDef:
return {
"Name": ...,
}
ReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ReferenceTypeDef
def get_value() -> ReferenceTypeDef:
return {
"Value": ...,
"Type": ...,
}
ReleasePhoneNumberRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ReleasePhoneNumberRequestRequestTypeDef
def get_value() -> ReleasePhoneNumberRequestRequestTypeDef:
return {
"PhoneNumberId": ...,
}
Definition
class ReleasePhoneNumberRequestRequestTypeDef(TypedDict):
PhoneNumberId: str,
ClientToken: NotRequired[str],
ReplicateInstanceRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ReplicateInstanceRequestRequestTypeDef
def get_value() -> ReplicateInstanceRequestRequestTypeDef:
return {
"InstanceId": ...,
"ReplicaRegion": ...,
"ReplicaAlias": ...,
}
Definition
class ReplicateInstanceRequestRequestTypeDef(TypedDict):
InstanceId: str,
ReplicaRegion: str,
ReplicaAlias: str,
ClientToken: NotRequired[str],
ResumeContactRecordingRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ResumeContactRecordingRequestRequestTypeDef
def get_value() -> ResumeContactRecordingRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"InitialContactId": ...,
}
Definition
class ResumeContactRecordingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
InitialContactId: str,
SearchAvailablePhoneNumbersRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchAvailablePhoneNumbersRequestRequestTypeDef
def get_value() -> SearchAvailablePhoneNumbersRequestRequestTypeDef:
return {
"TargetArn": ...,
"PhoneNumberCountryCode": ...,
"PhoneNumberType": ...,
}
Definition
class SearchAvailablePhoneNumbersRequestRequestTypeDef(TypedDict):
TargetArn: str,
PhoneNumberCountryCode: PhoneNumberCountryCodeType, # (1)
PhoneNumberType: PhoneNumberTypeType, # (2)
PhoneNumberPrefix: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SecurityProfileSearchSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SecurityProfileSearchSummaryTypeDef
def get_value() -> SecurityProfileSearchSummaryTypeDef:
return {
"Id": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import SearchVocabulariesRequestRequestTypeDef
def get_value() -> SearchVocabulariesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class SearchVocabulariesRequestRequestTypeDef(TypedDict):
InstanceId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
State: NotRequired[VocabularyStateType], # (1)
NameStartsWith: NotRequired[str],
LanguageCode: NotRequired[VocabularyLanguageCodeType], # (2)
VocabularySummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import VocabularySummaryTypeDef
def get_value() -> VocabularySummaryTypeDef:
return {
"Name": ...,
"Id": ...,
"Arn": ...,
"LanguageCode": ...,
"State": ...,
"LastModifiedTime": ...,
}
Definition
class VocabularySummaryTypeDef(TypedDict):
Name: str,
Id: str,
Arn: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
State: VocabularyStateType, # (2)
LastModifiedTime: datetime,
FailureReason: NotRequired[str],
VoiceRecordingConfigurationTypeDef
Usage Example
from mypy_boto3_connect.type_defs import VoiceRecordingConfigurationTypeDef
def get_value() -> VoiceRecordingConfigurationTypeDef:
return {
"VoiceRecordingTrack": ...,
}
Definition
class VoiceRecordingConfigurationTypeDef(TypedDict):
VoiceRecordingTrack: NotRequired[VoiceRecordingTrackType], # (1)
StopContactRecordingRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StopContactRecordingRequestRequestTypeDef
def get_value() -> StopContactRecordingRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"InitialContactId": ...,
}
Definition
class StopContactRecordingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
InitialContactId: str,
StopContactRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StopContactRequestRequestTypeDef
def get_value() -> StopContactRequestRequestTypeDef:
return {
"ContactId": ...,
"InstanceId": ...,
}
StopContactStreamingRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StopContactStreamingRequestRequestTypeDef
def get_value() -> StopContactStreamingRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"StreamingId": ...,
}
Definition
class StopContactStreamingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
StreamingId: str,
SuspendContactRecordingRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SuspendContactRecordingRequestRequestTypeDef
def get_value() -> SuspendContactRecordingRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"InitialContactId": ...,
}
Definition
class SuspendContactRecordingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
InitialContactId: str,
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
TransferContactRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TransferContactRequestRequestTypeDef
def get_value() -> TransferContactRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"ContactFlowId": ...,
}
Definition
class TransferContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ContactFlowId: str,
QueueId: NotRequired[str],
UserId: NotRequired[str],
ClientToken: NotRequired[str],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateAgentStatusRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateAgentStatusRequestRequestTypeDef
def get_value() -> UpdateAgentStatusRequestRequestTypeDef:
return {
"InstanceId": ...,
"AgentStatusId": ...,
}
Definition
class UpdateAgentStatusRequestRequestTypeDef(TypedDict):
InstanceId: str,
AgentStatusId: str,
Name: NotRequired[str],
Description: NotRequired[str],
State: NotRequired[AgentStatusStateType], # (1)
DisplayOrder: NotRequired[int],
ResetOrderNumber: NotRequired[bool],
UpdateContactAttributesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateContactAttributesRequestRequestTypeDef
def get_value() -> UpdateContactAttributesRequestRequestTypeDef:
return {
"InitialContactId": ...,
"InstanceId": ...,
"Attributes": ...,
}
Definition
class UpdateContactAttributesRequestRequestTypeDef(TypedDict):
InitialContactId: str,
InstanceId: str,
Attributes: Mapping[str, str],
UpdateContactFlowContentRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateContactFlowContentRequestRequestTypeDef
def get_value() -> UpdateContactFlowContentRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactFlowId": ...,
"Content": ...,
}
Definition
class UpdateContactFlowContentRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,
Content: str,
UpdateContactFlowMetadataRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateContactFlowMetadataRequestRequestTypeDef
def get_value() -> UpdateContactFlowMetadataRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactFlowId": ...,
}
Definition
class UpdateContactFlowMetadataRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,
Name: NotRequired[str],
Description: NotRequired[str],
ContactFlowState: NotRequired[ContactFlowStateType], # (1)
UpdateContactFlowModuleContentRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateContactFlowModuleContentRequestRequestTypeDef
def get_value() -> UpdateContactFlowModuleContentRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactFlowModuleId": ...,
"Content": ...,
}
Definition
class UpdateContactFlowModuleContentRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleId: str,
Content: str,
UpdateContactFlowModuleMetadataRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateContactFlowModuleMetadataRequestRequestTypeDef
def get_value() -> UpdateContactFlowModuleMetadataRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactFlowModuleId": ...,
}
Definition
class UpdateContactFlowModuleMetadataRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleId: str,
Name: NotRequired[str],
Description: NotRequired[str],
State: NotRequired[ContactFlowModuleStateType], # (1)
UpdateContactFlowNameRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateContactFlowNameRequestRequestTypeDef
def get_value() -> UpdateContactFlowNameRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactFlowId": ...,
}
Definition
class UpdateContactFlowNameRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactFlowId: str,
Name: NotRequired[str],
Description: NotRequired[str],
UpdateContactScheduleRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateContactScheduleRequestRequestTypeDef
def get_value() -> UpdateContactScheduleRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"ScheduledTime": ...,
}
Definition
class UpdateContactScheduleRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ScheduledTime: Union[datetime, str],
UpdateInstanceAttributeRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateInstanceAttributeRequestRequestTypeDef
def get_value() -> UpdateInstanceAttributeRequestRequestTypeDef:
return {
"InstanceId": ...,
"AttributeType": ...,
"Value": ...,
}
Definition
class UpdateInstanceAttributeRequestRequestTypeDef(TypedDict):
InstanceId: str,
AttributeType: InstanceAttributeTypeType, # (1)
Value: str,
UpdatePhoneNumberRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdatePhoneNumberRequestRequestTypeDef
def get_value() -> UpdatePhoneNumberRequestRequestTypeDef:
return {
"PhoneNumberId": ...,
"TargetArn": ...,
}
Definition
class UpdatePhoneNumberRequestRequestTypeDef(TypedDict):
PhoneNumberId: str,
TargetArn: str,
ClientToken: NotRequired[str],
UpdateQueueHoursOfOperationRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateQueueHoursOfOperationRequestRequestTypeDef
def get_value() -> UpdateQueueHoursOfOperationRequestRequestTypeDef:
return {
"InstanceId": ...,
"QueueId": ...,
"HoursOfOperationId": ...,
}
Definition
class UpdateQueueHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
HoursOfOperationId: str,
UpdateQueueMaxContactsRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateQueueMaxContactsRequestRequestTypeDef
def get_value() -> UpdateQueueMaxContactsRequestRequestTypeDef:
return {
"InstanceId": ...,
"QueueId": ...,
}
Definition
class UpdateQueueMaxContactsRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
MaxContacts: NotRequired[int],
UpdateQueueNameRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateQueueNameRequestRequestTypeDef
def get_value() -> UpdateQueueNameRequestRequestTypeDef:
return {
"InstanceId": ...,
"QueueId": ...,
}
Definition
class UpdateQueueNameRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
Name: NotRequired[str],
Description: NotRequired[str],
UpdateQueueStatusRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateQueueStatusRequestRequestTypeDef
def get_value() -> UpdateQueueStatusRequestRequestTypeDef:
return {
"InstanceId": ...,
"QueueId": ...,
"Status": ...,
}
Definition
class UpdateQueueStatusRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
Status: QueueStatusType, # (1)
- See QueueStatusType
UpdateQuickConnectNameRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateQuickConnectNameRequestRequestTypeDef
def get_value() -> UpdateQuickConnectNameRequestRequestTypeDef:
return {
"InstanceId": ...,
"QuickConnectId": ...,
}
Definition
class UpdateQuickConnectNameRequestRequestTypeDef(TypedDict):
InstanceId: str,
QuickConnectId: str,
Name: NotRequired[str],
Description: NotRequired[str],
UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef
def get_value() -> UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef:
return {
"InstanceId": ...,
"RoutingProfileId": ...,
"DefaultOutboundQueueId": ...,
}
Definition
class UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
DefaultOutboundQueueId: str,
UpdateRoutingProfileNameRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateRoutingProfileNameRequestRequestTypeDef
def get_value() -> UpdateRoutingProfileNameRequestRequestTypeDef:
return {
"InstanceId": ...,
"RoutingProfileId": ...,
}
Definition
class UpdateRoutingProfileNameRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
Name: NotRequired[str],
Description: NotRequired[str],
UpdateSecurityProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateSecurityProfileRequestRequestTypeDef
def get_value() -> UpdateSecurityProfileRequestRequestTypeDef:
return {
"SecurityProfileId": ...,
"InstanceId": ...,
}
Definition
class UpdateSecurityProfileRequestRequestTypeDef(TypedDict):
SecurityProfileId: str,
InstanceId: str,
Description: NotRequired[str],
Permissions: NotRequired[Sequence[str]],
AllowedAccessControlTags: NotRequired[Mapping[str, str]],
TagRestrictedResources: NotRequired[Sequence[str]],
UpdateUserHierarchyGroupNameRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateUserHierarchyGroupNameRequestRequestTypeDef
def get_value() -> UpdateUserHierarchyGroupNameRequestRequestTypeDef:
return {
"Name": ...,
"HierarchyGroupId": ...,
"InstanceId": ...,
}
Definition
class UpdateUserHierarchyGroupNameRequestRequestTypeDef(TypedDict):
Name: str,
HierarchyGroupId: str,
InstanceId: str,
UpdateUserHierarchyRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateUserHierarchyRequestRequestTypeDef
def get_value() -> UpdateUserHierarchyRequestRequestTypeDef:
return {
"UserId": ...,
"InstanceId": ...,
}
Definition
class UpdateUserHierarchyRequestRequestTypeDef(TypedDict):
UserId: str,
InstanceId: str,
HierarchyGroupId: NotRequired[str],
UpdateUserRoutingProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateUserRoutingProfileRequestRequestTypeDef
def get_value() -> UpdateUserRoutingProfileRequestRequestTypeDef:
return {
"RoutingProfileId": ...,
"UserId": ...,
"InstanceId": ...,
}
Definition
class UpdateUserRoutingProfileRequestRequestTypeDef(TypedDict):
RoutingProfileId: str,
UserId: str,
InstanceId: str,
UpdateUserSecurityProfilesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateUserSecurityProfilesRequestRequestTypeDef
def get_value() -> UpdateUserSecurityProfilesRequestRequestTypeDef:
return {
"SecurityProfileIds": ...,
"UserId": ...,
"InstanceId": ...,
}
Definition
class UpdateUserSecurityProfilesRequestRequestTypeDef(TypedDict):
SecurityProfileIds: Sequence[str],
UserId: str,
InstanceId: str,
UserReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserReferenceTypeDef
def get_value() -> UserReferenceTypeDef:
return {
"Id": ...,
}
UserIdentityInfoLiteTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserIdentityInfoLiteTypeDef
def get_value() -> UserIdentityInfoLiteTypeDef:
return {
"FirstName": ...,
}
Definition
class UserIdentityInfoLiteTypeDef(TypedDict):
FirstName: NotRequired[str],
LastName: NotRequired[str],
RuleSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RuleSummaryTypeDef
def get_value() -> RuleSummaryTypeDef:
return {
"Name": ...,
"RuleId": ...,
"RuleArn": ...,
"EventSourceName": ...,
"PublishStatus": ...,
"ActionSummaries": ...,
"CreatedTime": ...,
"LastUpdatedTime": ...,
}
Definition
class RuleSummaryTypeDef(TypedDict):
Name: str,
RuleId: str,
RuleArn: str,
EventSourceName: EventSourceNameType, # (1)
PublishStatus: RulePublishStatusType, # (2)
ActionSummaries: List[ActionSummaryTypeDef], # (3)
CreatedTime: datetime,
LastUpdatedTime: datetime,
AgentContactReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AgentContactReferenceTypeDef
def get_value() -> AgentContactReferenceTypeDef:
return {
"ContactId": ...,
}
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
StartOutboundVoiceContactRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StartOutboundVoiceContactRequestRequestTypeDef
def get_value() -> StartOutboundVoiceContactRequestRequestTypeDef:
return {
"DestinationPhoneNumber": ...,
"ContactFlowId": ...,
"InstanceId": ...,
}
Definition
class StartOutboundVoiceContactRequestRequestTypeDef(TypedDict):
DestinationPhoneNumber: str,
ContactFlowId: str,
InstanceId: str,
ClientToken: NotRequired[str],
SourcePhoneNumber: NotRequired[str],
QueueId: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
AnswerMachineDetectionConfig: NotRequired[AnswerMachineDetectionConfigTypeDef], # (1)
CampaignId: NotRequired[str],
TrafficType: NotRequired[TrafficTypeType], # (2)
AssociateLexBotRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociateLexBotRequestRequestTypeDef
def get_value() -> AssociateLexBotRequestRequestTypeDef:
return {
"InstanceId": ...,
"LexBot": ...,
}
Definition
class AssociateLexBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
LexBot: LexBotTypeDef, # (1)
- See LexBotTypeDef
AssociateBotRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociateBotRequestRequestTypeDef
def get_value() -> AssociateBotRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class AssociateBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
LexBot: NotRequired[LexBotTypeDef], # (1)
LexV2Bot: NotRequired[LexV2BotTypeDef], # (2)
- See LexBotTypeDef
- See LexV2BotTypeDef
DisassociateBotRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DisassociateBotRequestRequestTypeDef
def get_value() -> DisassociateBotRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class DisassociateBotRequestRequestTypeDef(TypedDict):
InstanceId: str,
LexBot: NotRequired[LexBotTypeDef], # (1)
LexV2Bot: NotRequired[LexV2BotTypeDef], # (2)
- See LexBotTypeDef
- See LexV2BotTypeDef
LexBotConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import LexBotConfigTypeDef
def get_value() -> LexBotConfigTypeDef:
return {
"LexBot": ...,
}
Definition
class LexBotConfigTypeDef(TypedDict):
LexBot: NotRequired[LexBotTypeDef], # (1)
LexV2Bot: NotRequired[LexV2BotTypeDef], # (2)
- See LexBotTypeDef
- See LexV2BotTypeDef
AssociateInstanceStorageConfigResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociateInstanceStorageConfigResponseTypeDef
def get_value() -> AssociateInstanceStorageConfigResponseTypeDef:
return {
"AssociationId": ...,
"ResponseMetadata": ...,
}
Definition
class AssociateInstanceStorageConfigResponseTypeDef(TypedDict):
AssociationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AssociateSecurityKeyResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociateSecurityKeyResponseTypeDef
def get_value() -> AssociateSecurityKeyResponseTypeDef:
return {
"AssociationId": ...,
"ResponseMetadata": ...,
}
Definition
class AssociateSecurityKeyResponseTypeDef(TypedDict):
AssociationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ClaimPhoneNumberResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ClaimPhoneNumberResponseTypeDef
def get_value() -> ClaimPhoneNumberResponseTypeDef:
return {
"PhoneNumberId": ...,
"PhoneNumberArn": ...,
"ResponseMetadata": ...,
}
Definition
class ClaimPhoneNumberResponseTypeDef(TypedDict):
PhoneNumberId: str,
PhoneNumberArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAgentStatusResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateAgentStatusResponseTypeDef
def get_value() -> CreateAgentStatusResponseTypeDef:
return {
"AgentStatusARN": ...,
"AgentStatusId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateAgentStatusResponseTypeDef(TypedDict):
AgentStatusARN: str,
AgentStatusId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateContactFlowModuleResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateContactFlowModuleResponseTypeDef
def get_value() -> CreateContactFlowModuleResponseTypeDef:
return {
"Id": ...,
"Arn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateContactFlowModuleResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateContactFlowResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateContactFlowResponseTypeDef
def get_value() -> CreateContactFlowResponseTypeDef:
return {
"ContactFlowId": ...,
"ContactFlowArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateContactFlowResponseTypeDef(TypedDict):
ContactFlowId: str,
ContactFlowArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateHoursOfOperationResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateHoursOfOperationResponseTypeDef
def get_value() -> CreateHoursOfOperationResponseTypeDef:
return {
"HoursOfOperationId": ...,
"HoursOfOperationArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateHoursOfOperationResponseTypeDef(TypedDict):
HoursOfOperationId: str,
HoursOfOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateInstanceResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateInstanceResponseTypeDef
def get_value() -> CreateInstanceResponseTypeDef:
return {
"Id": ...,
"Arn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateInstanceResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateIntegrationAssociationResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateIntegrationAssociationResponseTypeDef
def get_value() -> CreateIntegrationAssociationResponseTypeDef:
return {
"IntegrationAssociationId": ...,
"IntegrationAssociationArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateIntegrationAssociationResponseTypeDef(TypedDict):
IntegrationAssociationId: str,
IntegrationAssociationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateQueueResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateQueueResponseTypeDef
def get_value() -> CreateQueueResponseTypeDef:
return {
"QueueArn": ...,
"QueueId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateQueueResponseTypeDef(TypedDict):
QueueArn: str,
QueueId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateQuickConnectResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateQuickConnectResponseTypeDef
def get_value() -> CreateQuickConnectResponseTypeDef:
return {
"QuickConnectARN": ...,
"QuickConnectId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateQuickConnectResponseTypeDef(TypedDict):
QuickConnectARN: str,
QuickConnectId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateRoutingProfileResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateRoutingProfileResponseTypeDef
def get_value() -> CreateRoutingProfileResponseTypeDef:
return {
"RoutingProfileArn": ...,
"RoutingProfileId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateRoutingProfileResponseTypeDef(TypedDict):
RoutingProfileArn: str,
RoutingProfileId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateRuleResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateRuleResponseTypeDef
def get_value() -> CreateRuleResponseTypeDef:
return {
"RuleArn": ...,
"RuleId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateRuleResponseTypeDef(TypedDict):
RuleArn: str,
RuleId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateSecurityProfileResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateSecurityProfileResponseTypeDef
def get_value() -> CreateSecurityProfileResponseTypeDef:
return {
"SecurityProfileId": ...,
"SecurityProfileArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateSecurityProfileResponseTypeDef(TypedDict):
SecurityProfileId: str,
SecurityProfileArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTaskTemplateResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateTaskTemplateResponseTypeDef
def get_value() -> CreateTaskTemplateResponseTypeDef:
return {
"Id": ...,
"Arn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateTaskTemplateResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTrafficDistributionGroupResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateTrafficDistributionGroupResponseTypeDef
def get_value() -> CreateTrafficDistributionGroupResponseTypeDef:
return {
"Id": ...,
"Arn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateTrafficDistributionGroupResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUseCaseResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateUseCaseResponseTypeDef
def get_value() -> CreateUseCaseResponseTypeDef:
return {
"UseCaseId": ...,
"UseCaseArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateUseCaseResponseTypeDef(TypedDict):
UseCaseId: str,
UseCaseArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUserHierarchyGroupResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateUserHierarchyGroupResponseTypeDef
def get_value() -> CreateUserHierarchyGroupResponseTypeDef:
return {
"HierarchyGroupId": ...,
"HierarchyGroupArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateUserHierarchyGroupResponseTypeDef(TypedDict):
HierarchyGroupId: str,
HierarchyGroupArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUserResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateUserResponseTypeDef
def get_value() -> CreateUserResponseTypeDef:
return {
"UserId": ...,
"UserArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateUserResponseTypeDef(TypedDict):
UserId: str,
UserArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateVocabularyResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateVocabularyResponseTypeDef
def get_value() -> CreateVocabularyResponseTypeDef:
return {
"VocabularyArn": ...,
"VocabularyId": ...,
"State": ...,
"ResponseMetadata": ...,
}
Definition
class CreateVocabularyResponseTypeDef(TypedDict):
VocabularyArn: str,
VocabularyId: str,
State: VocabularyStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteVocabularyResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DeleteVocabularyResponseTypeDef
def get_value() -> DeleteVocabularyResponseTypeDef:
return {
"VocabularyArn": ...,
"VocabularyId": ...,
"State": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteVocabularyResponseTypeDef(TypedDict):
VocabularyArn: str,
VocabularyId: str,
State: VocabularyStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAgentStatusResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeAgentStatusResponseTypeDef
def get_value() -> DescribeAgentStatusResponseTypeDef:
return {
"AgentStatus": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeAgentStatusResponseTypeDef(TypedDict):
AgentStatus: AgentStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EmptyResponseMetadataTypeDef
Usage Example
from mypy_boto3_connect.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetContactAttributesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetContactAttributesResponseTypeDef
def get_value() -> GetContactAttributesResponseTypeDef:
return {
"Attributes": ...,
"ResponseMetadata": ...,
}
Definition
class GetContactAttributesResponseTypeDef(TypedDict):
Attributes: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListAgentStatusResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListAgentStatusResponseTypeDef
def get_value() -> ListAgentStatusResponseTypeDef:
return {
"NextToken": ...,
"AgentStatusSummaryList": ...,
"ResponseMetadata": ...,
}
Definition
class ListAgentStatusResponseTypeDef(TypedDict):
NextToken: str,
AgentStatusSummaryList: List[AgentStatusSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListApprovedOriginsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListApprovedOriginsResponseTypeDef
def get_value() -> ListApprovedOriginsResponseTypeDef:
return {
"Origins": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListApprovedOriginsResponseTypeDef(TypedDict):
Origins: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListLambdaFunctionsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListLambdaFunctionsResponseTypeDef
def get_value() -> ListLambdaFunctionsResponseTypeDef:
return {
"LambdaFunctions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListLambdaFunctionsResponseTypeDef(TypedDict):
LambdaFunctions: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListLexBotsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListLexBotsResponseTypeDef
def get_value() -> ListLexBotsResponseTypeDef:
return {
"LexBots": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListLexBotsResponseTypeDef(TypedDict):
LexBots: List[LexBotTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See LexBotTypeDef
- See ResponseMetadataTypeDef
ListSecurityProfilePermissionsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListSecurityProfilePermissionsResponseTypeDef
def get_value() -> ListSecurityProfilePermissionsResponseTypeDef:
return {
"Permissions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListSecurityProfilePermissionsResponseTypeDef(TypedDict):
Permissions: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
MonitorContactResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import MonitorContactResponseTypeDef
def get_value() -> MonitorContactResponseTypeDef:
return {
"ContactId": ...,
"ContactArn": ...,
"ResponseMetadata": ...,
}
Definition
class MonitorContactResponseTypeDef(TypedDict):
ContactId: str,
ContactArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ReplicateInstanceResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ReplicateInstanceResponseTypeDef
def get_value() -> ReplicateInstanceResponseTypeDef:
return {
"Id": ...,
"Arn": ...,
"ResponseMetadata": ...,
}
Definition
class ReplicateInstanceResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartChatContactResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StartChatContactResponseTypeDef
def get_value() -> StartChatContactResponseTypeDef:
return {
"ContactId": ...,
"ParticipantId": ...,
"ParticipantToken": ...,
"ContinuedFromContactId": ...,
"ResponseMetadata": ...,
}
Definition
class StartChatContactResponseTypeDef(TypedDict):
ContactId: str,
ParticipantId: str,
ParticipantToken: str,
ContinuedFromContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartContactStreamingResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StartContactStreamingResponseTypeDef
def get_value() -> StartContactStreamingResponseTypeDef:
return {
"StreamingId": ...,
"ResponseMetadata": ...,
}
Definition
class StartContactStreamingResponseTypeDef(TypedDict):
StreamingId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartOutboundVoiceContactResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StartOutboundVoiceContactResponseTypeDef
def get_value() -> StartOutboundVoiceContactResponseTypeDef:
return {
"ContactId": ...,
"ResponseMetadata": ...,
}
Definition
class StartOutboundVoiceContactResponseTypeDef(TypedDict):
ContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartTaskContactResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StartTaskContactResponseTypeDef
def get_value() -> StartTaskContactResponseTypeDef:
return {
"ContactId": ...,
"ResponseMetadata": ...,
}
Definition
class StartTaskContactResponseTypeDef(TypedDict):
ContactId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TransferContactResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TransferContactResponseTypeDef
def get_value() -> TransferContactResponseTypeDef:
return {
"ContactId": ...,
"ContactArn": ...,
"ResponseMetadata": ...,
}
Definition
class TransferContactResponseTypeDef(TypedDict):
ContactId: str,
ContactArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdatePhoneNumberResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdatePhoneNumberResponseTypeDef
def get_value() -> UpdatePhoneNumberResponseTypeDef:
return {
"PhoneNumberId": ...,
"PhoneNumberArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdatePhoneNumberResponseTypeDef(TypedDict):
PhoneNumberId: str,
PhoneNumberArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeInstanceAttributeResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeInstanceAttributeResponseTypeDef
def get_value() -> DescribeInstanceAttributeResponseTypeDef:
return {
"Attribute": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeInstanceAttributeResponseTypeDef(TypedDict):
Attribute: AttributeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListInstanceAttributesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListInstanceAttributesResponseTypeDef
def get_value() -> ListInstanceAttributesResponseTypeDef:
return {
"Attributes": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListInstanceAttributesResponseTypeDef(TypedDict):
Attributes: List[AttributeTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchAvailablePhoneNumbersResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchAvailablePhoneNumbersResponseTypeDef
def get_value() -> SearchAvailablePhoneNumbersResponseTypeDef:
return {
"NextToken": ...,
"AvailableNumbersList": ...,
"ResponseMetadata": ...,
}
Definition
class SearchAvailablePhoneNumbersResponseTypeDef(TypedDict):
NextToken: str,
AvailableNumbersList: List[AvailableNumberSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartContactStreamingRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StartContactStreamingRequestRequestTypeDef
def get_value() -> StartContactStreamingRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"ChatStreamingConfiguration": ...,
"ClientToken": ...,
}
Definition
class StartContactStreamingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ChatStreamingConfiguration: ChatStreamingConfigurationTypeDef, # (1)
ClientToken: str,
ClaimedPhoneNumberSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ClaimedPhoneNumberSummaryTypeDef
def get_value() -> ClaimedPhoneNumberSummaryTypeDef:
return {
"PhoneNumberId": ...,
}
Definition
class ClaimedPhoneNumberSummaryTypeDef(TypedDict):
PhoneNumberId: NotRequired[str],
PhoneNumberArn: NotRequired[str],
PhoneNumber: NotRequired[str],
PhoneNumberCountryCode: NotRequired[PhoneNumberCountryCodeType], # (1)
PhoneNumberType: NotRequired[PhoneNumberTypeType], # (2)
PhoneNumberDescription: NotRequired[str],
TargetArn: NotRequired[str],
Tags: NotRequired[Dict[str, str]],
PhoneNumberStatus: NotRequired[PhoneNumberStatusTypeDef], # (3)
UserDataFiltersTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserDataFiltersTypeDef
def get_value() -> UserDataFiltersTypeDef:
return {
"Queues": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import ListContactFlowModulesResponseTypeDef
def get_value() -> ListContactFlowModulesResponseTypeDef:
return {
"ContactFlowModulesSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListContactFlowModulesResponseTypeDef(TypedDict):
ContactFlowModulesSummaryList: List[ContactFlowModuleSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeContactFlowModuleResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeContactFlowModuleResponseTypeDef
def get_value() -> DescribeContactFlowModuleResponseTypeDef:
return {
"ContactFlowModule": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeContactFlowModuleResponseTypeDef(TypedDict):
ContactFlowModule: ContactFlowModuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListContactFlowsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListContactFlowsResponseTypeDef
def get_value() -> ListContactFlowsResponseTypeDef:
return {
"ContactFlowSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListContactFlowsResponseTypeDef(TypedDict):
ContactFlowSummaryList: List[ContactFlowSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeContactFlowResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeContactFlowResponseTypeDef
def get_value() -> DescribeContactFlowResponseTypeDef:
return {
"ContactFlow": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeContactFlowResponseTypeDef(TypedDict):
ContactFlow: ContactFlowTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ContactTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ContactTypeDef
def get_value() -> ContactTypeDef:
return {
"Arn": ...,
}
Definition
class ContactTypeDef(TypedDict):
Arn: NotRequired[str],
Id: NotRequired[str],
InitialContactId: NotRequired[str],
PreviousContactId: NotRequired[str],
InitiationMethod: NotRequired[ContactInitiationMethodType], # (1)
Name: NotRequired[str],
Description: NotRequired[str],
Channel: NotRequired[ChannelType], # (2)
QueueInfo: NotRequired[QueueInfoTypeDef], # (3)
AgentInfo: NotRequired[AgentInfoTypeDef], # (4)
InitiationTimestamp: NotRequired[datetime],
DisconnectTimestamp: NotRequired[datetime],
LastUpdateTimestamp: NotRequired[datetime],
ScheduledTimestamp: NotRequired[datetime],
RelatedContactId: NotRequired[str],
WisdomInfo: NotRequired[WisdomInfoTypeDef], # (5)
- See ContactInitiationMethodType
- See ChannelType
- See QueueInfoTypeDef
- See AgentInfoTypeDef
- See WisdomInfoTypeDef
ControlPlaneTagFilterTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ControlPlaneTagFilterTypeDef
def get_value() -> ControlPlaneTagFilterTypeDef:
return {
"OrConditions": ...,
}
Definition
class ControlPlaneTagFilterTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[Sequence[TagConditionTypeDef]]], # (1)
AndConditions: NotRequired[Sequence[TagConditionTypeDef]], # (2)
TagCondition: NotRequired[TagConditionTypeDef], # (3)
CreateQueueRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateQueueRequestRequestTypeDef
def get_value() -> CreateQueueRequestRequestTypeDef:
return {
"InstanceId": ...,
"Name": ...,
"HoursOfOperationId": ...,
}
Definition
class CreateQueueRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
HoursOfOperationId: str,
Description: NotRequired[str],
OutboundCallerConfig: NotRequired[OutboundCallerConfigTypeDef], # (1)
MaxContacts: NotRequired[int],
QuickConnectIds: NotRequired[Sequence[str]],
Tags: NotRequired[Mapping[str, str]],
QueueTypeDef
Usage Example
from mypy_boto3_connect.type_defs import QueueTypeDef
def get_value() -> QueueTypeDef:
return {
"Name": ...,
}
Definition
class QueueTypeDef(TypedDict):
Name: NotRequired[str],
QueueArn: NotRequired[str],
QueueId: NotRequired[str],
Description: NotRequired[str],
OutboundCallerConfig: NotRequired[OutboundCallerConfigTypeDef], # (1)
HoursOfOperationId: NotRequired[str],
MaxContacts: NotRequired[int],
Status: NotRequired[QueueStatusType], # (2)
Tags: NotRequired[Dict[str, str]],
UpdateQueueOutboundCallerConfigRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateQueueOutboundCallerConfigRequestRequestTypeDef
def get_value() -> UpdateQueueOutboundCallerConfigRequestRequestTypeDef:
return {
"InstanceId": ...,
"QueueId": ...,
"OutboundCallerConfig": ...,
}
Definition
class UpdateQueueOutboundCallerConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
OutboundCallerConfig: OutboundCallerConfigTypeDef, # (1)
RoutingProfileTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RoutingProfileTypeDef
def get_value() -> RoutingProfileTypeDef:
return {
"InstanceId": ...,
}
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],
UpdateRoutingProfileConcurrencyRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateRoutingProfileConcurrencyRequestRequestTypeDef
def get_value() -> UpdateRoutingProfileConcurrencyRequestRequestTypeDef:
return {
"InstanceId": ...,
"RoutingProfileId": ...,
"MediaConcurrencies": ...,
}
Definition
class UpdateRoutingProfileConcurrencyRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
MediaConcurrencies: Sequence[MediaConcurrencyTypeDef], # (1)
UpdateUserIdentityInfoRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateUserIdentityInfoRequestRequestTypeDef
def get_value() -> UpdateUserIdentityInfoRequestRequestTypeDef:
return {
"IdentityInfo": ...,
"UserId": ...,
"InstanceId": ...,
}
Definition
class UpdateUserIdentityInfoRequestRequestTypeDef(TypedDict):
IdentityInfo: UserIdentityInfoTypeDef, # (1)
UserId: str,
InstanceId: str,
CreateUserRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateUserRequestRequestTypeDef
def get_value() -> CreateUserRequestRequestTypeDef:
return {
"Username": ...,
"PhoneConfig": ...,
"SecurityProfileIds": ...,
"RoutingProfileId": ...,
"InstanceId": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import UpdateUserPhoneConfigRequestRequestTypeDef
def get_value() -> UpdateUserPhoneConfigRequestRequestTypeDef:
return {
"PhoneConfig": ...,
"UserId": ...,
"InstanceId": ...,
}
Definition
class UpdateUserPhoneConfigRequestRequestTypeDef(TypedDict):
PhoneConfig: UserPhoneConfigTypeDef, # (1)
UserId: str,
InstanceId: str,
UserTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserTypeDef
def get_value() -> UserTypeDef:
return {
"Id": ...,
}
Definition
class UserTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Username: NotRequired[str],
IdentityInfo: NotRequired[UserIdentityInfoTypeDef], # (1)
PhoneConfig: NotRequired[UserPhoneConfigTypeDef], # (2)
DirectoryUserId: NotRequired[str],
SecurityProfileIds: NotRequired[List[str]],
RoutingProfileId: NotRequired[str],
HierarchyGroupId: NotRequired[str],
Tags: NotRequired[Dict[str, str]],
GetFederationTokenResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetFederationTokenResponseTypeDef
def get_value() -> GetFederationTokenResponseTypeDef:
return {
"Credentials": ...,
"SignInUrl": ...,
"UserArn": ...,
"UserId": ...,
"ResponseMetadata": ...,
}
Definition
class GetFederationTokenResponseTypeDef(TypedDict):
Credentials: CredentialsTypeDef, # (1)
SignInUrl: str,
UserArn: str,
UserId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CurrentMetricDataTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CurrentMetricDataTypeDef
def get_value() -> CurrentMetricDataTypeDef:
return {
"Metric": ...,
}
Definition
class CurrentMetricDataTypeDef(TypedDict):
Metric: NotRequired[CurrentMetricTypeDef], # (1)
Value: NotRequired[float],
ListDefaultVocabulariesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListDefaultVocabulariesResponseTypeDef
def get_value() -> ListDefaultVocabulariesResponseTypeDef:
return {
"DefaultVocabularyList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDefaultVocabulariesResponseTypeDef(TypedDict):
DefaultVocabularyList: List[DefaultVocabularyTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeSecurityProfileResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeSecurityProfileResponseTypeDef
def get_value() -> DescribeSecurityProfileResponseTypeDef:
return {
"SecurityProfile": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeSecurityProfileResponseTypeDef(TypedDict):
SecurityProfile: SecurityProfileTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeTrafficDistributionGroupResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeTrafficDistributionGroupResponseTypeDef
def get_value() -> DescribeTrafficDistributionGroupResponseTypeDef:
return {
"TrafficDistributionGroup": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeTrafficDistributionGroupResponseTypeDef(TypedDict):
TrafficDistributionGroup: TrafficDistributionGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeVocabularyResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeVocabularyResponseTypeDef
def get_value() -> DescribeVocabularyResponseTypeDef:
return {
"Vocabulary": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeVocabularyResponseTypeDef(TypedDict):
Vocabulary: VocabularyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DimensionsTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DimensionsTypeDef
def get_value() -> DimensionsTypeDef:
return {
"Queue": ...,
}
Definition
class DimensionsTypeDef(TypedDict):
Queue: NotRequired[QueueReferenceTypeDef], # (1)
Channel: NotRequired[ChannelType], # (2)
RoutingProfile: NotRequired[RoutingProfileReferenceTypeDef], # (3)
DisassociateRoutingProfileQueuesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DisassociateRoutingProfileQueuesRequestRequestTypeDef
def get_value() -> DisassociateRoutingProfileQueuesRequestRequestTypeDef:
return {
"InstanceId": ...,
"RoutingProfileId": ...,
"QueueReferences": ...,
}
Definition
class DisassociateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
QueueReferences: Sequence[RoutingProfileQueueReferenceTypeDef], # (1)
RoutingProfileQueueConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RoutingProfileQueueConfigTypeDef
def get_value() -> RoutingProfileQueueConfigTypeDef:
return {
"QueueReference": ...,
"Priority": ...,
"Delay": ...,
}
Definition
class RoutingProfileQueueConfigTypeDef(TypedDict):
QueueReference: RoutingProfileQueueReferenceTypeDef, # (1)
Priority: int,
Delay: int,
TelephonyConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TelephonyConfigTypeDef
def get_value() -> TelephonyConfigTypeDef:
return {
"Distributions": ...,
}
KinesisVideoStreamConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import KinesisVideoStreamConfigTypeDef
def get_value() -> KinesisVideoStreamConfigTypeDef:
return {
"Prefix": ...,
"RetentionPeriodHours": ...,
"EncryptionConfig": ...,
}
Definition
class KinesisVideoStreamConfigTypeDef(TypedDict):
Prefix: str,
RetentionPeriodHours: int,
EncryptionConfig: EncryptionConfigTypeDef, # (1)
S3ConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import S3ConfigTypeDef
def get_value() -> S3ConfigTypeDef:
return {
"BucketName": ...,
"BucketPrefix": ...,
}
Definition
class S3ConfigTypeDef(TypedDict):
BucketName: str,
BucketPrefix: str,
EncryptionConfig: NotRequired[EncryptionConfigTypeDef], # (1)
GetCurrentMetricDataRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetCurrentMetricDataRequestRequestTypeDef
def get_value() -> GetCurrentMetricDataRequestRequestTypeDef:
return {
"InstanceId": ...,
"Filters": ...,
"CurrentMetrics": ...,
}
Definition
class GetCurrentMetricDataRequestRequestTypeDef(TypedDict):
InstanceId: str,
Filters: FiltersTypeDef, # (1)
CurrentMetrics: Sequence[CurrentMetricTypeDef], # (2)
Groupings: NotRequired[Sequence[GroupingType]], # (3)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SortCriteria: NotRequired[Sequence[CurrentMetricSortCriteriaTypeDef]], # (4)
ListAgentStatusRequestListAgentStatusesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListAgentStatusRequestListAgentStatusesPaginateTypeDef
def get_value() -> ListAgentStatusRequestListAgentStatusesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListAgentStatusRequestListAgentStatusesPaginateTypeDef(TypedDict):
InstanceId: str,
AgentStatusTypes: NotRequired[Sequence[AgentStatusTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListApprovedOriginsRequestListApprovedOriginsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListApprovedOriginsRequestListApprovedOriginsPaginateTypeDef
def get_value() -> ListApprovedOriginsRequestListApprovedOriginsPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListApprovedOriginsRequestListApprovedOriginsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListBotsRequestListBotsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListBotsRequestListBotsPaginateTypeDef
def get_value() -> ListBotsRequestListBotsPaginateTypeDef:
return {
"InstanceId": ...,
"LexVersion": ...,
}
Definition
class ListBotsRequestListBotsPaginateTypeDef(TypedDict):
InstanceId: str,
LexVersion: LexVersionType, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See LexVersionType
- See PaginatorConfigTypeDef
ListContactFlowModulesRequestListContactFlowModulesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListContactFlowModulesRequestListContactFlowModulesPaginateTypeDef
def get_value() -> ListContactFlowModulesRequestListContactFlowModulesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListContactFlowModulesRequestListContactFlowModulesPaginateTypeDef(TypedDict):
InstanceId: str,
ContactFlowModuleState: NotRequired[ContactFlowModuleStateType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListContactFlowsRequestListContactFlowsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListContactFlowsRequestListContactFlowsPaginateTypeDef
def get_value() -> ListContactFlowsRequestListContactFlowsPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListContactFlowsRequestListContactFlowsPaginateTypeDef(TypedDict):
InstanceId: str,
ContactFlowTypes: NotRequired[Sequence[ContactFlowTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListContactReferencesRequestListContactReferencesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListContactReferencesRequestListContactReferencesPaginateTypeDef
def get_value() -> ListContactReferencesRequestListContactReferencesPaginateTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"ReferenceTypes": ...,
}
Definition
class ListContactReferencesRequestListContactReferencesPaginateTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ReferenceTypes: Sequence[ReferenceTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateTypeDef
def get_value() -> ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateTypeDef(TypedDict):
InstanceId: str,
LanguageCode: NotRequired[VocabularyLanguageCodeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListHoursOfOperationsRequestListHoursOfOperationsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListHoursOfOperationsRequestListHoursOfOperationsPaginateTypeDef
def get_value() -> ListHoursOfOperationsRequestListHoursOfOperationsPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListHoursOfOperationsRequestListHoursOfOperationsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListInstanceAttributesRequestListInstanceAttributesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListInstanceAttributesRequestListInstanceAttributesPaginateTypeDef
def get_value() -> ListInstanceAttributesRequestListInstanceAttributesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListInstanceAttributesRequestListInstanceAttributesPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateTypeDef
def get_value() -> ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateTypeDef:
return {
"InstanceId": ...,
"ResourceType": ...,
}
Definition
class ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateTypeDef(TypedDict):
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListInstancesRequestListInstancesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListInstancesRequestListInstancesPaginateTypeDef
def get_value() -> ListInstancesRequestListInstancesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListInstancesRequestListInstancesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateTypeDef
def get_value() -> ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateTypeDef(TypedDict):
InstanceId: str,
IntegrationType: NotRequired[IntegrationTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListLambdaFunctionsRequestListLambdaFunctionsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListLambdaFunctionsRequestListLambdaFunctionsPaginateTypeDef
def get_value() -> ListLambdaFunctionsRequestListLambdaFunctionsPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListLambdaFunctionsRequestListLambdaFunctionsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListLexBotsRequestListLexBotsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListLexBotsRequestListLexBotsPaginateTypeDef
def get_value() -> ListLexBotsRequestListLexBotsPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListLexBotsRequestListLexBotsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPhoneNumbersRequestListPhoneNumbersPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListPhoneNumbersRequestListPhoneNumbersPaginateTypeDef
def get_value() -> ListPhoneNumbersRequestListPhoneNumbersPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListPhoneNumbersRequestListPhoneNumbersPaginateTypeDef(TypedDict):
InstanceId: str,
PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]], # (1)
PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateTypeDef
def get_value() -> ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateTypeDef:
return {
"TargetArn": ...,
}
Definition
class ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateTypeDef(TypedDict):
TargetArn: NotRequired[str],
PhoneNumberCountryCodes: NotRequired[Sequence[PhoneNumberCountryCodeType]], # (1)
PhoneNumberTypes: NotRequired[Sequence[PhoneNumberTypeType]], # (2)
PhoneNumberPrefix: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
ListPromptsRequestListPromptsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListPromptsRequestListPromptsPaginateTypeDef
def get_value() -> ListPromptsRequestListPromptsPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListPromptsRequestListPromptsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateTypeDef
def get_value() -> ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateTypeDef:
return {
"InstanceId": ...,
"QueueId": ...,
}
Definition
class ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateTypeDef(TypedDict):
InstanceId: str,
QueueId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListQueuesRequestListQueuesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListQueuesRequestListQueuesPaginateTypeDef
def get_value() -> ListQueuesRequestListQueuesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListQueuesRequestListQueuesPaginateTypeDef(TypedDict):
InstanceId: str,
QueueTypes: NotRequired[Sequence[QueueTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See QueueTypeType
- See PaginatorConfigTypeDef
ListQuickConnectsRequestListQuickConnectsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListQuickConnectsRequestListQuickConnectsPaginateTypeDef
def get_value() -> ListQuickConnectsRequestListQuickConnectsPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListQuickConnectsRequestListQuickConnectsPaginateTypeDef(TypedDict):
InstanceId: str,
QuickConnectTypes: NotRequired[Sequence[QuickConnectTypeType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateTypeDef
def get_value() -> ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateTypeDef:
return {
"InstanceId": ...,
"RoutingProfileId": ...,
}
Definition
class ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRoutingProfilesRequestListRoutingProfilesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListRoutingProfilesRequestListRoutingProfilesPaginateTypeDef
def get_value() -> ListRoutingProfilesRequestListRoutingProfilesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListRoutingProfilesRequestListRoutingProfilesPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRulesRequestListRulesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListRulesRequestListRulesPaginateTypeDef
def get_value() -> ListRulesRequestListRulesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListRulesRequestListRulesPaginateTypeDef(TypedDict):
InstanceId: str,
PublishStatus: NotRequired[RulePublishStatusType], # (1)
EventSourceName: NotRequired[EventSourceNameType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
ListSecurityKeysRequestListSecurityKeysPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListSecurityKeysRequestListSecurityKeysPaginateTypeDef
def get_value() -> ListSecurityKeysRequestListSecurityKeysPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListSecurityKeysRequestListSecurityKeysPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateTypeDef
def get_value() -> ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateTypeDef:
return {
"SecurityProfileId": ...,
"InstanceId": ...,
}
Definition
class ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateTypeDef(TypedDict):
SecurityProfileId: str,
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef
def get_value() -> ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTaskTemplatesRequestListTaskTemplatesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListTaskTemplatesRequestListTaskTemplatesPaginateTypeDef
def get_value() -> ListTaskTemplatesRequestListTaskTemplatesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListTaskTemplatesRequestListTaskTemplatesPaginateTypeDef(TypedDict):
InstanceId: str,
Status: NotRequired[TaskTemplateStatusType], # (1)
Name: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateTypeDef
def get_value() -> ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateTypeDef(TypedDict):
InstanceId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUseCasesRequestListUseCasesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListUseCasesRequestListUseCasesPaginateTypeDef
def get_value() -> ListUseCasesRequestListUseCasesPaginateTypeDef:
return {
"InstanceId": ...,
"IntegrationAssociationId": ...,
}
Definition
class ListUseCasesRequestListUseCasesPaginateTypeDef(TypedDict):
InstanceId: str,
IntegrationAssociationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateTypeDef
def get_value() -> ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUsersRequestListUsersPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListUsersRequestListUsersPaginateTypeDef
def get_value() -> ListUsersRequestListUsersPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class ListUsersRequestListUsersPaginateTypeDef(TypedDict):
InstanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateTypeDef
def get_value() -> SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateTypeDef:
return {
"TargetArn": ...,
"PhoneNumberCountryCode": ...,
"PhoneNumberType": ...,
}
Definition
class SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateTypeDef(TypedDict):
TargetArn: str,
PhoneNumberCountryCode: PhoneNumberCountryCodeType, # (1)
PhoneNumberType: PhoneNumberTypeType, # (2)
PhoneNumberPrefix: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
SearchVocabulariesRequestSearchVocabulariesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchVocabulariesRequestSearchVocabulariesPaginateTypeDef
def get_value() -> SearchVocabulariesRequestSearchVocabulariesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class SearchVocabulariesRequestSearchVocabulariesPaginateTypeDef(TypedDict):
InstanceId: str,
State: NotRequired[VocabularyStateType], # (1)
NameStartsWith: NotRequired[str],
LanguageCode: NotRequired[VocabularyLanguageCodeType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
HierarchyPathReferenceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HierarchyPathReferenceTypeDef
def get_value() -> HierarchyPathReferenceTypeDef:
return {
"LevelOne": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import HierarchyPathTypeDef
def get_value() -> HierarchyPathTypeDef:
return {
"LevelOne": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import ListUserHierarchyGroupsResponseTypeDef
def get_value() -> ListUserHierarchyGroupsResponseTypeDef:
return {
"UserHierarchyGroupSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListUserHierarchyGroupsResponseTypeDef(TypedDict):
UserHierarchyGroupSummaryList: List[HierarchyGroupSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
HierarchyStructureTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HierarchyStructureTypeDef
def get_value() -> HierarchyStructureTypeDef:
return {
"LevelOne": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import HierarchyStructureUpdateTypeDef
def get_value() -> HierarchyStructureUpdateTypeDef:
return {
"LevelOne": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import HistoricalMetricTypeDef
def get_value() -> HistoricalMetricTypeDef:
return {
"Name": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import HoursOfOperationConfigTypeDef
def get_value() -> HoursOfOperationConfigTypeDef:
return {
"Day": ...,
"StartTime": ...,
"EndTime": ...,
}
Definition
class HoursOfOperationConfigTypeDef(TypedDict):
Day: HoursOfOperationDaysType, # (1)
StartTime: HoursOfOperationTimeSliceTypeDef, # (2)
EndTime: HoursOfOperationTimeSliceTypeDef, # (2)
- See HoursOfOperationDaysType
- See HoursOfOperationTimeSliceTypeDef
- See HoursOfOperationTimeSliceTypeDef
ListHoursOfOperationsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListHoursOfOperationsResponseTypeDef
def get_value() -> ListHoursOfOperationsResponseTypeDef:
return {
"HoursOfOperationSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListHoursOfOperationsResponseTypeDef(TypedDict):
HoursOfOperationSummaryList: List[HoursOfOperationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
InstanceTypeDef
Usage Example
from mypy_boto3_connect.type_defs import InstanceTypeDef
def get_value() -> InstanceTypeDef:
return {
"Id": ...,
}
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],
ListInstancesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListInstancesResponseTypeDef
def get_value() -> ListInstancesResponseTypeDef:
return {
"InstanceSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListInstancesResponseTypeDef(TypedDict):
InstanceSummaryList: List[InstanceSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListIntegrationAssociationsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListIntegrationAssociationsResponseTypeDef
def get_value() -> ListIntegrationAssociationsResponseTypeDef:
return {
"IntegrationAssociationSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListIntegrationAssociationsResponseTypeDef(TypedDict):
IntegrationAssociationSummaryList: List[IntegrationAssociationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
InvisibleFieldInfoTypeDef
Usage Example
from mypy_boto3_connect.type_defs import InvisibleFieldInfoTypeDef
def get_value() -> InvisibleFieldInfoTypeDef:
return {
"Id": ...,
}
Definition
class InvisibleFieldInfoTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)
ReadOnlyFieldInfoTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ReadOnlyFieldInfoTypeDef
def get_value() -> ReadOnlyFieldInfoTypeDef:
return {
"Id": ...,
}
Definition
class ReadOnlyFieldInfoTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)
RequiredFieldInfoTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RequiredFieldInfoTypeDef
def get_value() -> RequiredFieldInfoTypeDef:
return {
"Id": ...,
}
Definition
class RequiredFieldInfoTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)
TaskTemplateDefaultFieldValueTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TaskTemplateDefaultFieldValueTypeDef
def get_value() -> TaskTemplateDefaultFieldValueTypeDef:
return {
"Id": ...,
}
Definition
class TaskTemplateDefaultFieldValueTypeDef(TypedDict):
Id: NotRequired[TaskTemplateFieldIdentifierTypeDef], # (1)
DefaultValue: NotRequired[str],
TaskTemplateFieldTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TaskTemplateFieldTypeDef
def get_value() -> TaskTemplateFieldTypeDef:
return {
"Id": ...,
}
Definition
class TaskTemplateFieldTypeDef(TypedDict):
Id: TaskTemplateFieldIdentifierTypeDef, # (1)
Description: NotRequired[str],
Type: NotRequired[TaskTemplateFieldTypeType], # (2)
SingleSelectOptions: NotRequired[Sequence[str]],
ListPhoneNumbersResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListPhoneNumbersResponseTypeDef
def get_value() -> ListPhoneNumbersResponseTypeDef:
return {
"PhoneNumberSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListPhoneNumbersResponseTypeDef(TypedDict):
PhoneNumberSummaryList: List[PhoneNumberSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPhoneNumbersV2ResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListPhoneNumbersV2ResponseTypeDef
def get_value() -> ListPhoneNumbersV2ResponseTypeDef:
return {
"NextToken": ...,
"ListPhoneNumbersSummaryList": ...,
"ResponseMetadata": ...,
}
Definition
class ListPhoneNumbersV2ResponseTypeDef(TypedDict):
NextToken: str,
ListPhoneNumbersSummaryList: List[ListPhoneNumbersSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPromptsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListPromptsResponseTypeDef
def get_value() -> ListPromptsResponseTypeDef:
return {
"PromptSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListPromptsResponseTypeDef(TypedDict):
PromptSummaryList: List[PromptSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListQueueQuickConnectsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListQueueQuickConnectsResponseTypeDef
def get_value() -> ListQueueQuickConnectsResponseTypeDef:
return {
"NextToken": ...,
"QuickConnectSummaryList": ...,
"ResponseMetadata": ...,
}
Definition
class ListQueueQuickConnectsResponseTypeDef(TypedDict):
NextToken: str,
QuickConnectSummaryList: List[QuickConnectSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListQuickConnectsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListQuickConnectsResponseTypeDef
def get_value() -> ListQuickConnectsResponseTypeDef:
return {
"QuickConnectSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListQuickConnectsResponseTypeDef(TypedDict):
QuickConnectSummaryList: List[QuickConnectSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListQueuesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListQueuesResponseTypeDef
def get_value() -> ListQueuesResponseTypeDef:
return {
"QueueSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListQueuesResponseTypeDef(TypedDict):
QueueSummaryList: List[QueueSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRoutingProfileQueuesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListRoutingProfileQueuesResponseTypeDef
def get_value() -> ListRoutingProfileQueuesResponseTypeDef:
return {
"NextToken": ...,
"RoutingProfileQueueConfigSummaryList": ...,
"ResponseMetadata": ...,
}
Definition
class ListRoutingProfileQueuesResponseTypeDef(TypedDict):
NextToken: str,
RoutingProfileQueueConfigSummaryList: List[RoutingProfileQueueConfigSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRoutingProfilesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListRoutingProfilesResponseTypeDef
def get_value() -> ListRoutingProfilesResponseTypeDef:
return {
"RoutingProfileSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListRoutingProfilesResponseTypeDef(TypedDict):
RoutingProfileSummaryList: List[RoutingProfileSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSecurityKeysResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListSecurityKeysResponseTypeDef
def get_value() -> ListSecurityKeysResponseTypeDef:
return {
"SecurityKeys": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListSecurityKeysResponseTypeDef(TypedDict):
SecurityKeys: List[SecurityKeyTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSecurityProfilesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListSecurityProfilesResponseTypeDef
def get_value() -> ListSecurityProfilesResponseTypeDef:
return {
"SecurityProfileSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListSecurityProfilesResponseTypeDef(TypedDict):
SecurityProfileSummaryList: List[SecurityProfileSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTaskTemplatesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListTaskTemplatesResponseTypeDef
def get_value() -> ListTaskTemplatesResponseTypeDef:
return {
"TaskTemplates": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTaskTemplatesResponseTypeDef(TypedDict):
TaskTemplates: List[TaskTemplateMetadataTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTrafficDistributionGroupsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListTrafficDistributionGroupsResponseTypeDef
def get_value() -> ListTrafficDistributionGroupsResponseTypeDef:
return {
"NextToken": ...,
"TrafficDistributionGroupSummaryList": ...,
"ResponseMetadata": ...,
}
Definition
class ListTrafficDistributionGroupsResponseTypeDef(TypedDict):
NextToken: str,
TrafficDistributionGroupSummaryList: List[TrafficDistributionGroupSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUseCasesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListUseCasesResponseTypeDef
def get_value() -> ListUseCasesResponseTypeDef:
return {
"UseCaseSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListUseCasesResponseTypeDef(TypedDict):
UseCaseSummaryList: List[UseCaseTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUsersResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListUsersResponseTypeDef
def get_value() -> ListUsersResponseTypeDef:
return {
"UserSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListUsersResponseTypeDef(TypedDict):
UserSummaryList: List[UserSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MetricV2TypeDef
Usage Example
from mypy_boto3_connect.type_defs import MetricV2TypeDef
def get_value() -> MetricV2TypeDef:
return {
"Name": ...,
}
Definition
class MetricV2TypeDef(TypedDict):
Name: NotRequired[str],
Threshold: NotRequired[Sequence[ThresholdV2TypeDef]], # (1)
MetricFilters: NotRequired[Sequence[MetricFilterV2TypeDef]], # (2)
SendNotificationActionDefinitionTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SendNotificationActionDefinitionTypeDef
def get_value() -> SendNotificationActionDefinitionTypeDef:
return {
"DeliveryMethod": ...,
"Content": ...,
"ContentType": ...,
"Recipient": ...,
}
Definition
class SendNotificationActionDefinitionTypeDef(TypedDict):
DeliveryMethod: NotificationDeliveryTypeType, # (1)
Content: str,
ContentType: NotificationContentTypeType, # (2)
Recipient: NotificationRecipientTypeTypeDef, # (3)
Subject: NotRequired[str],
- See NotificationDeliveryTypeType
- See NotificationContentTypeType
- See NotificationRecipientTypeTypeDef
ParticipantTimerConfigurationTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ParticipantTimerConfigurationTypeDef
def get_value() -> ParticipantTimerConfigurationTypeDef:
return {
"ParticipantRole": ...,
"TimerType": ...,
"TimerValue": ...,
}
Definition
class ParticipantTimerConfigurationTypeDef(TypedDict):
ParticipantRole: TimerEligibleParticipantRolesType, # (1)
TimerType: ParticipantTimerTypeType, # (2)
TimerValue: ParticipantTimerValueTypeDef, # (3)
StartChatContactRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StartChatContactRequestRequestTypeDef
def get_value() -> StartChatContactRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactFlowId": ...,
"ParticipantDetails": ...,
}
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)
QueueSearchCriteriaTypeDef
Usage Example
from mypy_boto3_connect.type_defs import QueueSearchCriteriaTypeDef
def get_value() -> QueueSearchCriteriaTypeDef:
return {
"OrConditions": ...,
}
Definition
class QueueSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[QueueSearchCriteriaTypeDef]], # (1)
AndConditions: NotRequired[Sequence[QueueSearchCriteriaTypeDef]], # (1)
StringCondition: NotRequired[StringConditionTypeDef], # (3)
QueueTypeCondition: NotRequired[SearchableQueueTypeType], # (4)
- See QueueSearchCriteriaTypeDef
- See QueueSearchCriteriaTypeDef
- See StringConditionTypeDef
- See SearchableQueueTypeType
RoutingProfileSearchCriteriaTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RoutingProfileSearchCriteriaTypeDef
def get_value() -> RoutingProfileSearchCriteriaTypeDef:
return {
"OrConditions": ...,
}
Definition
class RoutingProfileSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[RoutingProfileSearchCriteriaTypeDef]], # (1)
AndConditions: NotRequired[Sequence[RoutingProfileSearchCriteriaTypeDef]], # (1)
StringCondition: NotRequired[StringConditionTypeDef], # (3)
- See RoutingProfileSearchCriteriaTypeDef
- See RoutingProfileSearchCriteriaTypeDef
- See StringConditionTypeDef
SecurityProfileSearchCriteriaTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SecurityProfileSearchCriteriaTypeDef
def get_value() -> SecurityProfileSearchCriteriaTypeDef:
return {
"OrConditions": ...,
}
Definition
class SecurityProfileSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[SecurityProfileSearchCriteriaTypeDef]], # (1)
AndConditions: NotRequired[Sequence[SecurityProfileSearchCriteriaTypeDef]], # (1)
StringCondition: NotRequired[StringConditionTypeDef], # (3)
- See SecurityProfileSearchCriteriaTypeDef
- See SecurityProfileSearchCriteriaTypeDef
- See StringConditionTypeDef
UserSearchCriteriaTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserSearchCriteriaTypeDef
def get_value() -> UserSearchCriteriaTypeDef:
return {
"OrConditions": ...,
}
Definition
class UserSearchCriteriaTypeDef(TypedDict):
OrConditions: NotRequired[Sequence[UserSearchCriteriaTypeDef]], # (1)
AndConditions: NotRequired[Sequence[UserSearchCriteriaTypeDef]], # (1)
StringCondition: NotRequired[StringConditionTypeDef], # (3)
HierarchyGroupCondition: NotRequired[HierarchyGroupConditionTypeDef], # (4)
- See UserSearchCriteriaTypeDef
- See UserSearchCriteriaTypeDef
- See StringConditionTypeDef
- See HierarchyGroupConditionTypeDef
QuickConnectConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import QuickConnectConfigTypeDef
def get_value() -> QuickConnectConfigTypeDef:
return {
"QuickConnectType": ...,
}
Definition
class QuickConnectConfigTypeDef(TypedDict):
QuickConnectType: QuickConnectTypeType, # (1)
UserConfig: NotRequired[UserQuickConnectConfigTypeDef], # (2)
QueueConfig: NotRequired[QueueQuickConnectConfigTypeDef], # (3)
PhoneConfig: NotRequired[PhoneNumberQuickConnectConfigTypeDef], # (4)
- See QuickConnectTypeType
- See UserQuickConnectConfigTypeDef
- See QueueQuickConnectConfigTypeDef
- See PhoneNumberQuickConnectConfigTypeDef
ReferenceSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ReferenceSummaryTypeDef
def get_value() -> ReferenceSummaryTypeDef:
return {
"Url": ...,
}
Definition
class ReferenceSummaryTypeDef(TypedDict):
Url: NotRequired[UrlReferenceTypeDef], # (1)
Attachment: NotRequired[AttachmentReferenceTypeDef], # (2)
String: NotRequired[StringReferenceTypeDef], # (3)
Number: NotRequired[NumberReferenceTypeDef], # (4)
Date: NotRequired[DateReferenceTypeDef], # (5)
Email: NotRequired[EmailReferenceTypeDef], # (6)
- See UrlReferenceTypeDef
- See AttachmentReferenceTypeDef
- See StringReferenceTypeDef
- See NumberReferenceTypeDef
- See DateReferenceTypeDef
- See EmailReferenceTypeDef
StartTaskContactRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StartTaskContactRequestRequestTypeDef
def get_value() -> StartTaskContactRequestRequestTypeDef:
return {
"InstanceId": ...,
"Name": ...,
}
Definition
class StartTaskContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
PreviousContactId: NotRequired[str],
ContactFlowId: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
References: NotRequired[Mapping[str, ReferenceTypeDef]], # (1)
Description: NotRequired[str],
ClientToken: NotRequired[str],
ScheduledTime: NotRequired[Union[datetime, str]],
TaskTemplateId: NotRequired[str],
QuickConnectId: NotRequired[str],
RelatedContactId: NotRequired[str],
- See ReferenceTypeDef
TaskActionDefinitionTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TaskActionDefinitionTypeDef
def get_value() -> TaskActionDefinitionTypeDef:
return {
"Name": ...,
"ContactFlowId": ...,
}
Definition
class TaskActionDefinitionTypeDef(TypedDict):
Name: str,
ContactFlowId: str,
Description: NotRequired[str],
References: NotRequired[Mapping[str, ReferenceTypeDef]], # (1)
- See ReferenceTypeDef
UpdateContactRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateContactRequestRequestTypeDef
def get_value() -> UpdateContactRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
}
Definition
class UpdateContactRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
Name: NotRequired[str],
Description: NotRequired[str],
References: NotRequired[Mapping[str, ReferenceTypeDef]], # (1)
- See ReferenceTypeDef
SearchSecurityProfilesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchSecurityProfilesResponseTypeDef
def get_value() -> SearchSecurityProfilesResponseTypeDef:
return {
"SecurityProfiles": ...,
"NextToken": ...,
"ApproximateTotalCount": ...,
"ResponseMetadata": ...,
}
Definition
class SearchSecurityProfilesResponseTypeDef(TypedDict):
SecurityProfiles: List[SecurityProfileSearchSummaryTypeDef], # (1)
NextToken: str,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchVocabulariesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchVocabulariesResponseTypeDef
def get_value() -> SearchVocabulariesResponseTypeDef:
return {
"VocabularySummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class SearchVocabulariesResponseTypeDef(TypedDict):
VocabularySummaryList: List[VocabularySummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartContactRecordingRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import StartContactRecordingRequestRequestTypeDef
def get_value() -> StartContactRecordingRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"InitialContactId": ...,
"VoiceRecordingConfiguration": ...,
}
Definition
class StartContactRecordingRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
InitialContactId: str,
VoiceRecordingConfiguration: VoiceRecordingConfigurationTypeDef, # (1)
UserSearchSummaryTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserSearchSummaryTypeDef
def get_value() -> UserSearchSummaryTypeDef:
return {
"Arn": ...,
}
Definition
class UserSearchSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
DirectoryUserId: NotRequired[str],
HierarchyGroupId: NotRequired[str],
Id: NotRequired[str],
IdentityInfo: NotRequired[UserIdentityInfoLiteTypeDef], # (1)
PhoneConfig: NotRequired[UserPhoneConfigTypeDef], # (2)
RoutingProfileId: NotRequired[str],
SecurityProfileIds: NotRequired[List[str]],
Tags: NotRequired[Dict[str, str]],
Username: NotRequired[str],
ListRulesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListRulesResponseTypeDef
def get_value() -> ListRulesResponseTypeDef:
return {
"RuleSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListRulesResponseTypeDef(TypedDict):
RuleSummaryList: List[RuleSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBotsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListBotsResponseTypeDef
def get_value() -> ListBotsResponseTypeDef:
return {
"LexBots": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListBotsResponseTypeDef(TypedDict):
LexBots: List[LexBotConfigTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribePhoneNumberResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribePhoneNumberResponseTypeDef
def get_value() -> DescribePhoneNumberResponseTypeDef:
return {
"ClaimedPhoneNumberSummary": ...,
"ResponseMetadata": ...,
}
Definition
class DescribePhoneNumberResponseTypeDef(TypedDict):
ClaimedPhoneNumberSummary: ClaimedPhoneNumberSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetCurrentUserDataRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetCurrentUserDataRequestRequestTypeDef
def get_value() -> GetCurrentUserDataRequestRequestTypeDef:
return {
"InstanceId": ...,
"Filters": ...,
}
Definition
class GetCurrentUserDataRequestRequestTypeDef(TypedDict):
InstanceId: str,
Filters: UserDataFiltersTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
DescribeContactResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeContactResponseTypeDef
def get_value() -> DescribeContactResponseTypeDef:
return {
"Contact": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeContactResponseTypeDef(TypedDict):
Contact: ContactTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
QueueSearchFilterTypeDef
Usage Example
from mypy_boto3_connect.type_defs import QueueSearchFilterTypeDef
def get_value() -> QueueSearchFilterTypeDef:
return {
"TagFilter": ...,
}
Definition
class QueueSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)
RoutingProfileSearchFilterTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RoutingProfileSearchFilterTypeDef
def get_value() -> RoutingProfileSearchFilterTypeDef:
return {
"TagFilter": ...,
}
Definition
class RoutingProfileSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)
SecurityProfilesSearchFilterTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SecurityProfilesSearchFilterTypeDef
def get_value() -> SecurityProfilesSearchFilterTypeDef:
return {
"TagFilter": ...,
}
Definition
class SecurityProfilesSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)
UserSearchFilterTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserSearchFilterTypeDef
def get_value() -> UserSearchFilterTypeDef:
return {
"TagFilter": ...,
}
Definition
class UserSearchFilterTypeDef(TypedDict):
TagFilter: NotRequired[ControlPlaneTagFilterTypeDef], # (1)
DescribeQueueResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeQueueResponseTypeDef
def get_value() -> DescribeQueueResponseTypeDef:
return {
"Queue": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeQueueResponseTypeDef(TypedDict):
Queue: QueueTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See QueueTypeDef
- See ResponseMetadataTypeDef
SearchQueuesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchQueuesResponseTypeDef
def get_value() -> SearchQueuesResponseTypeDef:
return {
"Queues": ...,
"NextToken": ...,
"ApproximateTotalCount": ...,
"ResponseMetadata": ...,
}
Definition
class SearchQueuesResponseTypeDef(TypedDict):
Queues: List[QueueTypeDef], # (1)
NextToken: str,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See QueueTypeDef
- See ResponseMetadataTypeDef
DescribeRoutingProfileResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeRoutingProfileResponseTypeDef
def get_value() -> DescribeRoutingProfileResponseTypeDef:
return {
"RoutingProfile": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeRoutingProfileResponseTypeDef(TypedDict):
RoutingProfile: RoutingProfileTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchRoutingProfilesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchRoutingProfilesResponseTypeDef
def get_value() -> SearchRoutingProfilesResponseTypeDef:
return {
"RoutingProfiles": ...,
"NextToken": ...,
"ApproximateTotalCount": ...,
"ResponseMetadata": ...,
}
Definition
class SearchRoutingProfilesResponseTypeDef(TypedDict):
RoutingProfiles: List[RoutingProfileTypeDef], # (1)
NextToken: str,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeUserResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeUserResponseTypeDef
def get_value() -> DescribeUserResponseTypeDef:
return {
"User": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeUserResponseTypeDef(TypedDict):
User: UserTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
CurrentMetricResultTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CurrentMetricResultTypeDef
def get_value() -> CurrentMetricResultTypeDef:
return {
"Dimensions": ...,
}
Definition
class CurrentMetricResultTypeDef(TypedDict):
Dimensions: NotRequired[DimensionsTypeDef], # (1)
Collections: NotRequired[List[CurrentMetricDataTypeDef]], # (2)
AssociateRoutingProfileQueuesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociateRoutingProfileQueuesRequestRequestTypeDef
def get_value() -> AssociateRoutingProfileQueuesRequestRequestTypeDef:
return {
"InstanceId": ...,
"RoutingProfileId": ...,
"QueueConfigs": ...,
}
Definition
class AssociateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef], # (1)
CreateRoutingProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateRoutingProfileRequestRequestTypeDef
def get_value() -> CreateRoutingProfileRequestRequestTypeDef:
return {
"InstanceId": ...,
"Name": ...,
"Description": ...,
"DefaultOutboundQueueId": ...,
"MediaConcurrencies": ...,
}
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]],
UpdateRoutingProfileQueuesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateRoutingProfileQueuesRequestRequestTypeDef
def get_value() -> UpdateRoutingProfileQueuesRequestRequestTypeDef:
return {
"InstanceId": ...,
"RoutingProfileId": ...,
"QueueConfigs": ...,
}
Definition
class UpdateRoutingProfileQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
RoutingProfileId: str,
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef], # (1)
GetTrafficDistributionResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetTrafficDistributionResponseTypeDef
def get_value() -> GetTrafficDistributionResponseTypeDef:
return {
"TelephonyConfig": ...,
"Id": ...,
"Arn": ...,
"ResponseMetadata": ...,
}
Definition
class GetTrafficDistributionResponseTypeDef(TypedDict):
TelephonyConfig: TelephonyConfigTypeDef, # (1)
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTrafficDistributionRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateTrafficDistributionRequestRequestTypeDef
def get_value() -> UpdateTrafficDistributionRequestRequestTypeDef:
return {
"Id": ...,
}
Definition
class UpdateTrafficDistributionRequestRequestTypeDef(TypedDict):
Id: str,
TelephonyConfig: NotRequired[TelephonyConfigTypeDef], # (1)
InstanceStorageConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import InstanceStorageConfigTypeDef
def get_value() -> InstanceStorageConfigTypeDef:
return {
"StorageType": ...,
}
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
UserDataTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UserDataTypeDef
def get_value() -> UserDataTypeDef:
return {
"User": ...,
}
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
Usage Example
from mypy_boto3_connect.type_defs import HierarchyGroupTypeDef
def get_value() -> HierarchyGroupTypeDef:
return {
"Id": ...,
}
Definition
class HierarchyGroupTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
LevelId: NotRequired[str],
HierarchyPath: NotRequired[HierarchyPathTypeDef], # (1)
Tags: NotRequired[Dict[str, str]],
DescribeUserHierarchyStructureResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeUserHierarchyStructureResponseTypeDef
def get_value() -> DescribeUserHierarchyStructureResponseTypeDef:
return {
"HierarchyStructure": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeUserHierarchyStructureResponseTypeDef(TypedDict):
HierarchyStructure: HierarchyStructureTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateUserHierarchyStructureRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateUserHierarchyStructureRequestRequestTypeDef
def get_value() -> UpdateUserHierarchyStructureRequestRequestTypeDef:
return {
"HierarchyStructure": ...,
"InstanceId": ...,
}
Definition
class UpdateUserHierarchyStructureRequestRequestTypeDef(TypedDict):
HierarchyStructure: HierarchyStructureUpdateTypeDef, # (1)
InstanceId: str,
GetMetricDataRequestGetMetricDataPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetMetricDataRequestGetMetricDataPaginateTypeDef
def get_value() -> GetMetricDataRequestGetMetricDataPaginateTypeDef:
return {
"InstanceId": ...,
"StartTime": ...,
"EndTime": ...,
"Filters": ...,
"HistoricalMetrics": ...,
}
Definition
class GetMetricDataRequestGetMetricDataPaginateTypeDef(TypedDict):
InstanceId: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
Filters: FiltersTypeDef, # (1)
HistoricalMetrics: Sequence[HistoricalMetricTypeDef], # (2)
Groupings: NotRequired[Sequence[GroupingType]], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See FiltersTypeDef
- See HistoricalMetricTypeDef
- See GroupingType
- See PaginatorConfigTypeDef
GetMetricDataRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetMetricDataRequestRequestTypeDef
def get_value() -> GetMetricDataRequestRequestTypeDef:
return {
"InstanceId": ...,
"StartTime": ...,
"EndTime": ...,
"Filters": ...,
"HistoricalMetrics": ...,
}
Definition
class GetMetricDataRequestRequestTypeDef(TypedDict):
InstanceId: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
Filters: FiltersTypeDef, # (1)
HistoricalMetrics: Sequence[HistoricalMetricTypeDef], # (2)
Groupings: NotRequired[Sequence[GroupingType]], # (3)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See FiltersTypeDef
- See HistoricalMetricTypeDef
- See GroupingType
HistoricalMetricDataTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HistoricalMetricDataTypeDef
def get_value() -> HistoricalMetricDataTypeDef:
return {
"Metric": ...,
}
Definition
class HistoricalMetricDataTypeDef(TypedDict):
Metric: NotRequired[HistoricalMetricTypeDef], # (1)
Value: NotRequired[float],
CreateHoursOfOperationRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateHoursOfOperationRequestRequestTypeDef
def get_value() -> CreateHoursOfOperationRequestRequestTypeDef:
return {
"InstanceId": ...,
"Name": ...,
"TimeZone": ...,
"Config": ...,
}
Definition
class CreateHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
TimeZone: str,
Config: Sequence[HoursOfOperationConfigTypeDef], # (1)
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
HoursOfOperationTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HoursOfOperationTypeDef
def get_value() -> HoursOfOperationTypeDef:
return {
"HoursOfOperationId": ...,
}
Definition
class HoursOfOperationTypeDef(TypedDict):
HoursOfOperationId: NotRequired[str],
HoursOfOperationArn: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
TimeZone: NotRequired[str],
Config: NotRequired[List[HoursOfOperationConfigTypeDef]], # (1)
Tags: NotRequired[Dict[str, str]],
UpdateHoursOfOperationRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateHoursOfOperationRequestRequestTypeDef
def get_value() -> UpdateHoursOfOperationRequestRequestTypeDef:
return {
"InstanceId": ...,
"HoursOfOperationId": ...,
}
Definition
class UpdateHoursOfOperationRequestRequestTypeDef(TypedDict):
InstanceId: str,
HoursOfOperationId: str,
Name: NotRequired[str],
Description: NotRequired[str],
TimeZone: NotRequired[str],
Config: NotRequired[Sequence[HoursOfOperationConfigTypeDef]], # (1)
DescribeInstanceResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeInstanceResponseTypeDef
def get_value() -> DescribeInstanceResponseTypeDef:
return {
"Instance": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeInstanceResponseTypeDef(TypedDict):
Instance: InstanceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TaskTemplateConstraintsTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TaskTemplateConstraintsTypeDef
def get_value() -> TaskTemplateConstraintsTypeDef:
return {
"RequiredFields": ...,
}
Definition
class TaskTemplateConstraintsTypeDef(TypedDict):
RequiredFields: NotRequired[Sequence[RequiredFieldInfoTypeDef]], # (1)
ReadOnlyFields: NotRequired[Sequence[ReadOnlyFieldInfoTypeDef]], # (2)
InvisibleFields: NotRequired[Sequence[InvisibleFieldInfoTypeDef]], # (3)
TaskTemplateDefaultsTypeDef
Usage Example
from mypy_boto3_connect.type_defs import TaskTemplateDefaultsTypeDef
def get_value() -> TaskTemplateDefaultsTypeDef:
return {
"DefaultFieldValues": ...,
}
Definition
class TaskTemplateDefaultsTypeDef(TypedDict):
DefaultFieldValues: NotRequired[Sequence[TaskTemplateDefaultFieldValueTypeDef]], # (1)
GetMetricDataV2RequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetMetricDataV2RequestRequestTypeDef
def get_value() -> GetMetricDataV2RequestRequestTypeDef:
return {
"ResourceArn": ...,
"StartTime": ...,
"EndTime": ...,
"Filters": ...,
"Metrics": ...,
}
Definition
class GetMetricDataV2RequestRequestTypeDef(TypedDict):
ResourceArn: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
Filters: Sequence[FilterV2TypeDef], # (1)
Metrics: Sequence[MetricV2TypeDef], # (2)
Groupings: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See FilterV2TypeDef
- See MetricV2TypeDef
MetricDataV2TypeDef
Usage Example
from mypy_boto3_connect.type_defs import MetricDataV2TypeDef
def get_value() -> MetricDataV2TypeDef:
return {
"Metric": ...,
}
Definition
class MetricDataV2TypeDef(TypedDict):
Metric: NotRequired[MetricV2TypeDef], # (1)
Value: NotRequired[float],
- See MetricV2TypeDef
ChatParticipantRoleConfigTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ChatParticipantRoleConfigTypeDef
def get_value() -> ChatParticipantRoleConfigTypeDef:
return {
"ParticipantTimerConfigList": ...,
}
Definition
class ChatParticipantRoleConfigTypeDef(TypedDict):
ParticipantTimerConfigList: Sequence[ParticipantTimerConfigurationTypeDef], # (1)
CreateQuickConnectRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateQuickConnectRequestRequestTypeDef
def get_value() -> CreateQuickConnectRequestRequestTypeDef:
return {
"InstanceId": ...,
"Name": ...,
"QuickConnectConfig": ...,
}
Definition
class CreateQuickConnectRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
QuickConnectConfig: QuickConnectConfigTypeDef, # (1)
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
QuickConnectTypeDef
Usage Example
from mypy_boto3_connect.type_defs import QuickConnectTypeDef
def get_value() -> QuickConnectTypeDef:
return {
"QuickConnectARN": ...,
}
Definition
class QuickConnectTypeDef(TypedDict):
QuickConnectARN: NotRequired[str],
QuickConnectId: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
QuickConnectConfig: NotRequired[QuickConnectConfigTypeDef], # (1)
Tags: NotRequired[Dict[str, str]],
UpdateQuickConnectConfigRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateQuickConnectConfigRequestRequestTypeDef
def get_value() -> UpdateQuickConnectConfigRequestRequestTypeDef:
return {
"InstanceId": ...,
"QuickConnectId": ...,
"QuickConnectConfig": ...,
}
Definition
class UpdateQuickConnectConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
QuickConnectId: str,
QuickConnectConfig: QuickConnectConfigTypeDef, # (1)
ListContactReferencesResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListContactReferencesResponseTypeDef
def get_value() -> ListContactReferencesResponseTypeDef:
return {
"ReferenceSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListContactReferencesResponseTypeDef(TypedDict):
ReferenceSummaryList: List[ReferenceSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RuleActionTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RuleActionTypeDef
def get_value() -> RuleActionTypeDef:
return {
"ActionType": ...,
}
Definition
class RuleActionTypeDef(TypedDict):
ActionType: ActionTypeType, # (1)
TaskAction: NotRequired[TaskActionDefinitionTypeDef], # (2)
EventBridgeAction: NotRequired[EventBridgeActionDefinitionTypeDef], # (3)
AssignContactCategoryAction: NotRequired[Mapping[str, Any]],
SendNotificationAction: NotRequired[SendNotificationActionDefinitionTypeDef], # (4)
- See ActionTypeType
- See TaskActionDefinitionTypeDef
- See EventBridgeActionDefinitionTypeDef
- See SendNotificationActionDefinitionTypeDef
SearchUsersResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchUsersResponseTypeDef
def get_value() -> SearchUsersResponseTypeDef:
return {
"Users": ...,
"NextToken": ...,
"ApproximateTotalCount": ...,
"ResponseMetadata": ...,
}
Definition
class SearchUsersResponseTypeDef(TypedDict):
Users: List[UserSearchSummaryTypeDef], # (1)
NextToken: str,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchQueuesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchQueuesRequestRequestTypeDef
def get_value() -> SearchQueuesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class SearchQueuesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[QueueSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[QueueSearchCriteriaTypeDef], # (2)
SearchQueuesRequestSearchQueuesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchQueuesRequestSearchQueuesPaginateTypeDef
def get_value() -> SearchQueuesRequestSearchQueuesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class SearchQueuesRequestSearchQueuesPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[QueueSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[QueueSearchCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
SearchRoutingProfilesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchRoutingProfilesRequestRequestTypeDef
def get_value() -> SearchRoutingProfilesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class SearchRoutingProfilesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[RoutingProfileSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[RoutingProfileSearchCriteriaTypeDef], # (2)
SearchRoutingProfilesRequestSearchRoutingProfilesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchRoutingProfilesRequestSearchRoutingProfilesPaginateTypeDef
def get_value() -> SearchRoutingProfilesRequestSearchRoutingProfilesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class SearchRoutingProfilesRequestSearchRoutingProfilesPaginateTypeDef(TypedDict):
InstanceId: str,
SearchFilter: NotRequired[RoutingProfileSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[RoutingProfileSearchCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See RoutingProfileSearchFilterTypeDef
- See RoutingProfileSearchCriteriaTypeDef
- See PaginatorConfigTypeDef
SearchSecurityProfilesRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchSecurityProfilesRequestRequestTypeDef
def get_value() -> SearchSecurityProfilesRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class SearchSecurityProfilesRequestRequestTypeDef(TypedDict):
InstanceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchCriteria: NotRequired[SecurityProfileSearchCriteriaTypeDef], # (1)
SearchFilter: NotRequired[SecurityProfilesSearchFilterTypeDef], # (2)
SearchSecurityProfilesRequestSearchSecurityProfilesPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchSecurityProfilesRequestSearchSecurityProfilesPaginateTypeDef
def get_value() -> SearchSecurityProfilesRequestSearchSecurityProfilesPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class SearchSecurityProfilesRequestSearchSecurityProfilesPaginateTypeDef(TypedDict):
InstanceId: str,
SearchCriteria: NotRequired[SecurityProfileSearchCriteriaTypeDef], # (1)
SearchFilter: NotRequired[SecurityProfilesSearchFilterTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See SecurityProfileSearchCriteriaTypeDef
- See SecurityProfilesSearchFilterTypeDef
- See PaginatorConfigTypeDef
SearchUsersRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchUsersRequestRequestTypeDef
def get_value() -> SearchUsersRequestRequestTypeDef:
return {
"InstanceId": ...,
}
Definition
class SearchUsersRequestRequestTypeDef(TypedDict):
InstanceId: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFilter: NotRequired[UserSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[UserSearchCriteriaTypeDef], # (2)
SearchUsersRequestSearchUsersPaginateTypeDef
Usage Example
from mypy_boto3_connect.type_defs import SearchUsersRequestSearchUsersPaginateTypeDef
def get_value() -> SearchUsersRequestSearchUsersPaginateTypeDef:
return {
"InstanceId": ...,
}
Definition
class SearchUsersRequestSearchUsersPaginateTypeDef(TypedDict):
InstanceId: NotRequired[str],
SearchFilter: NotRequired[UserSearchFilterTypeDef], # (1)
SearchCriteria: NotRequired[UserSearchCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
GetCurrentMetricDataResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetCurrentMetricDataResponseTypeDef
def get_value() -> GetCurrentMetricDataResponseTypeDef:
return {
"NextToken": ...,
"MetricResults": ...,
"DataSnapshotTime": ...,
"ApproximateTotalCount": ...,
"ResponseMetadata": ...,
}
Definition
class GetCurrentMetricDataResponseTypeDef(TypedDict):
NextToken: str,
MetricResults: List[CurrentMetricResultTypeDef], # (1)
DataSnapshotTime: datetime,
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssociateInstanceStorageConfigRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import AssociateInstanceStorageConfigRequestRequestTypeDef
def get_value() -> AssociateInstanceStorageConfigRequestRequestTypeDef:
return {
"InstanceId": ...,
"ResourceType": ...,
"StorageConfig": ...,
}
Definition
class AssociateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
StorageConfig: InstanceStorageConfigTypeDef, # (2)
DescribeInstanceStorageConfigResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeInstanceStorageConfigResponseTypeDef
def get_value() -> DescribeInstanceStorageConfigResponseTypeDef:
return {
"StorageConfig": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeInstanceStorageConfigResponseTypeDef(TypedDict):
StorageConfig: InstanceStorageConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListInstanceStorageConfigsResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import ListInstanceStorageConfigsResponseTypeDef
def get_value() -> ListInstanceStorageConfigsResponseTypeDef:
return {
"StorageConfigs": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListInstanceStorageConfigsResponseTypeDef(TypedDict):
StorageConfigs: List[InstanceStorageConfigTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateInstanceStorageConfigRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateInstanceStorageConfigRequestRequestTypeDef
def get_value() -> UpdateInstanceStorageConfigRequestRequestTypeDef:
return {
"InstanceId": ...,
"AssociationId": ...,
"ResourceType": ...,
"StorageConfig": ...,
}
Definition
class UpdateInstanceStorageConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
StorageConfig: InstanceStorageConfigTypeDef, # (2)
GetCurrentUserDataResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetCurrentUserDataResponseTypeDef
def get_value() -> GetCurrentUserDataResponseTypeDef:
return {
"NextToken": ...,
"UserDataList": ...,
"ApproximateTotalCount": ...,
"ResponseMetadata": ...,
}
Definition
class GetCurrentUserDataResponseTypeDef(TypedDict):
NextToken: str,
UserDataList: List[UserDataTypeDef], # (1)
ApproximateTotalCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeUserHierarchyGroupResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeUserHierarchyGroupResponseTypeDef
def get_value() -> DescribeUserHierarchyGroupResponseTypeDef:
return {
"HierarchyGroup": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeUserHierarchyGroupResponseTypeDef(TypedDict):
HierarchyGroup: HierarchyGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
HistoricalMetricResultTypeDef
Usage Example
from mypy_boto3_connect.type_defs import HistoricalMetricResultTypeDef
def get_value() -> HistoricalMetricResultTypeDef:
return {
"Dimensions": ...,
}
Definition
class HistoricalMetricResultTypeDef(TypedDict):
Dimensions: NotRequired[DimensionsTypeDef], # (1)
Collections: NotRequired[List[HistoricalMetricDataTypeDef]], # (2)
DescribeHoursOfOperationResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeHoursOfOperationResponseTypeDef
def get_value() -> DescribeHoursOfOperationResponseTypeDef:
return {
"HoursOfOperation": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeHoursOfOperationResponseTypeDef(TypedDict):
HoursOfOperation: HoursOfOperationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateTaskTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateTaskTemplateRequestRequestTypeDef
def get_value() -> CreateTaskTemplateRequestRequestTypeDef:
return {
"InstanceId": ...,
"Name": ...,
"Fields": ...,
}
Definition
class CreateTaskTemplateRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
Fields: Sequence[TaskTemplateFieldTypeDef], # (1)
Description: NotRequired[str],
ContactFlowId: NotRequired[str],
Constraints: NotRequired[TaskTemplateConstraintsTypeDef], # (2)
Defaults: NotRequired[TaskTemplateDefaultsTypeDef], # (3)
Status: NotRequired[TaskTemplateStatusType], # (4)
ClientToken: NotRequired[str],
- See TaskTemplateFieldTypeDef
- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateStatusType
GetTaskTemplateResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetTaskTemplateResponseTypeDef
def get_value() -> GetTaskTemplateResponseTypeDef:
return {
"InstanceId": ...,
"Id": ...,
"Arn": ...,
"Name": ...,
"Description": ...,
"ContactFlowId": ...,
"Constraints": ...,
"Defaults": ...,
"Fields": ...,
"Status": ...,
"LastModifiedTime": ...,
"CreatedTime": ...,
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class GetTaskTemplateResponseTypeDef(TypedDict):
InstanceId: str,
Id: str,
Arn: str,
Name: str,
Description: str,
ContactFlowId: str,
Constraints: TaskTemplateConstraintsTypeDef, # (1)
Defaults: TaskTemplateDefaultsTypeDef, # (2)
Fields: List[TaskTemplateFieldTypeDef], # (3)
Status: TaskTemplateStatusType, # (4)
LastModifiedTime: datetime,
CreatedTime: datetime,
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateFieldTypeDef
- See TaskTemplateStatusType
- See ResponseMetadataTypeDef
UpdateTaskTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateTaskTemplateRequestRequestTypeDef
def get_value() -> UpdateTaskTemplateRequestRequestTypeDef:
return {
"TaskTemplateId": ...,
"InstanceId": ...,
}
Definition
class UpdateTaskTemplateRequestRequestTypeDef(TypedDict):
TaskTemplateId: str,
InstanceId: str,
Name: NotRequired[str],
Description: NotRequired[str],
ContactFlowId: NotRequired[str],
Constraints: NotRequired[TaskTemplateConstraintsTypeDef], # (1)
Defaults: NotRequired[TaskTemplateDefaultsTypeDef], # (2)
Status: NotRequired[TaskTemplateStatusType], # (3)
Fields: NotRequired[Sequence[TaskTemplateFieldTypeDef]], # (4)
- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateStatusType
- See TaskTemplateFieldTypeDef
UpdateTaskTemplateResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateTaskTemplateResponseTypeDef
def get_value() -> UpdateTaskTemplateResponseTypeDef:
return {
"InstanceId": ...,
"Id": ...,
"Arn": ...,
"Name": ...,
"Description": ...,
"ContactFlowId": ...,
"Constraints": ...,
"Defaults": ...,
"Fields": ...,
"Status": ...,
"LastModifiedTime": ...,
"CreatedTime": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateTaskTemplateResponseTypeDef(TypedDict):
InstanceId: str,
Id: str,
Arn: str,
Name: str,
Description: str,
ContactFlowId: str,
Constraints: TaskTemplateConstraintsTypeDef, # (1)
Defaults: TaskTemplateDefaultsTypeDef, # (2)
Fields: List[TaskTemplateFieldTypeDef], # (3)
Status: TaskTemplateStatusType, # (4)
LastModifiedTime: datetime,
CreatedTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateFieldTypeDef
- See TaskTemplateStatusType
- See ResponseMetadataTypeDef
MetricResultV2TypeDef
Usage Example
from mypy_boto3_connect.type_defs import MetricResultV2TypeDef
def get_value() -> MetricResultV2TypeDef:
return {
"Dimensions": ...,
}
Definition
class MetricResultV2TypeDef(TypedDict):
Dimensions: NotRequired[Dict[str, str]],
Collections: NotRequired[List[MetricDataV2TypeDef]], # (1)
UpdateParticipantRoleConfigChannelInfoTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateParticipantRoleConfigChannelInfoTypeDef
def get_value() -> UpdateParticipantRoleConfigChannelInfoTypeDef:
return {
"Chat": ...,
}
Definition
class UpdateParticipantRoleConfigChannelInfoTypeDef(TypedDict):
Chat: NotRequired[ChatParticipantRoleConfigTypeDef], # (1)
DescribeQuickConnectResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeQuickConnectResponseTypeDef
def get_value() -> DescribeQuickConnectResponseTypeDef:
return {
"QuickConnect": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeQuickConnectResponseTypeDef(TypedDict):
QuickConnect: QuickConnectTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import CreateRuleRequestRequestTypeDef
def get_value() -> CreateRuleRequestRequestTypeDef:
return {
"InstanceId": ...,
"Name": ...,
"TriggerEventSource": ...,
"Function": ...,
"Actions": ...,
"PublishStatus": ...,
}
Definition
class CreateRuleRequestRequestTypeDef(TypedDict):
InstanceId: str,
Name: str,
TriggerEventSource: RuleTriggerEventSourceTypeDef, # (1)
Function: str,
Actions: Sequence[RuleActionTypeDef], # (2)
PublishStatus: RulePublishStatusType, # (3)
ClientToken: NotRequired[str],
RuleTypeDef
Usage Example
from mypy_boto3_connect.type_defs import RuleTypeDef
def get_value() -> RuleTypeDef:
return {
"Name": ...,
"RuleId": ...,
"RuleArn": ...,
"TriggerEventSource": ...,
"Function": ...,
"Actions": ...,
"PublishStatus": ...,
"CreatedTime": ...,
"LastUpdatedTime": ...,
"LastUpdatedBy": ...,
}
Definition
class RuleTypeDef(TypedDict):
Name: str,
RuleId: str,
RuleArn: str,
TriggerEventSource: RuleTriggerEventSourceTypeDef, # (1)
Function: str,
Actions: List[RuleActionTypeDef], # (2)
PublishStatus: RulePublishStatusType, # (3)
CreatedTime: datetime,
LastUpdatedTime: datetime,
LastUpdatedBy: str,
Tags: NotRequired[Dict[str, str]],
UpdateRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateRuleRequestRequestTypeDef
def get_value() -> UpdateRuleRequestRequestTypeDef:
return {
"RuleId": ...,
"InstanceId": ...,
"Name": ...,
"Function": ...,
"Actions": ...,
"PublishStatus": ...,
}
Definition
class UpdateRuleRequestRequestTypeDef(TypedDict):
RuleId: str,
InstanceId: str,
Name: str,
Function: str,
Actions: Sequence[RuleActionTypeDef], # (1)
PublishStatus: RulePublishStatusType, # (2)
GetMetricDataResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetMetricDataResponseTypeDef
def get_value() -> GetMetricDataResponseTypeDef:
return {
"NextToken": ...,
"MetricResults": ...,
"ResponseMetadata": ...,
}
Definition
class GetMetricDataResponseTypeDef(TypedDict):
NextToken: str,
MetricResults: List[HistoricalMetricResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetMetricDataV2ResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import GetMetricDataV2ResponseTypeDef
def get_value() -> GetMetricDataV2ResponseTypeDef:
return {
"NextToken": ...,
"MetricResults": ...,
"ResponseMetadata": ...,
}
Definition
class GetMetricDataV2ResponseTypeDef(TypedDict):
NextToken: str,
MetricResults: List[MetricResultV2TypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateParticipantRoleConfigRequestRequestTypeDef
Usage Example
from mypy_boto3_connect.type_defs import UpdateParticipantRoleConfigRequestRequestTypeDef
def get_value() -> UpdateParticipantRoleConfigRequestRequestTypeDef:
return {
"InstanceId": ...,
"ContactId": ...,
"ChannelConfiguration": ...,
}
Definition
class UpdateParticipantRoleConfigRequestRequestTypeDef(TypedDict):
InstanceId: str,
ContactId: str,
ChannelConfiguration: UpdateParticipantRoleConfigChannelInfoTypeDef, # (1)
DescribeRuleResponseTypeDef
Usage Example
from mypy_boto3_connect.type_defs import DescribeRuleResponseTypeDef
def get_value() -> DescribeRuleResponseTypeDef:
return {
"Rule": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeRuleResponseTypeDef(TypedDict):
Rule: RuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See RuleTypeDef
- See ResponseMetadataTypeDef