mypydantic.models.connect
1# Model Generated: Thu Mar 2 21:56:17 2023 2 3from __future__ import annotations 4 5from datetime import datetime 6from typing import Any, Dict, List, Literal, Mapping, Optional, Sequence, Union 7 8from pydantic import Field 9 10from mypydantic.models.base_model import BaseModel 11 12 13class ActionSummaryModel(BaseModel): 14 action_type: Literal[ 15 "ASSIGN_CONTACT_CATEGORY", 16 "CREATE_TASK", 17 "GENERATE_EVENTBRIDGE_EVENT", 18 "SEND_NOTIFICATION", 19 ] = Field(alias="ActionType") 20 21 22class QueueReferenceModel(BaseModel): 23 id: Optional[str] = Field(default=None, alias="Id") 24 arn: Optional[str] = Field(default=None, alias="Arn") 25 26 27class AgentInfoModel(BaseModel): 28 id: Optional[str] = Field(default=None, alias="Id") 29 connected_to_agent_timestamp: Optional[datetime] = Field( 30 default=None, alias="ConnectedToAgentTimestamp" 31 ) 32 33 34class AgentStatusReferenceModel(BaseModel): 35 status_start_timestamp: Optional[datetime] = Field( 36 default=None, alias="StatusStartTimestamp" 37 ) 38 status_arn: Optional[str] = Field(default=None, alias="StatusArn") 39 status_name: Optional[str] = Field(default=None, alias="StatusName") 40 41 42class AgentStatusSummaryModel(BaseModel): 43 id: Optional[str] = Field(default=None, alias="Id") 44 arn: Optional[str] = Field(default=None, alias="Arn") 45 name: Optional[str] = Field(default=None, alias="Name") 46 type: Optional[Literal["CUSTOM", "OFFLINE", "ROUTABLE"]] = Field( 47 default=None, alias="Type" 48 ) 49 50 51class AgentStatusModel(BaseModel): 52 agent_status_arn: Optional[str] = Field(default=None, alias="AgentStatusARN") 53 agent_status_id: Optional[str] = Field(default=None, alias="AgentStatusId") 54 name: Optional[str] = Field(default=None, alias="Name") 55 description: Optional[str] = Field(default=None, alias="Description") 56 type: Optional[Literal["CUSTOM", "OFFLINE", "ROUTABLE"]] = Field( 57 default=None, alias="Type" 58 ) 59 display_order: Optional[int] = Field(default=None, alias="DisplayOrder") 60 state: Optional[Literal["DISABLED", "ENABLED"]] = Field(default=None, alias="State") 61 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 62 63 64class AnswerMachineDetectionConfigModel(BaseModel): 65 enable_answer_machine_detection: Optional[bool] = Field( 66 default=None, alias="EnableAnswerMachineDetection" 67 ) 68 await_answer_machine_prompt: Optional[bool] = Field( 69 default=None, alias="AwaitAnswerMachinePrompt" 70 ) 71 72 73class AssociateApprovedOriginRequestModel(BaseModel): 74 instance_id: str = Field(alias="InstanceId") 75 origin: str = Field(alias="Origin") 76 77 78class LexBotModel(BaseModel): 79 name: str = Field(alias="Name") 80 lex_region: str = Field(alias="LexRegion") 81 82 83class LexV2BotModel(BaseModel): 84 alias_arn: Optional[str] = Field(default=None, alias="AliasArn") 85 86 87class AssociateDefaultVocabularyRequestModel(BaseModel): 88 instance_id: str = Field(alias="InstanceId") 89 language_code: Literal[ 90 "ar-AE", 91 "de-CH", 92 "de-DE", 93 "en-AB", 94 "en-AU", 95 "en-GB", 96 "en-IE", 97 "en-IN", 98 "en-NZ", 99 "en-US", 100 "en-WL", 101 "en-ZA", 102 "es-ES", 103 "es-US", 104 "fr-CA", 105 "fr-FR", 106 "hi-IN", 107 "it-IT", 108 "ja-JP", 109 "ko-KR", 110 "pt-BR", 111 "pt-PT", 112 "zh-CN", 113 ] = Field(alias="LanguageCode") 114 vocabulary_id: Optional[str] = Field(default=None, alias="VocabularyId") 115 116 117class ResponseMetadataModel(BaseModel): 118 request_id: str = Field(alias="RequestId") 119 host_id: str = Field(alias="HostId") 120 http_status_code: int = Field(alias="HTTPStatusCode") 121 http_headers: Dict[str, str] = Field(alias="HTTPHeaders") 122 retry_attempts: int = Field(alias="RetryAttempts") 123 124 125class AssociateLambdaFunctionRequestModel(BaseModel): 126 instance_id: str = Field(alias="InstanceId") 127 function_arn: str = Field(alias="FunctionArn") 128 129 130class AssociatePhoneNumberContactFlowRequestModel(BaseModel): 131 phone_number_id: str = Field(alias="PhoneNumberId") 132 instance_id: str = Field(alias="InstanceId") 133 contact_flow_id: str = Field(alias="ContactFlowId") 134 135 136class AssociateQueueQuickConnectsRequestModel(BaseModel): 137 instance_id: str = Field(alias="InstanceId") 138 queue_id: str = Field(alias="QueueId") 139 quick_connect_ids: Sequence[str] = Field(alias="QuickConnectIds") 140 141 142class AssociateSecurityKeyRequestModel(BaseModel): 143 instance_id: str = Field(alias="InstanceId") 144 key: str = Field(alias="Key") 145 146 147class AttachmentReferenceModel(BaseModel): 148 name: Optional[str] = Field(default=None, alias="Name") 149 value: Optional[str] = Field(default=None, alias="Value") 150 status: Optional[Literal["APPROVED", "REJECTED"]] = Field( 151 default=None, alias="Status" 152 ) 153 154 155class AttributeModel(BaseModel): 156 attribute_type: Optional[ 157 Literal[ 158 "AUTO_RESOLVE_BEST_VOICES", 159 "CONTACTFLOW_LOGS", 160 "CONTACT_LENS", 161 "EARLY_MEDIA", 162 "ENHANCED_CONTACT_MONITORING", 163 "HIGH_VOLUME_OUTBOUND", 164 "INBOUND_CALLS", 165 "MULTI_PARTY_CONFERENCE", 166 "OUTBOUND_CALLS", 167 "USE_CUSTOM_TTS_VOICES", 168 ] 169 ] = Field(default=None, alias="AttributeType") 170 value: Optional[str] = Field(default=None, alias="Value") 171 172 173class AvailableNumberSummaryModel(BaseModel): 174 phone_number: Optional[str] = Field(default=None, alias="PhoneNumber") 175 phone_number_country_code: Optional[ 176 Literal[ 177 "AD", 178 "AE", 179 "AF", 180 "AG", 181 "AI", 182 "AL", 183 "AM", 184 "AN", 185 "AO", 186 "AQ", 187 "AR", 188 "AS", 189 "AT", 190 "AU", 191 "AW", 192 "AZ", 193 "BA", 194 "BB", 195 "BD", 196 "BE", 197 "BF", 198 "BG", 199 "BH", 200 "BI", 201 "BJ", 202 "BL", 203 "BM", 204 "BN", 205 "BO", 206 "BR", 207 "BS", 208 "BT", 209 "BW", 210 "BY", 211 "BZ", 212 "CA", 213 "CC", 214 "CD", 215 "CF", 216 "CG", 217 "CH", 218 "CI", 219 "CK", 220 "CL", 221 "CM", 222 "CN", 223 "CO", 224 "CR", 225 "CU", 226 "CV", 227 "CW", 228 "CX", 229 "CY", 230 "CZ", 231 "DE", 232 "DJ", 233 "DK", 234 "DM", 235 "DO", 236 "DZ", 237 "EC", 238 "EE", 239 "EG", 240 "EH", 241 "ER", 242 "ES", 243 "ET", 244 "FI", 245 "FJ", 246 "FK", 247 "FM", 248 "FO", 249 "FR", 250 "GA", 251 "GB", 252 "GD", 253 "GE", 254 "GG", 255 "GH", 256 "GI", 257 "GL", 258 "GM", 259 "GN", 260 "GQ", 261 "GR", 262 "GT", 263 "GU", 264 "GW", 265 "GY", 266 "HK", 267 "HN", 268 "HR", 269 "HT", 270 "HU", 271 "ID", 272 "IE", 273 "IL", 274 "IM", 275 "IN", 276 "Type[IO]", 277 "IQ", 278 "IR", 279 "IS", 280 "IT", 281 "JE", 282 "JM", 283 "JO", 284 "JP", 285 "KE", 286 "KG", 287 "KH", 288 "KI", 289 "KM", 290 "KN", 291 "KP", 292 "KR", 293 "KW", 294 "KY", 295 "KZ", 296 "LA", 297 "LB", 298 "LC", 299 "LI", 300 "LK", 301 "LR", 302 "LS", 303 "LT", 304 "LU", 305 "LV", 306 "LY", 307 "MA", 308 "MC", 309 "MD", 310 "ME", 311 "MF", 312 "MG", 313 "MH", 314 "MK", 315 "ML", 316 "MM", 317 "MN", 318 "MO", 319 "MP", 320 "MR", 321 "MS", 322 "MT", 323 "MU", 324 "MV", 325 "MW", 326 "MX", 327 "MY", 328 "MZ", 329 "NA", 330 "NC", 331 "NE", 332 "NG", 333 "NI", 334 "NL", 335 "NO", 336 "NP", 337 "NR", 338 "NU", 339 "NZ", 340 "OM", 341 "PA", 342 "PE", 343 "PF", 344 "PG", 345 "PH", 346 "PK", 347 "PL", 348 "PM", 349 "PN", 350 "PR", 351 "PT", 352 "PW", 353 "PY", 354 "QA", 355 "RE", 356 "RO", 357 "RS", 358 "RU", 359 "RW", 360 "SA", 361 "SB", 362 "SC", 363 "SD", 364 "SE", 365 "SG", 366 "SH", 367 "SI", 368 "SJ", 369 "SK", 370 "SL", 371 "SM", 372 "SN", 373 "SO", 374 "SR", 375 "ST", 376 "SV", 377 "SX", 378 "SY", 379 "SZ", 380 "TC", 381 "TD", 382 "TG", 383 "TH", 384 "TJ", 385 "TK", 386 "TL", 387 "TM", 388 "TN", 389 "TO", 390 "TR", 391 "TT", 392 "TV", 393 "TW", 394 "TZ", 395 "UA", 396 "UG", 397 "US", 398 "UY", 399 "UZ", 400 "VA", 401 "VC", 402 "VE", 403 "VG", 404 "VI", 405 "VN", 406 "VU", 407 "WF", 408 "WS", 409 "YE", 410 "YT", 411 "ZA", 412 "ZM", 413 "ZW", 414 ] 415 ] = Field(default=None, alias="PhoneNumberCountryCode") 416 phone_number_type: Optional[Literal["DID", "TOLL_FREE"]] = Field( 417 default=None, alias="PhoneNumberType" 418 ) 419 420 421class ChatMessageModel(BaseModel): 422 content_type: str = Field(alias="ContentType") 423 content: str = Field(alias="Content") 424 425 426class ChatStreamingConfigurationModel(BaseModel): 427 streaming_endpoint_arn: str = Field(alias="StreamingEndpointArn") 428 429 430class ClaimPhoneNumberRequestModel(BaseModel): 431 target_arn: str = Field(alias="TargetArn") 432 phone_number: str = Field(alias="PhoneNumber") 433 phone_number_description: Optional[str] = Field( 434 default=None, alias="PhoneNumberDescription" 435 ) 436 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 437 client_token: Optional[str] = Field(default=None, alias="ClientToken") 438 439 440class PhoneNumberStatusModel(BaseModel): 441 status: Optional[Literal["CLAIMED", "FAILED", "IN_PROGRESS"]] = Field( 442 default=None, alias="Status" 443 ) 444 message: Optional[str] = Field(default=None, alias="Message") 445 446 447class ContactFilterModel(BaseModel): 448 contact_states: Optional[ 449 Sequence[ 450 Literal[ 451 "CONNECTED", 452 "CONNECTED_ONHOLD", 453 "CONNECTING", 454 "ENDED", 455 "ERROR", 456 "INCOMING", 457 "MISSED", 458 "PENDING", 459 "REJECTED", 460 ] 461 ] 462 ] = Field(default=None, alias="ContactStates") 463 464 465class ContactFlowModuleSummaryModel(BaseModel): 466 id: Optional[str] = Field(default=None, alias="Id") 467 arn: Optional[str] = Field(default=None, alias="Arn") 468 name: Optional[str] = Field(default=None, alias="Name") 469 state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field(default=None, alias="State") 470 471 472class ContactFlowModuleModel(BaseModel): 473 arn: Optional[str] = Field(default=None, alias="Arn") 474 id: Optional[str] = Field(default=None, alias="Id") 475 name: Optional[str] = Field(default=None, alias="Name") 476 content: Optional[str] = Field(default=None, alias="Content") 477 description: Optional[str] = Field(default=None, alias="Description") 478 state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field(default=None, alias="State") 479 status: Optional[Literal["PUBLISHED", "SAVED"]] = Field( 480 default=None, alias="Status" 481 ) 482 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 483 484 485class ContactFlowSummaryModel(BaseModel): 486 id: Optional[str] = Field(default=None, alias="Id") 487 arn: Optional[str] = Field(default=None, alias="Arn") 488 name: Optional[str] = Field(default=None, alias="Name") 489 contact_flow_type: Optional[ 490 Literal[ 491 "AGENT_HOLD", 492 "AGENT_TRANSFER", 493 "AGENT_WHISPER", 494 "CONTACT_FLOW", 495 "CUSTOMER_HOLD", 496 "CUSTOMER_QUEUE", 497 "CUSTOMER_WHISPER", 498 "OUTBOUND_WHISPER", 499 "QUEUE_TRANSFER", 500 ] 501 ] = Field(default=None, alias="ContactFlowType") 502 contact_flow_state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field( 503 default=None, alias="ContactFlowState" 504 ) 505 506 507class ContactFlowModel(BaseModel): 508 arn: Optional[str] = Field(default=None, alias="Arn") 509 id: Optional[str] = Field(default=None, alias="Id") 510 name: Optional[str] = Field(default=None, alias="Name") 511 type: Optional[ 512 Literal[ 513 "AGENT_HOLD", 514 "AGENT_TRANSFER", 515 "AGENT_WHISPER", 516 "CONTACT_FLOW", 517 "CUSTOMER_HOLD", 518 "CUSTOMER_QUEUE", 519 "CUSTOMER_WHISPER", 520 "OUTBOUND_WHISPER", 521 "QUEUE_TRANSFER", 522 ] 523 ] = Field(default=None, alias="Type") 524 state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field(default=None, alias="State") 525 description: Optional[str] = Field(default=None, alias="Description") 526 content: Optional[str] = Field(default=None, alias="Content") 527 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 528 529 530class QueueInfoModel(BaseModel): 531 id: Optional[str] = Field(default=None, alias="Id") 532 enqueue_timestamp: Optional[datetime] = Field( 533 default=None, alias="EnqueueTimestamp" 534 ) 535 536 537class WisdomInfoModel(BaseModel): 538 session_arn: Optional[str] = Field(default=None, alias="SessionArn") 539 540 541class TagConditionModel(BaseModel): 542 tag_key: Optional[str] = Field(default=None, alias="TagKey") 543 tag_value: Optional[str] = Field(default=None, alias="TagValue") 544 545 546class CreateAgentStatusRequestModel(BaseModel): 547 instance_id: str = Field(alias="InstanceId") 548 name: str = Field(alias="Name") 549 state: Literal["DISABLED", "ENABLED"] = Field(alias="State") 550 description: Optional[str] = Field(default=None, alias="Description") 551 display_order: Optional[int] = Field(default=None, alias="DisplayOrder") 552 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 553 554 555class CreateContactFlowModuleRequestModel(BaseModel): 556 instance_id: str = Field(alias="InstanceId") 557 name: str = Field(alias="Name") 558 content: str = Field(alias="Content") 559 description: Optional[str] = Field(default=None, alias="Description") 560 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 561 client_token: Optional[str] = Field(default=None, alias="ClientToken") 562 563 564class CreateContactFlowRequestModel(BaseModel): 565 instance_id: str = Field(alias="InstanceId") 566 name: str = Field(alias="Name") 567 type: Literal[ 568 "AGENT_HOLD", 569 "AGENT_TRANSFER", 570 "AGENT_WHISPER", 571 "CONTACT_FLOW", 572 "CUSTOMER_HOLD", 573 "CUSTOMER_QUEUE", 574 "CUSTOMER_WHISPER", 575 "OUTBOUND_WHISPER", 576 "QUEUE_TRANSFER", 577 ] = Field(alias="Type") 578 content: str = Field(alias="Content") 579 description: Optional[str] = Field(default=None, alias="Description") 580 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 581 582 583class CreateInstanceRequestModel(BaseModel): 584 identity_management_type: Literal[ 585 "CONNECT_MANAGED", "EXISTING_DIRECTORY", "SAML" 586 ] = Field(alias="IdentityManagementType") 587 inbound_calls_enabled: bool = Field(alias="InboundCallsEnabled") 588 outbound_calls_enabled: bool = Field(alias="OutboundCallsEnabled") 589 client_token: Optional[str] = Field(default=None, alias="ClientToken") 590 instance_alias: Optional[str] = Field(default=None, alias="InstanceAlias") 591 directory_id: Optional[str] = Field(default=None, alias="DirectoryId") 592 593 594class CreateIntegrationAssociationRequestModel(BaseModel): 595 instance_id: str = Field(alias="InstanceId") 596 integration_type: Literal[ 597 "CASES_DOMAIN", 598 "EVENT", 599 "PINPOINT_APP", 600 "VOICE_ID", 601 "WISDOM_ASSISTANT", 602 "WISDOM_KNOWLEDGE_BASE", 603 ] = Field(alias="IntegrationType") 604 integration_arn: str = Field(alias="IntegrationArn") 605 source_application_url: Optional[str] = Field( 606 default=None, alias="SourceApplicationUrl" 607 ) 608 source_application_name: Optional[str] = Field( 609 default=None, alias="SourceApplicationName" 610 ) 611 source_type: Optional[Literal["SALESFORCE", "ZENDESK"]] = Field( 612 default=None, alias="SourceType" 613 ) 614 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 615 616 617class OutboundCallerConfigModel(BaseModel): 618 outbound_caller_id_name: Optional[str] = Field( 619 default=None, alias="OutboundCallerIdName" 620 ) 621 outbound_caller_id_number_id: Optional[str] = Field( 622 default=None, alias="OutboundCallerIdNumberId" 623 ) 624 outbound_flow_id: Optional[str] = Field(default=None, alias="OutboundFlowId") 625 626 627class MediaConcurrencyModel(BaseModel): 628 channel: Literal["CHAT", "TASK", "VOICE"] = Field(alias="Channel") 629 concurrency: int = Field(alias="Concurrency") 630 631 632class RuleTriggerEventSourceModel(BaseModel): 633 event_source_name: Literal[ 634 "OnPostCallAnalysisAvailable", 635 "OnPostChatAnalysisAvailable", 636 "OnRealTimeCallAnalysisAvailable", 637 "OnSalesforceCaseCreate", 638 "OnZendeskTicketCreate", 639 "OnZendeskTicketStatusUpdate", 640 ] = Field(alias="EventSourceName") 641 integration_association_id: Optional[str] = Field( 642 default=None, alias="IntegrationAssociationId" 643 ) 644 645 646class CreateSecurityProfileRequestModel(BaseModel): 647 security_profile_name: str = Field(alias="SecurityProfileName") 648 instance_id: str = Field(alias="InstanceId") 649 description: Optional[str] = Field(default=None, alias="Description") 650 permissions: Optional[Sequence[str]] = Field(default=None, alias="Permissions") 651 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 652 allowed_access_control_tags: Optional[Mapping[str, str]] = Field( 653 default=None, alias="AllowedAccessControlTags" 654 ) 655 tag_restricted_resources: Optional[Sequence[str]] = Field( 656 default=None, alias="TagRestrictedResources" 657 ) 658 659 660class CreateTrafficDistributionGroupRequestModel(BaseModel): 661 name: str = Field(alias="Name") 662 instance_id: str = Field(alias="InstanceId") 663 description: Optional[str] = Field(default=None, alias="Description") 664 client_token: Optional[str] = Field(default=None, alias="ClientToken") 665 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 666 667 668class CreateUseCaseRequestModel(BaseModel): 669 instance_id: str = Field(alias="InstanceId") 670 integration_association_id: str = Field(alias="IntegrationAssociationId") 671 use_case_type: Literal["CONNECT_CAMPAIGNS", "RULES_EVALUATION"] = Field( 672 alias="UseCaseType" 673 ) 674 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 675 676 677class CreateUserHierarchyGroupRequestModel(BaseModel): 678 name: str = Field(alias="Name") 679 instance_id: str = Field(alias="InstanceId") 680 parent_group_id: Optional[str] = Field(default=None, alias="ParentGroupId") 681 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 682 683 684class UserIdentityInfoModel(BaseModel): 685 first_name: Optional[str] = Field(default=None, alias="FirstName") 686 last_name: Optional[str] = Field(default=None, alias="LastName") 687 email: Optional[str] = Field(default=None, alias="Email") 688 secondary_email: Optional[str] = Field(default=None, alias="SecondaryEmail") 689 mobile: Optional[str] = Field(default=None, alias="Mobile") 690 691 692class UserPhoneConfigModel(BaseModel): 693 phone_type: Literal["DESK_PHONE", "SOFT_PHONE"] = Field(alias="PhoneType") 694 auto_accept: Optional[bool] = Field(default=None, alias="AutoAccept") 695 after_contact_work_time_limit: Optional[int] = Field( 696 default=None, alias="AfterContactWorkTimeLimit" 697 ) 698 desk_phone_number: Optional[str] = Field(default=None, alias="DeskPhoneNumber") 699 700 701class CreateVocabularyRequestModel(BaseModel): 702 instance_id: str = Field(alias="InstanceId") 703 vocabulary_name: str = Field(alias="VocabularyName") 704 language_code: Literal[ 705 "ar-AE", 706 "de-CH", 707 "de-DE", 708 "en-AB", 709 "en-AU", 710 "en-GB", 711 "en-IE", 712 "en-IN", 713 "en-NZ", 714 "en-US", 715 "en-WL", 716 "en-ZA", 717 "es-ES", 718 "es-US", 719 "fr-CA", 720 "fr-FR", 721 "hi-IN", 722 "it-IT", 723 "ja-JP", 724 "ko-KR", 725 "pt-BR", 726 "pt-PT", 727 "zh-CN", 728 ] = Field(alias="LanguageCode") 729 content: str = Field(alias="Content") 730 client_token: Optional[str] = Field(default=None, alias="ClientToken") 731 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 732 733 734class CredentialsModel(BaseModel): 735 access_token: Optional[str] = Field(default=None, alias="AccessToken") 736 access_token_expiration: Optional[datetime] = Field( 737 default=None, alias="AccessTokenExpiration" 738 ) 739 refresh_token: Optional[str] = Field(default=None, alias="RefreshToken") 740 refresh_token_expiration: Optional[datetime] = Field( 741 default=None, alias="RefreshTokenExpiration" 742 ) 743 744 745class CurrentMetricModel(BaseModel): 746 name: Optional[ 747 Literal[ 748 "AGENTS_AFTER_CONTACT_WORK", 749 "AGENTS_AVAILABLE", 750 "AGENTS_ERROR", 751 "AGENTS_NON_PRODUCTIVE", 752 "AGENTS_ONLINE", 753 "AGENTS_ON_CALL", 754 "AGENTS_ON_CONTACT", 755 "AGENTS_STAFFED", 756 "CONTACTS_IN_QUEUE", 757 "CONTACTS_SCHEDULED", 758 "OLDEST_CONTACT_AGE", 759 "SLOTS_ACTIVE", 760 "SLOTS_AVAILABLE", 761 ] 762 ] = Field(default=None, alias="Name") 763 unit: Optional[Literal["COUNT", "PERCENT", "SECONDS"]] = Field( 764 default=None, alias="Unit" 765 ) 766 767 768class CurrentMetricSortCriteriaModel(BaseModel): 769 sort_by_metric: Optional[ 770 Literal[ 771 "AGENTS_AFTER_CONTACT_WORK", 772 "AGENTS_AVAILABLE", 773 "AGENTS_ERROR", 774 "AGENTS_NON_PRODUCTIVE", 775 "AGENTS_ONLINE", 776 "AGENTS_ON_CALL", 777 "AGENTS_ON_CONTACT", 778 "AGENTS_STAFFED", 779 "CONTACTS_IN_QUEUE", 780 "CONTACTS_SCHEDULED", 781 "OLDEST_CONTACT_AGE", 782 "SLOTS_ACTIVE", 783 "SLOTS_AVAILABLE", 784 ] 785 ] = Field(default=None, alias="SortByMetric") 786 sort_order: Optional[Literal["ASCENDING", "DESCENDING"]] = Field( 787 default=None, alias="SortOrder" 788 ) 789 790 791class DateReferenceModel(BaseModel): 792 name: Optional[str] = Field(default=None, alias="Name") 793 value: Optional[str] = Field(default=None, alias="Value") 794 795 796class DefaultVocabularyModel(BaseModel): 797 instance_id: str = Field(alias="InstanceId") 798 language_code: Literal[ 799 "ar-AE", 800 "de-CH", 801 "de-DE", 802 "en-AB", 803 "en-AU", 804 "en-GB", 805 "en-IE", 806 "en-IN", 807 "en-NZ", 808 "en-US", 809 "en-WL", 810 "en-ZA", 811 "es-ES", 812 "es-US", 813 "fr-CA", 814 "fr-FR", 815 "hi-IN", 816 "it-IT", 817 "ja-JP", 818 "ko-KR", 819 "pt-BR", 820 "pt-PT", 821 "zh-CN", 822 ] = Field(alias="LanguageCode") 823 vocabulary_id: str = Field(alias="VocabularyId") 824 vocabulary_name: str = Field(alias="VocabularyName") 825 826 827class DeleteContactFlowModuleRequestModel(BaseModel): 828 instance_id: str = Field(alias="InstanceId") 829 contact_flow_module_id: str = Field(alias="ContactFlowModuleId") 830 831 832class DeleteContactFlowRequestModel(BaseModel): 833 instance_id: str = Field(alias="InstanceId") 834 contact_flow_id: str = Field(alias="ContactFlowId") 835 836 837class DeleteHoursOfOperationRequestModel(BaseModel): 838 instance_id: str = Field(alias="InstanceId") 839 hours_of_operation_id: str = Field(alias="HoursOfOperationId") 840 841 842class DeleteInstanceRequestModel(BaseModel): 843 instance_id: str = Field(alias="InstanceId") 844 845 846class DeleteIntegrationAssociationRequestModel(BaseModel): 847 instance_id: str = Field(alias="InstanceId") 848 integration_association_id: str = Field(alias="IntegrationAssociationId") 849 850 851class DeleteQuickConnectRequestModel(BaseModel): 852 instance_id: str = Field(alias="InstanceId") 853 quick_connect_id: str = Field(alias="QuickConnectId") 854 855 856class DeleteRuleRequestModel(BaseModel): 857 instance_id: str = Field(alias="InstanceId") 858 rule_id: str = Field(alias="RuleId") 859 860 861class DeleteSecurityProfileRequestModel(BaseModel): 862 instance_id: str = Field(alias="InstanceId") 863 security_profile_id: str = Field(alias="SecurityProfileId") 864 865 866class DeleteTaskTemplateRequestModel(BaseModel): 867 instance_id: str = Field(alias="InstanceId") 868 task_template_id: str = Field(alias="TaskTemplateId") 869 870 871class DeleteTrafficDistributionGroupRequestModel(BaseModel): 872 traffic_distribution_group_id: str = Field(alias="TrafficDistributionGroupId") 873 874 875class DeleteUseCaseRequestModel(BaseModel): 876 instance_id: str = Field(alias="InstanceId") 877 integration_association_id: str = Field(alias="IntegrationAssociationId") 878 use_case_id: str = Field(alias="UseCaseId") 879 880 881class DeleteUserHierarchyGroupRequestModel(BaseModel): 882 hierarchy_group_id: str = Field(alias="HierarchyGroupId") 883 instance_id: str = Field(alias="InstanceId") 884 885 886class DeleteUserRequestModel(BaseModel): 887 instance_id: str = Field(alias="InstanceId") 888 user_id: str = Field(alias="UserId") 889 890 891class DeleteVocabularyRequestModel(BaseModel): 892 instance_id: str = Field(alias="InstanceId") 893 vocabulary_id: str = Field(alias="VocabularyId") 894 895 896class DescribeAgentStatusRequestModel(BaseModel): 897 instance_id: str = Field(alias="InstanceId") 898 agent_status_id: str = Field(alias="AgentStatusId") 899 900 901class DescribeContactFlowModuleRequestModel(BaseModel): 902 instance_id: str = Field(alias="InstanceId") 903 contact_flow_module_id: str = Field(alias="ContactFlowModuleId") 904 905 906class DescribeContactFlowRequestModel(BaseModel): 907 instance_id: str = Field(alias="InstanceId") 908 contact_flow_id: str = Field(alias="ContactFlowId") 909 910 911class DescribeContactRequestModel(BaseModel): 912 instance_id: str = Field(alias="InstanceId") 913 contact_id: str = Field(alias="ContactId") 914 915 916class DescribeHoursOfOperationRequestModel(BaseModel): 917 instance_id: str = Field(alias="InstanceId") 918 hours_of_operation_id: str = Field(alias="HoursOfOperationId") 919 920 921class DescribeInstanceAttributeRequestModel(BaseModel): 922 instance_id: str = Field(alias="InstanceId") 923 attribute_type: Literal[ 924 "AUTO_RESOLVE_BEST_VOICES", 925 "CONTACTFLOW_LOGS", 926 "CONTACT_LENS", 927 "EARLY_MEDIA", 928 "ENHANCED_CONTACT_MONITORING", 929 "HIGH_VOLUME_OUTBOUND", 930 "INBOUND_CALLS", 931 "MULTI_PARTY_CONFERENCE", 932 "OUTBOUND_CALLS", 933 "USE_CUSTOM_TTS_VOICES", 934 ] = Field(alias="AttributeType") 935 936 937class DescribeInstanceRequestModel(BaseModel): 938 instance_id: str = Field(alias="InstanceId") 939 940 941class DescribeInstanceStorageConfigRequestModel(BaseModel): 942 instance_id: str = Field(alias="InstanceId") 943 association_id: str = Field(alias="AssociationId") 944 resource_type: Literal[ 945 "AGENT_EVENTS", 946 "ATTACHMENTS", 947 "CALL_RECORDINGS", 948 "CHAT_TRANSCRIPTS", 949 "CONTACT_EVALUATIONS", 950 "CONTACT_TRACE_RECORDS", 951 "MEDIA_STREAMS", 952 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 953 "SCHEDULED_REPORTS", 954 ] = Field(alias="ResourceType") 955 956 957class DescribePhoneNumberRequestModel(BaseModel): 958 phone_number_id: str = Field(alias="PhoneNumberId") 959 960 961class DescribeQueueRequestModel(BaseModel): 962 instance_id: str = Field(alias="InstanceId") 963 queue_id: str = Field(alias="QueueId") 964 965 966class DescribeQuickConnectRequestModel(BaseModel): 967 instance_id: str = Field(alias="InstanceId") 968 quick_connect_id: str = Field(alias="QuickConnectId") 969 970 971class DescribeRoutingProfileRequestModel(BaseModel): 972 instance_id: str = Field(alias="InstanceId") 973 routing_profile_id: str = Field(alias="RoutingProfileId") 974 975 976class DescribeRuleRequestModel(BaseModel): 977 instance_id: str = Field(alias="InstanceId") 978 rule_id: str = Field(alias="RuleId") 979 980 981class DescribeSecurityProfileRequestModel(BaseModel): 982 security_profile_id: str = Field(alias="SecurityProfileId") 983 instance_id: str = Field(alias="InstanceId") 984 985 986class SecurityProfileModel(BaseModel): 987 id: Optional[str] = Field(default=None, alias="Id") 988 organization_resource_id: Optional[str] = Field( 989 default=None, alias="OrganizationResourceId" 990 ) 991 arn: Optional[str] = Field(default=None, alias="Arn") 992 security_profile_name: Optional[str] = Field( 993 default=None, alias="SecurityProfileName" 994 ) 995 description: Optional[str] = Field(default=None, alias="Description") 996 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 997 allowed_access_control_tags: Optional[Dict[str, str]] = Field( 998 default=None, alias="AllowedAccessControlTags" 999 ) 1000 tag_restricted_resources: Optional[List[str]] = Field( 1001 default=None, alias="TagRestrictedResources" 1002 ) 1003 1004 1005class DescribeTrafficDistributionGroupRequestModel(BaseModel): 1006 traffic_distribution_group_id: str = Field(alias="TrafficDistributionGroupId") 1007 1008 1009class TrafficDistributionGroupModel(BaseModel): 1010 id: Optional[str] = Field(default=None, alias="Id") 1011 arn: Optional[str] = Field(default=None, alias="Arn") 1012 name: Optional[str] = Field(default=None, alias="Name") 1013 description: Optional[str] = Field(default=None, alias="Description") 1014 instance_arn: Optional[str] = Field(default=None, alias="InstanceArn") 1015 status: Optional[ 1016 Literal[ 1017 "ACTIVE", 1018 "CREATION_FAILED", 1019 "CREATION_IN_PROGRESS", 1020 "DELETION_FAILED", 1021 "PENDING_DELETION", 1022 "UPDATE_IN_PROGRESS", 1023 ] 1024 ] = Field(default=None, alias="Status") 1025 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 1026 1027 1028class DescribeUserHierarchyGroupRequestModel(BaseModel): 1029 hierarchy_group_id: str = Field(alias="HierarchyGroupId") 1030 instance_id: str = Field(alias="InstanceId") 1031 1032 1033class DescribeUserHierarchyStructureRequestModel(BaseModel): 1034 instance_id: str = Field(alias="InstanceId") 1035 1036 1037class DescribeUserRequestModel(BaseModel): 1038 user_id: str = Field(alias="UserId") 1039 instance_id: str = Field(alias="InstanceId") 1040 1041 1042class DescribeVocabularyRequestModel(BaseModel): 1043 instance_id: str = Field(alias="InstanceId") 1044 vocabulary_id: str = Field(alias="VocabularyId") 1045 1046 1047class VocabularyModel(BaseModel): 1048 name: str = Field(alias="Name") 1049 id: str = Field(alias="Id") 1050 arn: str = Field(alias="Arn") 1051 language_code: Literal[ 1052 "ar-AE", 1053 "de-CH", 1054 "de-DE", 1055 "en-AB", 1056 "en-AU", 1057 "en-GB", 1058 "en-IE", 1059 "en-IN", 1060 "en-NZ", 1061 "en-US", 1062 "en-WL", 1063 "en-ZA", 1064 "es-ES", 1065 "es-US", 1066 "fr-CA", 1067 "fr-FR", 1068 "hi-IN", 1069 "it-IT", 1070 "ja-JP", 1071 "ko-KR", 1072 "pt-BR", 1073 "pt-PT", 1074 "zh-CN", 1075 ] = Field(alias="LanguageCode") 1076 state: Literal[ 1077 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 1078 ] = Field(alias="State") 1079 last_modified_time: datetime = Field(alias="LastModifiedTime") 1080 failure_reason: Optional[str] = Field(default=None, alias="FailureReason") 1081 content: Optional[str] = Field(default=None, alias="Content") 1082 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 1083 1084 1085class RoutingProfileReferenceModel(BaseModel): 1086 id: Optional[str] = Field(default=None, alias="Id") 1087 arn: Optional[str] = Field(default=None, alias="Arn") 1088 1089 1090class DisassociateApprovedOriginRequestModel(BaseModel): 1091 instance_id: str = Field(alias="InstanceId") 1092 origin: str = Field(alias="Origin") 1093 1094 1095class DisassociateInstanceStorageConfigRequestModel(BaseModel): 1096 instance_id: str = Field(alias="InstanceId") 1097 association_id: str = Field(alias="AssociationId") 1098 resource_type: Literal[ 1099 "AGENT_EVENTS", 1100 "ATTACHMENTS", 1101 "CALL_RECORDINGS", 1102 "CHAT_TRANSCRIPTS", 1103 "CONTACT_EVALUATIONS", 1104 "CONTACT_TRACE_RECORDS", 1105 "MEDIA_STREAMS", 1106 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 1107 "SCHEDULED_REPORTS", 1108 ] = Field(alias="ResourceType") 1109 1110 1111class DisassociateLambdaFunctionRequestModel(BaseModel): 1112 instance_id: str = Field(alias="InstanceId") 1113 function_arn: str = Field(alias="FunctionArn") 1114 1115 1116class DisassociateLexBotRequestModel(BaseModel): 1117 instance_id: str = Field(alias="InstanceId") 1118 bot_name: str = Field(alias="BotName") 1119 lex_region: str = Field(alias="LexRegion") 1120 1121 1122class DisassociatePhoneNumberContactFlowRequestModel(BaseModel): 1123 phone_number_id: str = Field(alias="PhoneNumberId") 1124 instance_id: str = Field(alias="InstanceId") 1125 1126 1127class DisassociateQueueQuickConnectsRequestModel(BaseModel): 1128 instance_id: str = Field(alias="InstanceId") 1129 queue_id: str = Field(alias="QueueId") 1130 quick_connect_ids: Sequence[str] = Field(alias="QuickConnectIds") 1131 1132 1133class RoutingProfileQueueReferenceModel(BaseModel): 1134 queue_id: str = Field(alias="QueueId") 1135 channel: Literal["CHAT", "TASK", "VOICE"] = Field(alias="Channel") 1136 1137 1138class DisassociateSecurityKeyRequestModel(BaseModel): 1139 instance_id: str = Field(alias="InstanceId") 1140 association_id: str = Field(alias="AssociationId") 1141 1142 1143class DismissUserContactRequestModel(BaseModel): 1144 user_id: str = Field(alias="UserId") 1145 instance_id: str = Field(alias="InstanceId") 1146 contact_id: str = Field(alias="ContactId") 1147 1148 1149class DistributionModel(BaseModel): 1150 region: str = Field(alias="Region") 1151 percentage: int = Field(alias="Percentage") 1152 1153 1154class EmailReferenceModel(BaseModel): 1155 name: Optional[str] = Field(default=None, alias="Name") 1156 value: Optional[str] = Field(default=None, alias="Value") 1157 1158 1159class EncryptionConfigModel(BaseModel): 1160 encryption_type: Literal["KMS"] = Field(alias="EncryptionType") 1161 key_id: str = Field(alias="KeyId") 1162 1163 1164class EventBridgeActionDefinitionModel(BaseModel): 1165 name: str = Field(alias="Name") 1166 1167 1168class FiltersModel(BaseModel): 1169 queues: Optional[Sequence[str]] = Field(default=None, alias="Queues") 1170 channels: Optional[Sequence[Literal["CHAT", "TASK", "VOICE"]]] = Field( 1171 default=None, alias="Channels" 1172 ) 1173 routing_profiles: Optional[Sequence[str]] = Field( 1174 default=None, alias="RoutingProfiles" 1175 ) 1176 1177 1178class GetContactAttributesRequestModel(BaseModel): 1179 instance_id: str = Field(alias="InstanceId") 1180 initial_contact_id: str = Field(alias="InitialContactId") 1181 1182 1183class GetFederationTokenRequestModel(BaseModel): 1184 instance_id: str = Field(alias="InstanceId") 1185 1186 1187class PaginatorConfigModel(BaseModel): 1188 max_items: Optional[int] = Field(default=None, alias="MaxItems") 1189 page_size: Optional[int] = Field(default=None, alias="PageSize") 1190 starting_token: Optional[str] = Field(default=None, alias="StartingToken") 1191 1192 1193class GetTaskTemplateRequestModel(BaseModel): 1194 instance_id: str = Field(alias="InstanceId") 1195 task_template_id: str = Field(alias="TaskTemplateId") 1196 snapshot_version: Optional[str] = Field(default=None, alias="SnapshotVersion") 1197 1198 1199class GetTrafficDistributionRequestModel(BaseModel): 1200 id: str = Field(alias="Id") 1201 1202 1203class HierarchyGroupConditionModel(BaseModel): 1204 value: Optional[str] = Field(default=None, alias="Value") 1205 hierarchy_group_match_type: Optional[Literal["EXACT", "WITH_CHILD_GROUPS"]] = Field( 1206 default=None, alias="HierarchyGroupMatchType" 1207 ) 1208 1209 1210class HierarchyGroupSummaryReferenceModel(BaseModel): 1211 id: Optional[str] = Field(default=None, alias="Id") 1212 arn: Optional[str] = Field(default=None, alias="Arn") 1213 1214 1215class HierarchyGroupSummaryModel(BaseModel): 1216 id: Optional[str] = Field(default=None, alias="Id") 1217 arn: Optional[str] = Field(default=None, alias="Arn") 1218 name: Optional[str] = Field(default=None, alias="Name") 1219 1220 1221class HierarchyLevelModel(BaseModel): 1222 id: Optional[str] = Field(default=None, alias="Id") 1223 arn: Optional[str] = Field(default=None, alias="Arn") 1224 name: Optional[str] = Field(default=None, alias="Name") 1225 1226 1227class HierarchyLevelUpdateModel(BaseModel): 1228 name: str = Field(alias="Name") 1229 1230 1231class ThresholdModel(BaseModel): 1232 comparison: Optional[Literal["LT"]] = Field(default=None, alias="Comparison") 1233 threshold_value: Optional[float] = Field(default=None, alias="ThresholdValue") 1234 1235 1236class HoursOfOperationTimeSliceModel(BaseModel): 1237 hours: int = Field(alias="Hours") 1238 minutes: int = Field(alias="Minutes") 1239 1240 1241class HoursOfOperationSummaryModel(BaseModel): 1242 id: Optional[str] = Field(default=None, alias="Id") 1243 arn: Optional[str] = Field(default=None, alias="Arn") 1244 name: Optional[str] = Field(default=None, alias="Name") 1245 1246 1247class InstanceStatusReasonModel(BaseModel): 1248 message: Optional[str] = Field(default=None, alias="Message") 1249 1250 1251class KinesisFirehoseConfigModel(BaseModel): 1252 firehose_arn: str = Field(alias="FirehoseArn") 1253 1254 1255class KinesisStreamConfigModel(BaseModel): 1256 stream_arn: str = Field(alias="StreamArn") 1257 1258 1259class InstanceSummaryModel(BaseModel): 1260 id: Optional[str] = Field(default=None, alias="Id") 1261 arn: Optional[str] = Field(default=None, alias="Arn") 1262 identity_management_type: Optional[ 1263 Literal["CONNECT_MANAGED", "EXISTING_DIRECTORY", "SAML"] 1264 ] = Field(default=None, alias="IdentityManagementType") 1265 instance_alias: Optional[str] = Field(default=None, alias="InstanceAlias") 1266 created_time: Optional[datetime] = Field(default=None, alias="CreatedTime") 1267 service_role: Optional[str] = Field(default=None, alias="ServiceRole") 1268 instance_status: Optional[ 1269 Literal["ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS"] 1270 ] = Field(default=None, alias="InstanceStatus") 1271 inbound_calls_enabled: Optional[bool] = Field( 1272 default=None, alias="InboundCallsEnabled" 1273 ) 1274 outbound_calls_enabled: Optional[bool] = Field( 1275 default=None, alias="OutboundCallsEnabled" 1276 ) 1277 1278 1279class IntegrationAssociationSummaryModel(BaseModel): 1280 integration_association_id: Optional[str] = Field( 1281 default=None, alias="IntegrationAssociationId" 1282 ) 1283 integration_association_arn: Optional[str] = Field( 1284 default=None, alias="IntegrationAssociationArn" 1285 ) 1286 instance_id: Optional[str] = Field(default=None, alias="InstanceId") 1287 integration_type: Optional[ 1288 Literal[ 1289 "CASES_DOMAIN", 1290 "EVENT", 1291 "PINPOINT_APP", 1292 "VOICE_ID", 1293 "WISDOM_ASSISTANT", 1294 "WISDOM_KNOWLEDGE_BASE", 1295 ] 1296 ] = Field(default=None, alias="IntegrationType") 1297 integration_arn: Optional[str] = Field(default=None, alias="IntegrationArn") 1298 source_application_url: Optional[str] = Field( 1299 default=None, alias="SourceApplicationUrl" 1300 ) 1301 source_application_name: Optional[str] = Field( 1302 default=None, alias="SourceApplicationName" 1303 ) 1304 source_type: Optional[Literal["SALESFORCE", "ZENDESK"]] = Field( 1305 default=None, alias="SourceType" 1306 ) 1307 1308 1309class TaskTemplateFieldIdentifierModel(BaseModel): 1310 name: Optional[str] = Field(default=None, alias="Name") 1311 1312 1313class ListAgentStatusRequestModel(BaseModel): 1314 instance_id: str = Field(alias="InstanceId") 1315 next_token: Optional[str] = Field(default=None, alias="NextToken") 1316 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1317 agent_status_types: Optional[ 1318 Sequence[Literal["CUSTOM", "OFFLINE", "ROUTABLE"]] 1319 ] = Field(default=None, alias="AgentStatusTypes") 1320 1321 1322class ListApprovedOriginsRequestModel(BaseModel): 1323 instance_id: str = Field(alias="InstanceId") 1324 next_token: Optional[str] = Field(default=None, alias="NextToken") 1325 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1326 1327 1328class ListBotsRequestModel(BaseModel): 1329 instance_id: str = Field(alias="InstanceId") 1330 lex_version: Literal["V1", "V2"] = Field(alias="LexVersion") 1331 next_token: Optional[str] = Field(default=None, alias="NextToken") 1332 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1333 1334 1335class ListContactFlowModulesRequestModel(BaseModel): 1336 instance_id: str = Field(alias="InstanceId") 1337 next_token: Optional[str] = Field(default=None, alias="NextToken") 1338 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1339 contact_flow_module_state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field( 1340 default=None, alias="ContactFlowModuleState" 1341 ) 1342 1343 1344class ListContactFlowsRequestModel(BaseModel): 1345 instance_id: str = Field(alias="InstanceId") 1346 contact_flow_types: Optional[ 1347 Sequence[ 1348 Literal[ 1349 "AGENT_HOLD", 1350 "AGENT_TRANSFER", 1351 "AGENT_WHISPER", 1352 "CONTACT_FLOW", 1353 "CUSTOMER_HOLD", 1354 "CUSTOMER_QUEUE", 1355 "CUSTOMER_WHISPER", 1356 "OUTBOUND_WHISPER", 1357 "QUEUE_TRANSFER", 1358 ] 1359 ] 1360 ] = Field(default=None, alias="ContactFlowTypes") 1361 next_token: Optional[str] = Field(default=None, alias="NextToken") 1362 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1363 1364 1365class ListContactReferencesRequestModel(BaseModel): 1366 instance_id: str = Field(alias="InstanceId") 1367 contact_id: str = Field(alias="ContactId") 1368 reference_types: Sequence[ 1369 Literal["ATTACHMENT", "DATE", "EMAIL", "NUMBER", "STRING", "URL"] 1370 ] = Field(alias="ReferenceTypes") 1371 next_token: Optional[str] = Field(default=None, alias="NextToken") 1372 1373 1374class ListDefaultVocabulariesRequestModel(BaseModel): 1375 instance_id: str = Field(alias="InstanceId") 1376 language_code: Optional[ 1377 Literal[ 1378 "ar-AE", 1379 "de-CH", 1380 "de-DE", 1381 "en-AB", 1382 "en-AU", 1383 "en-GB", 1384 "en-IE", 1385 "en-IN", 1386 "en-NZ", 1387 "en-US", 1388 "en-WL", 1389 "en-ZA", 1390 "es-ES", 1391 "es-US", 1392 "fr-CA", 1393 "fr-FR", 1394 "hi-IN", 1395 "it-IT", 1396 "ja-JP", 1397 "ko-KR", 1398 "pt-BR", 1399 "pt-PT", 1400 "zh-CN", 1401 ] 1402 ] = Field(default=None, alias="LanguageCode") 1403 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1404 next_token: Optional[str] = Field(default=None, alias="NextToken") 1405 1406 1407class ListHoursOfOperationsRequestModel(BaseModel): 1408 instance_id: str = Field(alias="InstanceId") 1409 next_token: Optional[str] = Field(default=None, alias="NextToken") 1410 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1411 1412 1413class ListInstanceAttributesRequestModel(BaseModel): 1414 instance_id: str = Field(alias="InstanceId") 1415 next_token: Optional[str] = Field(default=None, alias="NextToken") 1416 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1417 1418 1419class ListInstanceStorageConfigsRequestModel(BaseModel): 1420 instance_id: str = Field(alias="InstanceId") 1421 resource_type: Literal[ 1422 "AGENT_EVENTS", 1423 "ATTACHMENTS", 1424 "CALL_RECORDINGS", 1425 "CHAT_TRANSCRIPTS", 1426 "CONTACT_EVALUATIONS", 1427 "CONTACT_TRACE_RECORDS", 1428 "MEDIA_STREAMS", 1429 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 1430 "SCHEDULED_REPORTS", 1431 ] = Field(alias="ResourceType") 1432 next_token: Optional[str] = Field(default=None, alias="NextToken") 1433 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1434 1435 1436class ListInstancesRequestModel(BaseModel): 1437 next_token: Optional[str] = Field(default=None, alias="NextToken") 1438 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1439 1440 1441class ListIntegrationAssociationsRequestModel(BaseModel): 1442 instance_id: str = Field(alias="InstanceId") 1443 integration_type: Optional[ 1444 Literal[ 1445 "CASES_DOMAIN", 1446 "EVENT", 1447 "PINPOINT_APP", 1448 "VOICE_ID", 1449 "WISDOM_ASSISTANT", 1450 "WISDOM_KNOWLEDGE_BASE", 1451 ] 1452 ] = Field(default=None, alias="IntegrationType") 1453 next_token: Optional[str] = Field(default=None, alias="NextToken") 1454 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1455 1456 1457class ListLambdaFunctionsRequestModel(BaseModel): 1458 instance_id: str = Field(alias="InstanceId") 1459 next_token: Optional[str] = Field(default=None, alias="NextToken") 1460 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1461 1462 1463class ListLexBotsRequestModel(BaseModel): 1464 instance_id: str = Field(alias="InstanceId") 1465 next_token: Optional[str] = Field(default=None, alias="NextToken") 1466 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1467 1468 1469class ListPhoneNumbersRequestModel(BaseModel): 1470 instance_id: str = Field(alias="InstanceId") 1471 phone_number_types: Optional[Sequence[Literal["DID", "TOLL_FREE"]]] = Field( 1472 default=None, alias="PhoneNumberTypes" 1473 ) 1474 phone_number_country_codes: Optional[ 1475 Sequence[ 1476 Literal[ 1477 "AD", 1478 "AE", 1479 "AF", 1480 "AG", 1481 "AI", 1482 "AL", 1483 "AM", 1484 "AN", 1485 "AO", 1486 "AQ", 1487 "AR", 1488 "AS", 1489 "AT", 1490 "AU", 1491 "AW", 1492 "AZ", 1493 "BA", 1494 "BB", 1495 "BD", 1496 "BE", 1497 "BF", 1498 "BG", 1499 "BH", 1500 "BI", 1501 "BJ", 1502 "BL", 1503 "BM", 1504 "BN", 1505 "BO", 1506 "BR", 1507 "BS", 1508 "BT", 1509 "BW", 1510 "BY", 1511 "BZ", 1512 "CA", 1513 "CC", 1514 "CD", 1515 "CF", 1516 "CG", 1517 "CH", 1518 "CI", 1519 "CK", 1520 "CL", 1521 "CM", 1522 "CN", 1523 "CO", 1524 "CR", 1525 "CU", 1526 "CV", 1527 "CW", 1528 "CX", 1529 "CY", 1530 "CZ", 1531 "DE", 1532 "DJ", 1533 "DK", 1534 "DM", 1535 "DO", 1536 "DZ", 1537 "EC", 1538 "EE", 1539 "EG", 1540 "EH", 1541 "ER", 1542 "ES", 1543 "ET", 1544 "FI", 1545 "FJ", 1546 "FK", 1547 "FM", 1548 "FO", 1549 "FR", 1550 "GA", 1551 "GB", 1552 "GD", 1553 "GE", 1554 "GG", 1555 "GH", 1556 "GI", 1557 "GL", 1558 "GM", 1559 "GN", 1560 "GQ", 1561 "GR", 1562 "GT", 1563 "GU", 1564 "GW", 1565 "GY", 1566 "HK", 1567 "HN", 1568 "HR", 1569 "HT", 1570 "HU", 1571 "ID", 1572 "IE", 1573 "IL", 1574 "IM", 1575 "IN", 1576 "Type[IO]", 1577 "IQ", 1578 "IR", 1579 "IS", 1580 "IT", 1581 "JE", 1582 "JM", 1583 "JO", 1584 "JP", 1585 "KE", 1586 "KG", 1587 "KH", 1588 "KI", 1589 "KM", 1590 "KN", 1591 "KP", 1592 "KR", 1593 "KW", 1594 "KY", 1595 "KZ", 1596 "LA", 1597 "LB", 1598 "LC", 1599 "LI", 1600 "LK", 1601 "LR", 1602 "LS", 1603 "LT", 1604 "LU", 1605 "LV", 1606 "LY", 1607 "MA", 1608 "MC", 1609 "MD", 1610 "ME", 1611 "MF", 1612 "MG", 1613 "MH", 1614 "MK", 1615 "ML", 1616 "MM", 1617 "MN", 1618 "MO", 1619 "MP", 1620 "MR", 1621 "MS", 1622 "MT", 1623 "MU", 1624 "MV", 1625 "MW", 1626 "MX", 1627 "MY", 1628 "MZ", 1629 "NA", 1630 "NC", 1631 "NE", 1632 "NG", 1633 "NI", 1634 "NL", 1635 "NO", 1636 "NP", 1637 "NR", 1638 "NU", 1639 "NZ", 1640 "OM", 1641 "PA", 1642 "PE", 1643 "PF", 1644 "PG", 1645 "PH", 1646 "PK", 1647 "PL", 1648 "PM", 1649 "PN", 1650 "PR", 1651 "PT", 1652 "PW", 1653 "PY", 1654 "QA", 1655 "RE", 1656 "RO", 1657 "RS", 1658 "RU", 1659 "RW", 1660 "SA", 1661 "SB", 1662 "SC", 1663 "SD", 1664 "SE", 1665 "SG", 1666 "SH", 1667 "SI", 1668 "SJ", 1669 "SK", 1670 "SL", 1671 "SM", 1672 "SN", 1673 "SO", 1674 "SR", 1675 "ST", 1676 "SV", 1677 "SX", 1678 "SY", 1679 "SZ", 1680 "TC", 1681 "TD", 1682 "TG", 1683 "TH", 1684 "TJ", 1685 "TK", 1686 "TL", 1687 "TM", 1688 "TN", 1689 "TO", 1690 "TR", 1691 "TT", 1692 "TV", 1693 "TW", 1694 "TZ", 1695 "UA", 1696 "UG", 1697 "US", 1698 "UY", 1699 "UZ", 1700 "VA", 1701 "VC", 1702 "VE", 1703 "VG", 1704 "VI", 1705 "VN", 1706 "VU", 1707 "WF", 1708 "WS", 1709 "YE", 1710 "YT", 1711 "ZA", 1712 "ZM", 1713 "ZW", 1714 ] 1715 ] 1716 ] = Field(default=None, alias="PhoneNumberCountryCodes") 1717 next_token: Optional[str] = Field(default=None, alias="NextToken") 1718 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1719 1720 1721class PhoneNumberSummaryModel(BaseModel): 1722 id: Optional[str] = Field(default=None, alias="Id") 1723 arn: Optional[str] = Field(default=None, alias="Arn") 1724 phone_number: Optional[str] = Field(default=None, alias="PhoneNumber") 1725 phone_number_type: Optional[Literal["DID", "TOLL_FREE"]] = Field( 1726 default=None, alias="PhoneNumberType" 1727 ) 1728 phone_number_country_code: Optional[ 1729 Literal[ 1730 "AD", 1731 "AE", 1732 "AF", 1733 "AG", 1734 "AI", 1735 "AL", 1736 "AM", 1737 "AN", 1738 "AO", 1739 "AQ", 1740 "AR", 1741 "AS", 1742 "AT", 1743 "AU", 1744 "AW", 1745 "AZ", 1746 "BA", 1747 "BB", 1748 "BD", 1749 "BE", 1750 "BF", 1751 "BG", 1752 "BH", 1753 "BI", 1754 "BJ", 1755 "BL", 1756 "BM", 1757 "BN", 1758 "BO", 1759 "BR", 1760 "BS", 1761 "BT", 1762 "BW", 1763 "BY", 1764 "BZ", 1765 "CA", 1766 "CC", 1767 "CD", 1768 "CF", 1769 "CG", 1770 "CH", 1771 "CI", 1772 "CK", 1773 "CL", 1774 "CM", 1775 "CN", 1776 "CO", 1777 "CR", 1778 "CU", 1779 "CV", 1780 "CW", 1781 "CX", 1782 "CY", 1783 "CZ", 1784 "DE", 1785 "DJ", 1786 "DK", 1787 "DM", 1788 "DO", 1789 "DZ", 1790 "EC", 1791 "EE", 1792 "EG", 1793 "EH", 1794 "ER", 1795 "ES", 1796 "ET", 1797 "FI", 1798 "FJ", 1799 "FK", 1800 "FM", 1801 "FO", 1802 "FR", 1803 "GA", 1804 "GB", 1805 "GD", 1806 "GE", 1807 "GG", 1808 "GH", 1809 "GI", 1810 "GL", 1811 "GM", 1812 "GN", 1813 "GQ", 1814 "GR", 1815 "GT", 1816 "GU", 1817 "GW", 1818 "GY", 1819 "HK", 1820 "HN", 1821 "HR", 1822 "HT", 1823 "HU", 1824 "ID", 1825 "IE", 1826 "IL", 1827 "IM", 1828 "IN", 1829 "Type[IO]", 1830 "IQ", 1831 "IR", 1832 "IS", 1833 "IT", 1834 "JE", 1835 "JM", 1836 "JO", 1837 "JP", 1838 "KE", 1839 "KG", 1840 "KH", 1841 "KI", 1842 "KM", 1843 "KN", 1844 "KP", 1845 "KR", 1846 "KW", 1847 "KY", 1848 "KZ", 1849 "LA", 1850 "LB", 1851 "LC", 1852 "LI", 1853 "LK", 1854 "LR", 1855 "LS", 1856 "LT", 1857 "LU", 1858 "LV", 1859 "LY", 1860 "MA", 1861 "MC", 1862 "MD", 1863 "ME", 1864 "MF", 1865 "MG", 1866 "MH", 1867 "MK", 1868 "ML", 1869 "MM", 1870 "MN", 1871 "MO", 1872 "MP", 1873 "MR", 1874 "MS", 1875 "MT", 1876 "MU", 1877 "MV", 1878 "MW", 1879 "MX", 1880 "MY", 1881 "MZ", 1882 "NA", 1883 "NC", 1884 "NE", 1885 "NG", 1886 "NI", 1887 "NL", 1888 "NO", 1889 "NP", 1890 "NR", 1891 "NU", 1892 "NZ", 1893 "OM", 1894 "PA", 1895 "PE", 1896 "PF", 1897 "PG", 1898 "PH", 1899 "PK", 1900 "PL", 1901 "PM", 1902 "PN", 1903 "PR", 1904 "PT", 1905 "PW", 1906 "PY", 1907 "QA", 1908 "RE", 1909 "RO", 1910 "RS", 1911 "RU", 1912 "RW", 1913 "SA", 1914 "SB", 1915 "SC", 1916 "SD", 1917 "SE", 1918 "SG", 1919 "SH", 1920 "SI", 1921 "SJ", 1922 "SK", 1923 "SL", 1924 "SM", 1925 "SN", 1926 "SO", 1927 "SR", 1928 "ST", 1929 "SV", 1930 "SX", 1931 "SY", 1932 "SZ", 1933 "TC", 1934 "TD", 1935 "TG", 1936 "TH", 1937 "TJ", 1938 "TK", 1939 "TL", 1940 "TM", 1941 "TN", 1942 "TO", 1943 "TR", 1944 "TT", 1945 "TV", 1946 "TW", 1947 "TZ", 1948 "UA", 1949 "UG", 1950 "US", 1951 "UY", 1952 "UZ", 1953 "VA", 1954 "VC", 1955 "VE", 1956 "VG", 1957 "VI", 1958 "VN", 1959 "VU", 1960 "WF", 1961 "WS", 1962 "YE", 1963 "YT", 1964 "ZA", 1965 "ZM", 1966 "ZW", 1967 ] 1968 ] = Field(default=None, alias="PhoneNumberCountryCode") 1969 1970 1971class ListPhoneNumbersSummaryModel(BaseModel): 1972 phone_number_id: Optional[str] = Field(default=None, alias="PhoneNumberId") 1973 phone_number_arn: Optional[str] = Field(default=None, alias="PhoneNumberArn") 1974 phone_number: Optional[str] = Field(default=None, alias="PhoneNumber") 1975 phone_number_country_code: Optional[ 1976 Literal[ 1977 "AD", 1978 "AE", 1979 "AF", 1980 "AG", 1981 "AI", 1982 "AL", 1983 "AM", 1984 "AN", 1985 "AO", 1986 "AQ", 1987 "AR", 1988 "AS", 1989 "AT", 1990 "AU", 1991 "AW", 1992 "AZ", 1993 "BA", 1994 "BB", 1995 "BD", 1996 "BE", 1997 "BF", 1998 "BG", 1999 "BH", 2000 "BI", 2001 "BJ", 2002 "BL", 2003 "BM", 2004 "BN", 2005 "BO", 2006 "BR", 2007 "BS", 2008 "BT", 2009 "BW", 2010 "BY", 2011 "BZ", 2012 "CA", 2013 "CC", 2014 "CD", 2015 "CF", 2016 "CG", 2017 "CH", 2018 "CI", 2019 "CK", 2020 "CL", 2021 "CM", 2022 "CN", 2023 "CO", 2024 "CR", 2025 "CU", 2026 "CV", 2027 "CW", 2028 "CX", 2029 "CY", 2030 "CZ", 2031 "DE", 2032 "DJ", 2033 "DK", 2034 "DM", 2035 "DO", 2036 "DZ", 2037 "EC", 2038 "EE", 2039 "EG", 2040 "EH", 2041 "ER", 2042 "ES", 2043 "ET", 2044 "FI", 2045 "FJ", 2046 "FK", 2047 "FM", 2048 "FO", 2049 "FR", 2050 "GA", 2051 "GB", 2052 "GD", 2053 "GE", 2054 "GG", 2055 "GH", 2056 "GI", 2057 "GL", 2058 "GM", 2059 "GN", 2060 "GQ", 2061 "GR", 2062 "GT", 2063 "GU", 2064 "GW", 2065 "GY", 2066 "HK", 2067 "HN", 2068 "HR", 2069 "HT", 2070 "HU", 2071 "ID", 2072 "IE", 2073 "IL", 2074 "IM", 2075 "IN", 2076 "Type[IO]", 2077 "IQ", 2078 "IR", 2079 "IS", 2080 "IT", 2081 "JE", 2082 "JM", 2083 "JO", 2084 "JP", 2085 "KE", 2086 "KG", 2087 "KH", 2088 "KI", 2089 "KM", 2090 "KN", 2091 "KP", 2092 "KR", 2093 "KW", 2094 "KY", 2095 "KZ", 2096 "LA", 2097 "LB", 2098 "LC", 2099 "LI", 2100 "LK", 2101 "LR", 2102 "LS", 2103 "LT", 2104 "LU", 2105 "LV", 2106 "LY", 2107 "MA", 2108 "MC", 2109 "MD", 2110 "ME", 2111 "MF", 2112 "MG", 2113 "MH", 2114 "MK", 2115 "ML", 2116 "MM", 2117 "MN", 2118 "MO", 2119 "MP", 2120 "MR", 2121 "MS", 2122 "MT", 2123 "MU", 2124 "MV", 2125 "MW", 2126 "MX", 2127 "MY", 2128 "MZ", 2129 "NA", 2130 "NC", 2131 "NE", 2132 "NG", 2133 "NI", 2134 "NL", 2135 "NO", 2136 "NP", 2137 "NR", 2138 "NU", 2139 "NZ", 2140 "OM", 2141 "PA", 2142 "PE", 2143 "PF", 2144 "PG", 2145 "PH", 2146 "PK", 2147 "PL", 2148 "PM", 2149 "PN", 2150 "PR", 2151 "PT", 2152 "PW", 2153 "PY", 2154 "QA", 2155 "RE", 2156 "RO", 2157 "RS", 2158 "RU", 2159 "RW", 2160 "SA", 2161 "SB", 2162 "SC", 2163 "SD", 2164 "SE", 2165 "SG", 2166 "SH", 2167 "SI", 2168 "SJ", 2169 "SK", 2170 "SL", 2171 "SM", 2172 "SN", 2173 "SO", 2174 "SR", 2175 "ST", 2176 "SV", 2177 "SX", 2178 "SY", 2179 "SZ", 2180 "TC", 2181 "TD", 2182 "TG", 2183 "TH", 2184 "TJ", 2185 "TK", 2186 "TL", 2187 "TM", 2188 "TN", 2189 "TO", 2190 "TR", 2191 "TT", 2192 "TV", 2193 "TW", 2194 "TZ", 2195 "UA", 2196 "UG", 2197 "US", 2198 "UY", 2199 "UZ", 2200 "VA", 2201 "VC", 2202 "VE", 2203 "VG", 2204 "VI", 2205 "VN", 2206 "VU", 2207 "WF", 2208 "WS", 2209 "YE", 2210 "YT", 2211 "ZA", 2212 "ZM", 2213 "ZW", 2214 ] 2215 ] = Field(default=None, alias="PhoneNumberCountryCode") 2216 phone_number_type: Optional[Literal["DID", "TOLL_FREE"]] = Field( 2217 default=None, alias="PhoneNumberType" 2218 ) 2219 target_arn: Optional[str] = Field(default=None, alias="TargetArn") 2220 2221 2222class ListPhoneNumbersV2RequestModel(BaseModel): 2223 target_arn: Optional[str] = Field(default=None, alias="TargetArn") 2224 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2225 next_token: Optional[str] = Field(default=None, alias="NextToken") 2226 phone_number_country_codes: Optional[ 2227 Sequence[ 2228 Literal[ 2229 "AD", 2230 "AE", 2231 "AF", 2232 "AG", 2233 "AI", 2234 "AL", 2235 "AM", 2236 "AN", 2237 "AO", 2238 "AQ", 2239 "AR", 2240 "AS", 2241 "AT", 2242 "AU", 2243 "AW", 2244 "AZ", 2245 "BA", 2246 "BB", 2247 "BD", 2248 "BE", 2249 "BF", 2250 "BG", 2251 "BH", 2252 "BI", 2253 "BJ", 2254 "BL", 2255 "BM", 2256 "BN", 2257 "BO", 2258 "BR", 2259 "BS", 2260 "BT", 2261 "BW", 2262 "BY", 2263 "BZ", 2264 "CA", 2265 "CC", 2266 "CD", 2267 "CF", 2268 "CG", 2269 "CH", 2270 "CI", 2271 "CK", 2272 "CL", 2273 "CM", 2274 "CN", 2275 "CO", 2276 "CR", 2277 "CU", 2278 "CV", 2279 "CW", 2280 "CX", 2281 "CY", 2282 "CZ", 2283 "DE", 2284 "DJ", 2285 "DK", 2286 "DM", 2287 "DO", 2288 "DZ", 2289 "EC", 2290 "EE", 2291 "EG", 2292 "EH", 2293 "ER", 2294 "ES", 2295 "ET", 2296 "FI", 2297 "FJ", 2298 "FK", 2299 "FM", 2300 "FO", 2301 "FR", 2302 "GA", 2303 "GB", 2304 "GD", 2305 "GE", 2306 "GG", 2307 "GH", 2308 "GI", 2309 "GL", 2310 "GM", 2311 "GN", 2312 "GQ", 2313 "GR", 2314 "GT", 2315 "GU", 2316 "GW", 2317 "GY", 2318 "HK", 2319 "HN", 2320 "HR", 2321 "HT", 2322 "HU", 2323 "ID", 2324 "IE", 2325 "IL", 2326 "IM", 2327 "IN", 2328 "Type[IO]", 2329 "IQ", 2330 "IR", 2331 "IS", 2332 "IT", 2333 "JE", 2334 "JM", 2335 "JO", 2336 "JP", 2337 "KE", 2338 "KG", 2339 "KH", 2340 "KI", 2341 "KM", 2342 "KN", 2343 "KP", 2344 "KR", 2345 "KW", 2346 "KY", 2347 "KZ", 2348 "LA", 2349 "LB", 2350 "LC", 2351 "LI", 2352 "LK", 2353 "LR", 2354 "LS", 2355 "LT", 2356 "LU", 2357 "LV", 2358 "LY", 2359 "MA", 2360 "MC", 2361 "MD", 2362 "ME", 2363 "MF", 2364 "MG", 2365 "MH", 2366 "MK", 2367 "ML", 2368 "MM", 2369 "MN", 2370 "MO", 2371 "MP", 2372 "MR", 2373 "MS", 2374 "MT", 2375 "MU", 2376 "MV", 2377 "MW", 2378 "MX", 2379 "MY", 2380 "MZ", 2381 "NA", 2382 "NC", 2383 "NE", 2384 "NG", 2385 "NI", 2386 "NL", 2387 "NO", 2388 "NP", 2389 "NR", 2390 "NU", 2391 "NZ", 2392 "OM", 2393 "PA", 2394 "PE", 2395 "PF", 2396 "PG", 2397 "PH", 2398 "PK", 2399 "PL", 2400 "PM", 2401 "PN", 2402 "PR", 2403 "PT", 2404 "PW", 2405 "PY", 2406 "QA", 2407 "RE", 2408 "RO", 2409 "RS", 2410 "RU", 2411 "RW", 2412 "SA", 2413 "SB", 2414 "SC", 2415 "SD", 2416 "SE", 2417 "SG", 2418 "SH", 2419 "SI", 2420 "SJ", 2421 "SK", 2422 "SL", 2423 "SM", 2424 "SN", 2425 "SO", 2426 "SR", 2427 "ST", 2428 "SV", 2429 "SX", 2430 "SY", 2431 "SZ", 2432 "TC", 2433 "TD", 2434 "TG", 2435 "TH", 2436 "TJ", 2437 "TK", 2438 "TL", 2439 "TM", 2440 "TN", 2441 "TO", 2442 "TR", 2443 "TT", 2444 "TV", 2445 "TW", 2446 "TZ", 2447 "UA", 2448 "UG", 2449 "US", 2450 "UY", 2451 "UZ", 2452 "VA", 2453 "VC", 2454 "VE", 2455 "VG", 2456 "VI", 2457 "VN", 2458 "VU", 2459 "WF", 2460 "WS", 2461 "YE", 2462 "YT", 2463 "ZA", 2464 "ZM", 2465 "ZW", 2466 ] 2467 ] 2468 ] = Field(default=None, alias="PhoneNumberCountryCodes") 2469 phone_number_types: Optional[Sequence[Literal["DID", "TOLL_FREE"]]] = Field( 2470 default=None, alias="PhoneNumberTypes" 2471 ) 2472 phone_number_prefix: Optional[str] = Field(default=None, alias="PhoneNumberPrefix") 2473 2474 2475class ListPromptsRequestModel(BaseModel): 2476 instance_id: str = Field(alias="InstanceId") 2477 next_token: Optional[str] = Field(default=None, alias="NextToken") 2478 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2479 2480 2481class PromptSummaryModel(BaseModel): 2482 id: Optional[str] = Field(default=None, alias="Id") 2483 arn: Optional[str] = Field(default=None, alias="Arn") 2484 name: Optional[str] = Field(default=None, alias="Name") 2485 2486 2487class ListQueueQuickConnectsRequestModel(BaseModel): 2488 instance_id: str = Field(alias="InstanceId") 2489 queue_id: str = Field(alias="QueueId") 2490 next_token: Optional[str] = Field(default=None, alias="NextToken") 2491 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2492 2493 2494class QuickConnectSummaryModel(BaseModel): 2495 id: Optional[str] = Field(default=None, alias="Id") 2496 arn: Optional[str] = Field(default=None, alias="Arn") 2497 name: Optional[str] = Field(default=None, alias="Name") 2498 quick_connect_type: Optional[Literal["PHONE_NUMBER", "QUEUE", "USER"]] = Field( 2499 default=None, alias="QuickConnectType" 2500 ) 2501 2502 2503class ListQueuesRequestModel(BaseModel): 2504 instance_id: str = Field(alias="InstanceId") 2505 queue_types: Optional[Sequence[Literal["AGENT", "STANDARD"]]] = Field( 2506 default=None, alias="QueueTypes" 2507 ) 2508 next_token: Optional[str] = Field(default=None, alias="NextToken") 2509 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2510 2511 2512class QueueSummaryModel(BaseModel): 2513 id: Optional[str] = Field(default=None, alias="Id") 2514 arn: Optional[str] = Field(default=None, alias="Arn") 2515 name: Optional[str] = Field(default=None, alias="Name") 2516 queue_type: Optional[Literal["AGENT", "STANDARD"]] = Field( 2517 default=None, alias="QueueType" 2518 ) 2519 2520 2521class ListQuickConnectsRequestModel(BaseModel): 2522 instance_id: str = Field(alias="InstanceId") 2523 next_token: Optional[str] = Field(default=None, alias="NextToken") 2524 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2525 quick_connect_types: Optional[ 2526 Sequence[Literal["PHONE_NUMBER", "QUEUE", "USER"]] 2527 ] = Field(default=None, alias="QuickConnectTypes") 2528 2529 2530class ListRoutingProfileQueuesRequestModel(BaseModel): 2531 instance_id: str = Field(alias="InstanceId") 2532 routing_profile_id: str = Field(alias="RoutingProfileId") 2533 next_token: Optional[str] = Field(default=None, alias="NextToken") 2534 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2535 2536 2537class RoutingProfileQueueConfigSummaryModel(BaseModel): 2538 queue_id: str = Field(alias="QueueId") 2539 queue_arn: str = Field(alias="QueueArn") 2540 queue_name: str = Field(alias="QueueName") 2541 priority: int = Field(alias="Priority") 2542 delay: int = Field(alias="Delay") 2543 channel: Literal["CHAT", "TASK", "VOICE"] = Field(alias="Channel") 2544 2545 2546class ListRoutingProfilesRequestModel(BaseModel): 2547 instance_id: str = Field(alias="InstanceId") 2548 next_token: Optional[str] = Field(default=None, alias="NextToken") 2549 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2550 2551 2552class RoutingProfileSummaryModel(BaseModel): 2553 id: Optional[str] = Field(default=None, alias="Id") 2554 arn: Optional[str] = Field(default=None, alias="Arn") 2555 name: Optional[str] = Field(default=None, alias="Name") 2556 2557 2558class ListRulesRequestModel(BaseModel): 2559 instance_id: str = Field(alias="InstanceId") 2560 publish_status: Optional[Literal["DRAFT", "PUBLISHED"]] = Field( 2561 default=None, alias="PublishStatus" 2562 ) 2563 event_source_name: Optional[ 2564 Literal[ 2565 "OnPostCallAnalysisAvailable", 2566 "OnPostChatAnalysisAvailable", 2567 "OnRealTimeCallAnalysisAvailable", 2568 "OnSalesforceCaseCreate", 2569 "OnZendeskTicketCreate", 2570 "OnZendeskTicketStatusUpdate", 2571 ] 2572 ] = Field(default=None, alias="EventSourceName") 2573 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2574 next_token: Optional[str] = Field(default=None, alias="NextToken") 2575 2576 2577class ListSecurityKeysRequestModel(BaseModel): 2578 instance_id: str = Field(alias="InstanceId") 2579 next_token: Optional[str] = Field(default=None, alias="NextToken") 2580 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2581 2582 2583class SecurityKeyModel(BaseModel): 2584 association_id: Optional[str] = Field(default=None, alias="AssociationId") 2585 key: Optional[str] = Field(default=None, alias="Key") 2586 creation_time: Optional[datetime] = Field(default=None, alias="CreationTime") 2587 2588 2589class ListSecurityProfilePermissionsRequestModel(BaseModel): 2590 security_profile_id: str = Field(alias="SecurityProfileId") 2591 instance_id: str = Field(alias="InstanceId") 2592 next_token: Optional[str] = Field(default=None, alias="NextToken") 2593 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2594 2595 2596class ListSecurityProfilesRequestModel(BaseModel): 2597 instance_id: str = Field(alias="InstanceId") 2598 next_token: Optional[str] = Field(default=None, alias="NextToken") 2599 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2600 2601 2602class SecurityProfileSummaryModel(BaseModel): 2603 id: Optional[str] = Field(default=None, alias="Id") 2604 arn: Optional[str] = Field(default=None, alias="Arn") 2605 name: Optional[str] = Field(default=None, alias="Name") 2606 2607 2608class ListTagsForResourceRequestModel(BaseModel): 2609 resource_arn: str = Field(alias="resourceArn") 2610 2611 2612class ListTaskTemplatesRequestModel(BaseModel): 2613 instance_id: str = Field(alias="InstanceId") 2614 next_token: Optional[str] = Field(default=None, alias="NextToken") 2615 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2616 status: Optional[Literal["ACTIVE", "INACTIVE"]] = Field( 2617 default=None, alias="Status" 2618 ) 2619 name: Optional[str] = Field(default=None, alias="Name") 2620 2621 2622class TaskTemplateMetadataModel(BaseModel): 2623 id: Optional[str] = Field(default=None, alias="Id") 2624 arn: Optional[str] = Field(default=None, alias="Arn") 2625 name: Optional[str] = Field(default=None, alias="Name") 2626 description: Optional[str] = Field(default=None, alias="Description") 2627 status: Optional[Literal["ACTIVE", "INACTIVE"]] = Field( 2628 default=None, alias="Status" 2629 ) 2630 last_modified_time: Optional[datetime] = Field( 2631 default=None, alias="LastModifiedTime" 2632 ) 2633 created_time: Optional[datetime] = Field(default=None, alias="CreatedTime") 2634 2635 2636class ListTrafficDistributionGroupsRequestModel(BaseModel): 2637 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2638 next_token: Optional[str] = Field(default=None, alias="NextToken") 2639 instance_id: Optional[str] = Field(default=None, alias="InstanceId") 2640 2641 2642class TrafficDistributionGroupSummaryModel(BaseModel): 2643 id: Optional[str] = Field(default=None, alias="Id") 2644 arn: Optional[str] = Field(default=None, alias="Arn") 2645 name: Optional[str] = Field(default=None, alias="Name") 2646 instance_arn: Optional[str] = Field(default=None, alias="InstanceArn") 2647 status: Optional[ 2648 Literal[ 2649 "ACTIVE", 2650 "CREATION_FAILED", 2651 "CREATION_IN_PROGRESS", 2652 "DELETION_FAILED", 2653 "PENDING_DELETION", 2654 "UPDATE_IN_PROGRESS", 2655 ] 2656 ] = Field(default=None, alias="Status") 2657 2658 2659class ListUseCasesRequestModel(BaseModel): 2660 instance_id: str = Field(alias="InstanceId") 2661 integration_association_id: str = Field(alias="IntegrationAssociationId") 2662 next_token: Optional[str] = Field(default=None, alias="NextToken") 2663 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2664 2665 2666class UseCaseModel(BaseModel): 2667 use_case_id: Optional[str] = Field(default=None, alias="UseCaseId") 2668 use_case_arn: Optional[str] = Field(default=None, alias="UseCaseArn") 2669 use_case_type: Optional[Literal["CONNECT_CAMPAIGNS", "RULES_EVALUATION"]] = Field( 2670 default=None, alias="UseCaseType" 2671 ) 2672 2673 2674class ListUserHierarchyGroupsRequestModel(BaseModel): 2675 instance_id: str = Field(alias="InstanceId") 2676 next_token: Optional[str] = Field(default=None, alias="NextToken") 2677 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2678 2679 2680class ListUsersRequestModel(BaseModel): 2681 instance_id: str = Field(alias="InstanceId") 2682 next_token: Optional[str] = Field(default=None, alias="NextToken") 2683 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2684 2685 2686class UserSummaryModel(BaseModel): 2687 id: Optional[str] = Field(default=None, alias="Id") 2688 arn: Optional[str] = Field(default=None, alias="Arn") 2689 username: Optional[str] = Field(default=None, alias="Username") 2690 2691 2692class MonitorContactRequestModel(BaseModel): 2693 instance_id: str = Field(alias="InstanceId") 2694 contact_id: str = Field(alias="ContactId") 2695 user_id: str = Field(alias="UserId") 2696 allowed_monitor_capabilities: Optional[ 2697 Sequence[Literal["BARGE", "SILENT_MONITOR"]] 2698 ] = Field(default=None, alias="AllowedMonitorCapabilities") 2699 client_token: Optional[str] = Field(default=None, alias="ClientToken") 2700 2701 2702class NotificationRecipientTypeModel(BaseModel): 2703 user_tags: Optional[Mapping[str, str]] = Field(default=None, alias="UserTags") 2704 user_ids: Optional[Sequence[str]] = Field(default=None, alias="UserIds") 2705 2706 2707class NumberReferenceModel(BaseModel): 2708 name: Optional[str] = Field(default=None, alias="Name") 2709 value: Optional[str] = Field(default=None, alias="Value") 2710 2711 2712class ParticipantDetailsModel(BaseModel): 2713 display_name: str = Field(alias="DisplayName") 2714 2715 2716class ParticipantTimerValueModel(BaseModel): 2717 participant_timer_action: Optional[Literal["Unset"]] = Field( 2718 default=None, alias="ParticipantTimerAction" 2719 ) 2720 participant_timer_duration_in_minutes: Optional[int] = Field( 2721 default=None, alias="ParticipantTimerDurationInMinutes" 2722 ) 2723 2724 2725class PersistentChatModel(BaseModel): 2726 rehydration_type: Optional[Literal["ENTIRE_PAST_SESSION", "FROM_SEGMENT"]] = Field( 2727 default=None, alias="RehydrationType" 2728 ) 2729 source_contact_id: Optional[str] = Field(default=None, alias="SourceContactId") 2730 2731 2732class PhoneNumberQuickConnectConfigModel(BaseModel): 2733 phone_number: str = Field(alias="PhoneNumber") 2734 2735 2736class PutUserStatusRequestModel(BaseModel): 2737 user_id: str = Field(alias="UserId") 2738 instance_id: str = Field(alias="InstanceId") 2739 agent_status_id: str = Field(alias="AgentStatusId") 2740 2741 2742class QueueQuickConnectConfigModel(BaseModel): 2743 queue_id: str = Field(alias="QueueId") 2744 contact_flow_id: str = Field(alias="ContactFlowId") 2745 2746 2747class StringConditionModel(BaseModel): 2748 field_name: Optional[str] = Field(default=None, alias="FieldName") 2749 value: Optional[str] = Field(default=None, alias="Value") 2750 comparison_type: Optional[Literal["CONTAINS", "EXACT", "STARTS_WITH"]] = Field( 2751 default=None, alias="ComparisonType" 2752 ) 2753 2754 2755class UserQuickConnectConfigModel(BaseModel): 2756 user_id: str = Field(alias="UserId") 2757 contact_flow_id: str = Field(alias="ContactFlowId") 2758 2759 2760class StringReferenceModel(BaseModel): 2761 name: Optional[str] = Field(default=None, alias="Name") 2762 value: Optional[str] = Field(default=None, alias="Value") 2763 2764 2765class UrlReferenceModel(BaseModel): 2766 name: Optional[str] = Field(default=None, alias="Name") 2767 value: Optional[str] = Field(default=None, alias="Value") 2768 2769 2770class ReferenceModel(BaseModel): 2771 value: str = Field(alias="Value") 2772 type: Literal["ATTACHMENT", "DATE", "EMAIL", "NUMBER", "STRING", "URL"] = Field( 2773 alias="Type" 2774 ) 2775 2776 2777class ReleasePhoneNumberRequestModel(BaseModel): 2778 phone_number_id: str = Field(alias="PhoneNumberId") 2779 client_token: Optional[str] = Field(default=None, alias="ClientToken") 2780 2781 2782class ReplicateInstanceRequestModel(BaseModel): 2783 instance_id: str = Field(alias="InstanceId") 2784 replica_region: str = Field(alias="ReplicaRegion") 2785 replica_alias: str = Field(alias="ReplicaAlias") 2786 client_token: Optional[str] = Field(default=None, alias="ClientToken") 2787 2788 2789class ResumeContactRecordingRequestModel(BaseModel): 2790 instance_id: str = Field(alias="InstanceId") 2791 contact_id: str = Field(alias="ContactId") 2792 initial_contact_id: str = Field(alias="InitialContactId") 2793 2794 2795class SearchAvailablePhoneNumbersRequestModel(BaseModel): 2796 target_arn: str = Field(alias="TargetArn") 2797 phone_number_country_code: Literal[ 2798 "AD", 2799 "AE", 2800 "AF", 2801 "AG", 2802 "AI", 2803 "AL", 2804 "AM", 2805 "AN", 2806 "AO", 2807 "AQ", 2808 "AR", 2809 "AS", 2810 "AT", 2811 "AU", 2812 "AW", 2813 "AZ", 2814 "BA", 2815 "BB", 2816 "BD", 2817 "BE", 2818 "BF", 2819 "BG", 2820 "BH", 2821 "BI", 2822 "BJ", 2823 "BL", 2824 "BM", 2825 "BN", 2826 "BO", 2827 "BR", 2828 "BS", 2829 "BT", 2830 "BW", 2831 "BY", 2832 "BZ", 2833 "CA", 2834 "CC", 2835 "CD", 2836 "CF", 2837 "CG", 2838 "CH", 2839 "CI", 2840 "CK", 2841 "CL", 2842 "CM", 2843 "CN", 2844 "CO", 2845 "CR", 2846 "CU", 2847 "CV", 2848 "CW", 2849 "CX", 2850 "CY", 2851 "CZ", 2852 "DE", 2853 "DJ", 2854 "DK", 2855 "DM", 2856 "DO", 2857 "DZ", 2858 "EC", 2859 "EE", 2860 "EG", 2861 "EH", 2862 "ER", 2863 "ES", 2864 "ET", 2865 "FI", 2866 "FJ", 2867 "FK", 2868 "FM", 2869 "FO", 2870 "FR", 2871 "GA", 2872 "GB", 2873 "GD", 2874 "GE", 2875 "GG", 2876 "GH", 2877 "GI", 2878 "GL", 2879 "GM", 2880 "GN", 2881 "GQ", 2882 "GR", 2883 "GT", 2884 "GU", 2885 "GW", 2886 "GY", 2887 "HK", 2888 "HN", 2889 "HR", 2890 "HT", 2891 "HU", 2892 "ID", 2893 "IE", 2894 "IL", 2895 "IM", 2896 "IN", 2897 "Type[IO]", 2898 "IQ", 2899 "IR", 2900 "IS", 2901 "IT", 2902 "JE", 2903 "JM", 2904 "JO", 2905 "JP", 2906 "KE", 2907 "KG", 2908 "KH", 2909 "KI", 2910 "KM", 2911 "KN", 2912 "KP", 2913 "KR", 2914 "KW", 2915 "KY", 2916 "KZ", 2917 "LA", 2918 "LB", 2919 "LC", 2920 "LI", 2921 "LK", 2922 "LR", 2923 "LS", 2924 "LT", 2925 "LU", 2926 "LV", 2927 "LY", 2928 "MA", 2929 "MC", 2930 "MD", 2931 "ME", 2932 "MF", 2933 "MG", 2934 "MH", 2935 "MK", 2936 "ML", 2937 "MM", 2938 "MN", 2939 "MO", 2940 "MP", 2941 "MR", 2942 "MS", 2943 "MT", 2944 "MU", 2945 "MV", 2946 "MW", 2947 "MX", 2948 "MY", 2949 "MZ", 2950 "NA", 2951 "NC", 2952 "NE", 2953 "NG", 2954 "NI", 2955 "NL", 2956 "NO", 2957 "NP", 2958 "NR", 2959 "NU", 2960 "NZ", 2961 "OM", 2962 "PA", 2963 "PE", 2964 "PF", 2965 "PG", 2966 "PH", 2967 "PK", 2968 "PL", 2969 "PM", 2970 "PN", 2971 "PR", 2972 "PT", 2973 "PW", 2974 "PY", 2975 "QA", 2976 "RE", 2977 "RO", 2978 "RS", 2979 "RU", 2980 "RW", 2981 "SA", 2982 "SB", 2983 "SC", 2984 "SD", 2985 "SE", 2986 "SG", 2987 "SH", 2988 "SI", 2989 "SJ", 2990 "SK", 2991 "SL", 2992 "SM", 2993 "SN", 2994 "SO", 2995 "SR", 2996 "ST", 2997 "SV", 2998 "SX", 2999 "SY", 3000 "SZ", 3001 "TC", 3002 "TD", 3003 "TG", 3004 "TH", 3005 "TJ", 3006 "TK", 3007 "TL", 3008 "TM", 3009 "TN", 3010 "TO", 3011 "TR", 3012 "TT", 3013 "TV", 3014 "TW", 3015 "TZ", 3016 "UA", 3017 "UG", 3018 "US", 3019 "UY", 3020 "UZ", 3021 "VA", 3022 "VC", 3023 "VE", 3024 "VG", 3025 "VI", 3026 "VN", 3027 "VU", 3028 "WF", 3029 "WS", 3030 "YE", 3031 "YT", 3032 "ZA", 3033 "ZM", 3034 "ZW", 3035 ] = Field(alias="PhoneNumberCountryCode") 3036 phone_number_type: Literal["DID", "TOLL_FREE"] = Field(alias="PhoneNumberType") 3037 phone_number_prefix: Optional[str] = Field(default=None, alias="PhoneNumberPrefix") 3038 max_results: Optional[int] = Field(default=None, alias="MaxResults") 3039 next_token: Optional[str] = Field(default=None, alias="NextToken") 3040 3041 3042class SecurityProfileSearchSummaryModel(BaseModel): 3043 id: Optional[str] = Field(default=None, alias="Id") 3044 organization_resource_id: Optional[str] = Field( 3045 default=None, alias="OrganizationResourceId" 3046 ) 3047 arn: Optional[str] = Field(default=None, alias="Arn") 3048 security_profile_name: Optional[str] = Field( 3049 default=None, alias="SecurityProfileName" 3050 ) 3051 description: Optional[str] = Field(default=None, alias="Description") 3052 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 3053 3054 3055class SearchVocabulariesRequestModel(BaseModel): 3056 instance_id: str = Field(alias="InstanceId") 3057 max_results: Optional[int] = Field(default=None, alias="MaxResults") 3058 next_token: Optional[str] = Field(default=None, alias="NextToken") 3059 state: Optional[ 3060 Literal[ 3061 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 3062 ] 3063 ] = Field(default=None, alias="State") 3064 name_starts_with: Optional[str] = Field(default=None, alias="NameStartsWith") 3065 language_code: Optional[ 3066 Literal[ 3067 "ar-AE", 3068 "de-CH", 3069 "de-DE", 3070 "en-AB", 3071 "en-AU", 3072 "en-GB", 3073 "en-IE", 3074 "en-IN", 3075 "en-NZ", 3076 "en-US", 3077 "en-WL", 3078 "en-ZA", 3079 "es-ES", 3080 "es-US", 3081 "fr-CA", 3082 "fr-FR", 3083 "hi-IN", 3084 "it-IT", 3085 "ja-JP", 3086 "ko-KR", 3087 "pt-BR", 3088 "pt-PT", 3089 "zh-CN", 3090 ] 3091 ] = Field(default=None, alias="LanguageCode") 3092 3093 3094class VocabularySummaryModel(BaseModel): 3095 name: str = Field(alias="Name") 3096 id: str = Field(alias="Id") 3097 arn: str = Field(alias="Arn") 3098 language_code: Literal[ 3099 "ar-AE", 3100 "de-CH", 3101 "de-DE", 3102 "en-AB", 3103 "en-AU", 3104 "en-GB", 3105 "en-IE", 3106 "en-IN", 3107 "en-NZ", 3108 "en-US", 3109 "en-WL", 3110 "en-ZA", 3111 "es-ES", 3112 "es-US", 3113 "fr-CA", 3114 "fr-FR", 3115 "hi-IN", 3116 "it-IT", 3117 "ja-JP", 3118 "ko-KR", 3119 "pt-BR", 3120 "pt-PT", 3121 "zh-CN", 3122 ] = Field(alias="LanguageCode") 3123 state: Literal[ 3124 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 3125 ] = Field(alias="State") 3126 last_modified_time: datetime = Field(alias="LastModifiedTime") 3127 failure_reason: Optional[str] = Field(default=None, alias="FailureReason") 3128 3129 3130class VoiceRecordingConfigurationModel(BaseModel): 3131 voice_recording_track: Optional[Literal["ALL", "FROM_AGENT", "TO_AGENT"]] = Field( 3132 default=None, alias="VoiceRecordingTrack" 3133 ) 3134 3135 3136class StopContactRecordingRequestModel(BaseModel): 3137 instance_id: str = Field(alias="InstanceId") 3138 contact_id: str = Field(alias="ContactId") 3139 initial_contact_id: str = Field(alias="InitialContactId") 3140 3141 3142class StopContactRequestModel(BaseModel): 3143 contact_id: str = Field(alias="ContactId") 3144 instance_id: str = Field(alias="InstanceId") 3145 3146 3147class StopContactStreamingRequestModel(BaseModel): 3148 instance_id: str = Field(alias="InstanceId") 3149 contact_id: str = Field(alias="ContactId") 3150 streaming_id: str = Field(alias="StreamingId") 3151 3152 3153class SuspendContactRecordingRequestModel(BaseModel): 3154 instance_id: str = Field(alias="InstanceId") 3155 contact_id: str = Field(alias="ContactId") 3156 initial_contact_id: str = Field(alias="InitialContactId") 3157 3158 3159class TagResourceRequestModel(BaseModel): 3160 resource_arn: str = Field(alias="resourceArn") 3161 tags: Mapping[str, str] = Field(alias="tags") 3162 3163 3164class TransferContactRequestModel(BaseModel): 3165 instance_id: str = Field(alias="InstanceId") 3166 contact_id: str = Field(alias="ContactId") 3167 contact_flow_id: str = Field(alias="ContactFlowId") 3168 queue_id: Optional[str] = Field(default=None, alias="QueueId") 3169 user_id: Optional[str] = Field(default=None, alias="UserId") 3170 client_token: Optional[str] = Field(default=None, alias="ClientToken") 3171 3172 3173class UntagResourceRequestModel(BaseModel): 3174 resource_arn: str = Field(alias="resourceArn") 3175 tag_keys: Sequence[str] = Field(alias="tagKeys") 3176 3177 3178class UpdateAgentStatusRequestModel(BaseModel): 3179 instance_id: str = Field(alias="InstanceId") 3180 agent_status_id: str = Field(alias="AgentStatusId") 3181 name: Optional[str] = Field(default=None, alias="Name") 3182 description: Optional[str] = Field(default=None, alias="Description") 3183 state: Optional[Literal["DISABLED", "ENABLED"]] = Field(default=None, alias="State") 3184 display_order: Optional[int] = Field(default=None, alias="DisplayOrder") 3185 reset_order_number: Optional[bool] = Field(default=None, alias="ResetOrderNumber") 3186 3187 3188class UpdateContactAttributesRequestModel(BaseModel): 3189 initial_contact_id: str = Field(alias="InitialContactId") 3190 instance_id: str = Field(alias="InstanceId") 3191 attributes: Mapping[str, str] = Field(alias="Attributes") 3192 3193 3194class UpdateContactFlowContentRequestModel(BaseModel): 3195 instance_id: str = Field(alias="InstanceId") 3196 contact_flow_id: str = Field(alias="ContactFlowId") 3197 content: str = Field(alias="Content") 3198 3199 3200class UpdateContactFlowMetadataRequestModel(BaseModel): 3201 instance_id: str = Field(alias="InstanceId") 3202 contact_flow_id: str = Field(alias="ContactFlowId") 3203 name: Optional[str] = Field(default=None, alias="Name") 3204 description: Optional[str] = Field(default=None, alias="Description") 3205 contact_flow_state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field( 3206 default=None, alias="ContactFlowState" 3207 ) 3208 3209 3210class UpdateContactFlowModuleContentRequestModel(BaseModel): 3211 instance_id: str = Field(alias="InstanceId") 3212 contact_flow_module_id: str = Field(alias="ContactFlowModuleId") 3213 content: str = Field(alias="Content") 3214 3215 3216class UpdateContactFlowModuleMetadataRequestModel(BaseModel): 3217 instance_id: str = Field(alias="InstanceId") 3218 contact_flow_module_id: str = Field(alias="ContactFlowModuleId") 3219 name: Optional[str] = Field(default=None, alias="Name") 3220 description: Optional[str] = Field(default=None, alias="Description") 3221 state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field(default=None, alias="State") 3222 3223 3224class UpdateContactFlowNameRequestModel(BaseModel): 3225 instance_id: str = Field(alias="InstanceId") 3226 contact_flow_id: str = Field(alias="ContactFlowId") 3227 name: Optional[str] = Field(default=None, alias="Name") 3228 description: Optional[str] = Field(default=None, alias="Description") 3229 3230 3231class UpdateContactScheduleRequestModel(BaseModel): 3232 instance_id: str = Field(alias="InstanceId") 3233 contact_id: str = Field(alias="ContactId") 3234 scheduled_time: Union[datetime, str] = Field(alias="ScheduledTime") 3235 3236 3237class UpdateInstanceAttributeRequestModel(BaseModel): 3238 instance_id: str = Field(alias="InstanceId") 3239 attribute_type: Literal[ 3240 "AUTO_RESOLVE_BEST_VOICES", 3241 "CONTACTFLOW_LOGS", 3242 "CONTACT_LENS", 3243 "EARLY_MEDIA", 3244 "ENHANCED_CONTACT_MONITORING", 3245 "HIGH_VOLUME_OUTBOUND", 3246 "INBOUND_CALLS", 3247 "MULTI_PARTY_CONFERENCE", 3248 "OUTBOUND_CALLS", 3249 "USE_CUSTOM_TTS_VOICES", 3250 ] = Field(alias="AttributeType") 3251 value: str = Field(alias="Value") 3252 3253 3254class UpdatePhoneNumberRequestModel(BaseModel): 3255 phone_number_id: str = Field(alias="PhoneNumberId") 3256 target_arn: str = Field(alias="TargetArn") 3257 client_token: Optional[str] = Field(default=None, alias="ClientToken") 3258 3259 3260class UpdateQueueHoursOfOperationRequestModel(BaseModel): 3261 instance_id: str = Field(alias="InstanceId") 3262 queue_id: str = Field(alias="QueueId") 3263 hours_of_operation_id: str = Field(alias="HoursOfOperationId") 3264 3265 3266class UpdateQueueMaxContactsRequestModel(BaseModel): 3267 instance_id: str = Field(alias="InstanceId") 3268 queue_id: str = Field(alias="QueueId") 3269 max_contacts: Optional[int] = Field(default=None, alias="MaxContacts") 3270 3271 3272class UpdateQueueNameRequestModel(BaseModel): 3273 instance_id: str = Field(alias="InstanceId") 3274 queue_id: str = Field(alias="QueueId") 3275 name: Optional[str] = Field(default=None, alias="Name") 3276 description: Optional[str] = Field(default=None, alias="Description") 3277 3278 3279class UpdateQueueStatusRequestModel(BaseModel): 3280 instance_id: str = Field(alias="InstanceId") 3281 queue_id: str = Field(alias="QueueId") 3282 status: Literal["DISABLED", "ENABLED"] = Field(alias="Status") 3283 3284 3285class UpdateQuickConnectNameRequestModel(BaseModel): 3286 instance_id: str = Field(alias="InstanceId") 3287 quick_connect_id: str = Field(alias="QuickConnectId") 3288 name: Optional[str] = Field(default=None, alias="Name") 3289 description: Optional[str] = Field(default=None, alias="Description") 3290 3291 3292class UpdateRoutingProfileDefaultOutboundQueueRequestModel(BaseModel): 3293 instance_id: str = Field(alias="InstanceId") 3294 routing_profile_id: str = Field(alias="RoutingProfileId") 3295 default_outbound_queue_id: str = Field(alias="DefaultOutboundQueueId") 3296 3297 3298class UpdateRoutingProfileNameRequestModel(BaseModel): 3299 instance_id: str = Field(alias="InstanceId") 3300 routing_profile_id: str = Field(alias="RoutingProfileId") 3301 name: Optional[str] = Field(default=None, alias="Name") 3302 description: Optional[str] = Field(default=None, alias="Description") 3303 3304 3305class UpdateSecurityProfileRequestModel(BaseModel): 3306 security_profile_id: str = Field(alias="SecurityProfileId") 3307 instance_id: str = Field(alias="InstanceId") 3308 description: Optional[str] = Field(default=None, alias="Description") 3309 permissions: Optional[Sequence[str]] = Field(default=None, alias="Permissions") 3310 allowed_access_control_tags: Optional[Mapping[str, str]] = Field( 3311 default=None, alias="AllowedAccessControlTags" 3312 ) 3313 tag_restricted_resources: Optional[Sequence[str]] = Field( 3314 default=None, alias="TagRestrictedResources" 3315 ) 3316 3317 3318class UpdateUserHierarchyGroupNameRequestModel(BaseModel): 3319 name: str = Field(alias="Name") 3320 hierarchy_group_id: str = Field(alias="HierarchyGroupId") 3321 instance_id: str = Field(alias="InstanceId") 3322 3323 3324class UpdateUserHierarchyRequestModel(BaseModel): 3325 user_id: str = Field(alias="UserId") 3326 instance_id: str = Field(alias="InstanceId") 3327 hierarchy_group_id: Optional[str] = Field(default=None, alias="HierarchyGroupId") 3328 3329 3330class UpdateUserRoutingProfileRequestModel(BaseModel): 3331 routing_profile_id: str = Field(alias="RoutingProfileId") 3332 user_id: str = Field(alias="UserId") 3333 instance_id: str = Field(alias="InstanceId") 3334 3335 3336class UpdateUserSecurityProfilesRequestModel(BaseModel): 3337 security_profile_ids: Sequence[str] = Field(alias="SecurityProfileIds") 3338 user_id: str = Field(alias="UserId") 3339 instance_id: str = Field(alias="InstanceId") 3340 3341 3342class UserReferenceModel(BaseModel): 3343 id: Optional[str] = Field(default=None, alias="Id") 3344 arn: Optional[str] = Field(default=None, alias="Arn") 3345 3346 3347class UserIdentityInfoLiteModel(BaseModel): 3348 first_name: Optional[str] = Field(default=None, alias="FirstName") 3349 last_name: Optional[str] = Field(default=None, alias="LastName") 3350 3351 3352class RuleSummaryModel(BaseModel): 3353 name: str = Field(alias="Name") 3354 rule_id: str = Field(alias="RuleId") 3355 rule_arn: str = Field(alias="RuleArn") 3356 event_source_name: Literal[ 3357 "OnPostCallAnalysisAvailable", 3358 "OnPostChatAnalysisAvailable", 3359 "OnRealTimeCallAnalysisAvailable", 3360 "OnSalesforceCaseCreate", 3361 "OnZendeskTicketCreate", 3362 "OnZendeskTicketStatusUpdate", 3363 ] = Field(alias="EventSourceName") 3364 publish_status: Literal["DRAFT", "PUBLISHED"] = Field(alias="PublishStatus") 3365 action_summaries: List[ActionSummaryModel] = Field(alias="ActionSummaries") 3366 created_time: datetime = Field(alias="CreatedTime") 3367 last_updated_time: datetime = Field(alias="LastUpdatedTime") 3368 3369 3370class AgentContactReferenceModel(BaseModel): 3371 contact_id: Optional[str] = Field(default=None, alias="ContactId") 3372 channel: Optional[Literal["CHAT", "TASK", "VOICE"]] = Field( 3373 default=None, alias="Channel" 3374 ) 3375 initiation_method: Optional[ 3376 Literal[ 3377 "API", 3378 "CALLBACK", 3379 "DISCONNECT", 3380 "INBOUND", 3381 "MONITOR", 3382 "OUTBOUND", 3383 "QUEUE_TRANSFER", 3384 "TRANSFER", 3385 ] 3386 ] = Field(default=None, alias="InitiationMethod") 3387 agent_contact_state: Optional[ 3388 Literal[ 3389 "CONNECTED", 3390 "CONNECTED_ONHOLD", 3391 "CONNECTING", 3392 "ENDED", 3393 "ERROR", 3394 "INCOMING", 3395 "MISSED", 3396 "PENDING", 3397 "REJECTED", 3398 ] 3399 ] = Field(default=None, alias="AgentContactState") 3400 state_start_timestamp: Optional[datetime] = Field( 3401 default=None, alias="StateStartTimestamp" 3402 ) 3403 connected_to_agent_timestamp: Optional[datetime] = Field( 3404 default=None, alias="ConnectedToAgentTimestamp" 3405 ) 3406 queue: Optional[QueueReferenceModel] = Field(default=None, alias="Queue") 3407 3408 3409class StartOutboundVoiceContactRequestModel(BaseModel): 3410 destination_phone_number: str = Field(alias="DestinationPhoneNumber") 3411 contact_flow_id: str = Field(alias="ContactFlowId") 3412 instance_id: str = Field(alias="InstanceId") 3413 client_token: Optional[str] = Field(default=None, alias="ClientToken") 3414 source_phone_number: Optional[str] = Field(default=None, alias="SourcePhoneNumber") 3415 queue_id: Optional[str] = Field(default=None, alias="QueueId") 3416 attributes: Optional[Mapping[str, str]] = Field(default=None, alias="Attributes") 3417 answer_machine_detection_config: Optional[ 3418 AnswerMachineDetectionConfigModel 3419 ] = Field(default=None, alias="AnswerMachineDetectionConfig") 3420 campaign_id: Optional[str] = Field(default=None, alias="CampaignId") 3421 traffic_type: Optional[Literal["CAMPAIGN", "GENERAL"]] = Field( 3422 default=None, alias="TrafficType" 3423 ) 3424 3425 3426class AssociateLexBotRequestModel(BaseModel): 3427 instance_id: str = Field(alias="InstanceId") 3428 lex_bot: LexBotModel = Field(alias="LexBot") 3429 3430 3431class AssociateBotRequestModel(BaseModel): 3432 instance_id: str = Field(alias="InstanceId") 3433 lex_bot: Optional[LexBotModel] = Field(default=None, alias="LexBot") 3434 lex_v2_bot: Optional[LexV2BotModel] = Field(default=None, alias="LexV2Bot") 3435 3436 3437class DisassociateBotRequestModel(BaseModel): 3438 instance_id: str = Field(alias="InstanceId") 3439 lex_bot: Optional[LexBotModel] = Field(default=None, alias="LexBot") 3440 lex_v2_bot: Optional[LexV2BotModel] = Field(default=None, alias="LexV2Bot") 3441 3442 3443class LexBotConfigModel(BaseModel): 3444 lex_bot: Optional[LexBotModel] = Field(default=None, alias="LexBot") 3445 lex_v2_bot: Optional[LexV2BotModel] = Field(default=None, alias="LexV2Bot") 3446 3447 3448class AssociateInstanceStorageConfigResponseModel(BaseModel): 3449 association_id: str = Field(alias="AssociationId") 3450 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3451 3452 3453class AssociateSecurityKeyResponseModel(BaseModel): 3454 association_id: str = Field(alias="AssociationId") 3455 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3456 3457 3458class ClaimPhoneNumberResponseModel(BaseModel): 3459 phone_number_id: str = Field(alias="PhoneNumberId") 3460 phone_number_arn: str = Field(alias="PhoneNumberArn") 3461 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3462 3463 3464class CreateAgentStatusResponseModel(BaseModel): 3465 agent_status_arn: str = Field(alias="AgentStatusARN") 3466 agent_status_id: str = Field(alias="AgentStatusId") 3467 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3468 3469 3470class CreateContactFlowModuleResponseModel(BaseModel): 3471 id: str = Field(alias="Id") 3472 arn: str = Field(alias="Arn") 3473 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3474 3475 3476class CreateContactFlowResponseModel(BaseModel): 3477 contact_flow_id: str = Field(alias="ContactFlowId") 3478 contact_flow_arn: str = Field(alias="ContactFlowArn") 3479 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3480 3481 3482class CreateHoursOfOperationResponseModel(BaseModel): 3483 hours_of_operation_id: str = Field(alias="HoursOfOperationId") 3484 hours_of_operation_arn: str = Field(alias="HoursOfOperationArn") 3485 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3486 3487 3488class CreateInstanceResponseModel(BaseModel): 3489 id: str = Field(alias="Id") 3490 arn: str = Field(alias="Arn") 3491 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3492 3493 3494class CreateIntegrationAssociationResponseModel(BaseModel): 3495 integration_association_id: str = Field(alias="IntegrationAssociationId") 3496 integration_association_arn: str = Field(alias="IntegrationAssociationArn") 3497 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3498 3499 3500class CreateQueueResponseModel(BaseModel): 3501 queue_arn: str = Field(alias="QueueArn") 3502 queue_id: str = Field(alias="QueueId") 3503 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3504 3505 3506class CreateQuickConnectResponseModel(BaseModel): 3507 quick_connect_arn: str = Field(alias="QuickConnectARN") 3508 quick_connect_id: str = Field(alias="QuickConnectId") 3509 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3510 3511 3512class CreateRoutingProfileResponseModel(BaseModel): 3513 routing_profile_arn: str = Field(alias="RoutingProfileArn") 3514 routing_profile_id: str = Field(alias="RoutingProfileId") 3515 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3516 3517 3518class CreateRuleResponseModel(BaseModel): 3519 rule_arn: str = Field(alias="RuleArn") 3520 rule_id: str = Field(alias="RuleId") 3521 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3522 3523 3524class CreateSecurityProfileResponseModel(BaseModel): 3525 security_profile_id: str = Field(alias="SecurityProfileId") 3526 security_profile_arn: str = Field(alias="SecurityProfileArn") 3527 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3528 3529 3530class CreateTaskTemplateResponseModel(BaseModel): 3531 id: str = Field(alias="Id") 3532 arn: str = Field(alias="Arn") 3533 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3534 3535 3536class CreateTrafficDistributionGroupResponseModel(BaseModel): 3537 id: str = Field(alias="Id") 3538 arn: str = Field(alias="Arn") 3539 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3540 3541 3542class CreateUseCaseResponseModel(BaseModel): 3543 use_case_id: str = Field(alias="UseCaseId") 3544 use_case_arn: str = Field(alias="UseCaseArn") 3545 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3546 3547 3548class CreateUserHierarchyGroupResponseModel(BaseModel): 3549 hierarchy_group_id: str = Field(alias="HierarchyGroupId") 3550 hierarchy_group_arn: str = Field(alias="HierarchyGroupArn") 3551 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3552 3553 3554class CreateUserResponseModel(BaseModel): 3555 user_id: str = Field(alias="UserId") 3556 user_arn: str = Field(alias="UserArn") 3557 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3558 3559 3560class CreateVocabularyResponseModel(BaseModel): 3561 vocabulary_arn: str = Field(alias="VocabularyArn") 3562 vocabulary_id: str = Field(alias="VocabularyId") 3563 state: Literal[ 3564 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 3565 ] = Field(alias="State") 3566 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3567 3568 3569class DeleteVocabularyResponseModel(BaseModel): 3570 vocabulary_arn: str = Field(alias="VocabularyArn") 3571 vocabulary_id: str = Field(alias="VocabularyId") 3572 state: Literal[ 3573 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 3574 ] = Field(alias="State") 3575 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3576 3577 3578class DescribeAgentStatusResponseModel(BaseModel): 3579 agent_status: AgentStatusModel = Field(alias="AgentStatus") 3580 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3581 3582 3583class EmptyResponseMetadataModel(BaseModel): 3584 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3585 3586 3587class GetContactAttributesResponseModel(BaseModel): 3588 attributes: Dict[str, str] = Field(alias="Attributes") 3589 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3590 3591 3592class ListAgentStatusResponseModel(BaseModel): 3593 next_token: str = Field(alias="NextToken") 3594 agent_status_summary_list: List[AgentStatusSummaryModel] = Field( 3595 alias="AgentStatusSummaryList" 3596 ) 3597 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3598 3599 3600class ListApprovedOriginsResponseModel(BaseModel): 3601 origins: List[str] = Field(alias="Origins") 3602 next_token: str = Field(alias="NextToken") 3603 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3604 3605 3606class ListLambdaFunctionsResponseModel(BaseModel): 3607 lambda_functions: List[str] = Field(alias="LambdaFunctions") 3608 next_token: str = Field(alias="NextToken") 3609 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3610 3611 3612class ListLexBotsResponseModel(BaseModel): 3613 lex_bots: List[LexBotModel] = Field(alias="LexBots") 3614 next_token: str = Field(alias="NextToken") 3615 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3616 3617 3618class ListSecurityProfilePermissionsResponseModel(BaseModel): 3619 permissions: List[str] = Field(alias="Permissions") 3620 next_token: str = Field(alias="NextToken") 3621 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3622 3623 3624class ListTagsForResourceResponseModel(BaseModel): 3625 tags: Dict[str, str] = Field(alias="tags") 3626 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3627 3628 3629class MonitorContactResponseModel(BaseModel): 3630 contact_id: str = Field(alias="ContactId") 3631 contact_arn: str = Field(alias="ContactArn") 3632 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3633 3634 3635class ReplicateInstanceResponseModel(BaseModel): 3636 id: str = Field(alias="Id") 3637 arn: str = Field(alias="Arn") 3638 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3639 3640 3641class StartChatContactResponseModel(BaseModel): 3642 contact_id: str = Field(alias="ContactId") 3643 participant_id: str = Field(alias="ParticipantId") 3644 participant_token: str = Field(alias="ParticipantToken") 3645 continued_from_contact_id: str = Field(alias="ContinuedFromContactId") 3646 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3647 3648 3649class StartContactStreamingResponseModel(BaseModel): 3650 streaming_id: str = Field(alias="StreamingId") 3651 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3652 3653 3654class StartOutboundVoiceContactResponseModel(BaseModel): 3655 contact_id: str = Field(alias="ContactId") 3656 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3657 3658 3659class StartTaskContactResponseModel(BaseModel): 3660 contact_id: str = Field(alias="ContactId") 3661 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3662 3663 3664class TransferContactResponseModel(BaseModel): 3665 contact_id: str = Field(alias="ContactId") 3666 contact_arn: str = Field(alias="ContactArn") 3667 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3668 3669 3670class UpdatePhoneNumberResponseModel(BaseModel): 3671 phone_number_id: str = Field(alias="PhoneNumberId") 3672 phone_number_arn: str = Field(alias="PhoneNumberArn") 3673 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3674 3675 3676class DescribeInstanceAttributeResponseModel(BaseModel): 3677 attribute: AttributeModel = Field(alias="Attribute") 3678 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3679 3680 3681class ListInstanceAttributesResponseModel(BaseModel): 3682 attributes: List[AttributeModel] = Field(alias="Attributes") 3683 next_token: str = Field(alias="NextToken") 3684 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3685 3686 3687class SearchAvailablePhoneNumbersResponseModel(BaseModel): 3688 next_token: str = Field(alias="NextToken") 3689 available_numbers_list: List[AvailableNumberSummaryModel] = Field( 3690 alias="AvailableNumbersList" 3691 ) 3692 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3693 3694 3695class StartContactStreamingRequestModel(BaseModel): 3696 instance_id: str = Field(alias="InstanceId") 3697 contact_id: str = Field(alias="ContactId") 3698 chat_streaming_configuration: ChatStreamingConfigurationModel = Field( 3699 alias="ChatStreamingConfiguration" 3700 ) 3701 client_token: str = Field(alias="ClientToken") 3702 3703 3704class ClaimedPhoneNumberSummaryModel(BaseModel): 3705 phone_number_id: Optional[str] = Field(default=None, alias="PhoneNumberId") 3706 phone_number_arn: Optional[str] = Field(default=None, alias="PhoneNumberArn") 3707 phone_number: Optional[str] = Field(default=None, alias="PhoneNumber") 3708 phone_number_country_code: Optional[ 3709 Literal[ 3710 "AD", 3711 "AE", 3712 "AF", 3713 "AG", 3714 "AI", 3715 "AL", 3716 "AM", 3717 "AN", 3718 "AO", 3719 "AQ", 3720 "AR", 3721 "AS", 3722 "AT", 3723 "AU", 3724 "AW", 3725 "AZ", 3726 "BA", 3727 "BB", 3728 "BD", 3729 "BE", 3730 "BF", 3731 "BG", 3732 "BH", 3733 "BI", 3734 "BJ", 3735 "BL", 3736 "BM", 3737 "BN", 3738 "BO", 3739 "BR", 3740 "BS", 3741 "BT", 3742 "BW", 3743 "BY", 3744 "BZ", 3745 "CA", 3746 "CC", 3747 "CD", 3748 "CF", 3749 "CG", 3750 "CH", 3751 "CI", 3752 "CK", 3753 "CL", 3754 "CM", 3755 "CN", 3756 "CO", 3757 "CR", 3758 "CU", 3759 "CV", 3760 "CW", 3761 "CX", 3762 "CY", 3763 "CZ", 3764 "DE", 3765 "DJ", 3766 "DK", 3767 "DM", 3768 "DO", 3769 "DZ", 3770 "EC", 3771 "EE", 3772 "EG", 3773 "EH", 3774 "ER", 3775 "ES", 3776 "ET", 3777 "FI", 3778 "FJ", 3779 "FK", 3780 "FM", 3781 "FO", 3782 "FR", 3783 "GA", 3784 "GB", 3785 "GD", 3786 "GE", 3787 "GG", 3788 "GH", 3789 "GI", 3790 "GL", 3791 "GM", 3792 "GN", 3793 "GQ", 3794 "GR", 3795 "GT", 3796 "GU", 3797 "GW", 3798 "GY", 3799 "HK", 3800 "HN", 3801 "HR", 3802 "HT", 3803 "HU", 3804 "ID", 3805 "IE", 3806 "IL", 3807 "IM", 3808 "IN", 3809 "Type[IO]", 3810 "IQ", 3811 "IR", 3812 "IS", 3813 "IT", 3814 "JE", 3815 "JM", 3816 "JO", 3817 "JP", 3818 "KE", 3819 "KG", 3820 "KH", 3821 "KI", 3822 "KM", 3823 "KN", 3824 "KP", 3825 "KR", 3826 "KW", 3827 "KY", 3828 "KZ", 3829 "LA", 3830 "LB", 3831 "LC", 3832 "LI", 3833 "LK", 3834 "LR", 3835 "LS", 3836 "LT", 3837 "LU", 3838 "LV", 3839 "LY", 3840 "MA", 3841 "MC", 3842 "MD", 3843 "ME", 3844 "MF", 3845 "MG", 3846 "MH", 3847 "MK", 3848 "ML", 3849 "MM", 3850 "MN", 3851 "MO", 3852 "MP", 3853 "MR", 3854 "MS", 3855 "MT", 3856 "MU", 3857 "MV", 3858 "MW", 3859 "MX", 3860 "MY", 3861 "MZ", 3862 "NA", 3863 "NC", 3864 "NE", 3865 "NG", 3866 "NI", 3867 "NL", 3868 "NO", 3869 "NP", 3870 "NR", 3871 "NU", 3872 "NZ", 3873 "OM", 3874 "PA", 3875 "PE", 3876 "PF", 3877 "PG", 3878 "PH", 3879 "PK", 3880 "PL", 3881 "PM", 3882 "PN", 3883 "PR", 3884 "PT", 3885 "PW", 3886 "PY", 3887 "QA", 3888 "RE", 3889 "RO", 3890 "RS", 3891 "RU", 3892 "RW", 3893 "SA", 3894 "SB", 3895 "SC", 3896 "SD", 3897 "SE", 3898 "SG", 3899 "SH", 3900 "SI", 3901 "SJ", 3902 "SK", 3903 "SL", 3904 "SM", 3905 "SN", 3906 "SO", 3907 "SR", 3908 "ST", 3909 "SV", 3910 "SX", 3911 "SY", 3912 "SZ", 3913 "TC", 3914 "TD", 3915 "TG", 3916 "TH", 3917 "TJ", 3918 "TK", 3919 "TL", 3920 "TM", 3921 "TN", 3922 "TO", 3923 "TR", 3924 "TT", 3925 "TV", 3926 "TW", 3927 "TZ", 3928 "UA", 3929 "UG", 3930 "US", 3931 "UY", 3932 "UZ", 3933 "VA", 3934 "VC", 3935 "VE", 3936 "VG", 3937 "VI", 3938 "VN", 3939 "VU", 3940 "WF", 3941 "WS", 3942 "YE", 3943 "YT", 3944 "ZA", 3945 "ZM", 3946 "ZW", 3947 ] 3948 ] = Field(default=None, alias="PhoneNumberCountryCode") 3949 phone_number_type: Optional[Literal["DID", "TOLL_FREE"]] = Field( 3950 default=None, alias="PhoneNumberType" 3951 ) 3952 phone_number_description: Optional[str] = Field( 3953 default=None, alias="PhoneNumberDescription" 3954 ) 3955 target_arn: Optional[str] = Field(default=None, alias="TargetArn") 3956 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 3957 phone_number_status: Optional[PhoneNumberStatusModel] = Field( 3958 default=None, alias="PhoneNumberStatus" 3959 ) 3960 3961 3962class UserDataFiltersModel(BaseModel): 3963 queues: Optional[Sequence[str]] = Field(default=None, alias="Queues") 3964 contact_filter: Optional[ContactFilterModel] = Field( 3965 default=None, alias="ContactFilter" 3966 ) 3967 routing_profiles: Optional[Sequence[str]] = Field( 3968 default=None, alias="RoutingProfiles" 3969 ) 3970 agents: Optional[Sequence[str]] = Field(default=None, alias="Agents") 3971 user_hierarchy_groups: Optional[Sequence[str]] = Field( 3972 default=None, alias="UserHierarchyGroups" 3973 ) 3974 3975 3976class ListContactFlowModulesResponseModel(BaseModel): 3977 contact_flow_modules_summary_list: List[ContactFlowModuleSummaryModel] = Field( 3978 alias="ContactFlowModulesSummaryList" 3979 ) 3980 next_token: str = Field(alias="NextToken") 3981 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3982 3983 3984class DescribeContactFlowModuleResponseModel(BaseModel): 3985 contact_flow_module: ContactFlowModuleModel = Field(alias="ContactFlowModule") 3986 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3987 3988 3989class ListContactFlowsResponseModel(BaseModel): 3990 contact_flow_summary_list: List[ContactFlowSummaryModel] = Field( 3991 alias="ContactFlowSummaryList" 3992 ) 3993 next_token: str = Field(alias="NextToken") 3994 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 3995 3996 3997class DescribeContactFlowResponseModel(BaseModel): 3998 contact_flow: ContactFlowModel = Field(alias="ContactFlow") 3999 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 4000 4001 4002class ContactModel(BaseModel): 4003 arn: Optional[str] = Field(default=None, alias="Arn") 4004 id: Optional[str] = Field(default=None, alias="Id") 4005 initial_contact_id: Optional[str] = Field(default=None, alias="InitialContactId") 4006 previous_contact_id: Optional[str] = Field(default=None, alias="PreviousContactId") 4007 initiation_method: Optional[ 4008 Literal[ 4009 "API", 4010 "CALLBACK", 4011 "DISCONNECT", 4012 "INBOUND", 4013 "MONITOR", 4014 "OUTBOUND", 4015 "QUEUE_TRANSFER", 4016 "TRANSFER", 4017 ] 4018 ] = Field(default=None, alias="InitiationMethod") 4019 name: Optional[str] = Field(default=None, alias="Name") 4020 description: Optional[str] = Field(default=None, alias="Description") 4021 channel: Optional[Literal["CHAT", "TASK", "VOICE"]] = Field( 4022 default=None, alias="Channel" 4023 ) 4024 queue_info: Optional[QueueInfoModel] = Field(default=None, alias="QueueInfo") 4025 agent_info: Optional[AgentInfoModel] = Field(default=None, alias="AgentInfo") 4026 initiation_timestamp: Optional[datetime] = Field( 4027 default=None, alias="InitiationTimestamp" 4028 ) 4029 disconnect_timestamp: Optional[datetime] = Field( 4030 default=None, alias="DisconnectTimestamp" 4031 ) 4032 last_update_timestamp: Optional[datetime] = Field( 4033 default=None, alias="LastUpdateTimestamp" 4034 ) 4035 scheduled_timestamp: Optional[datetime] = Field( 4036 default=None, alias="ScheduledTimestamp" 4037 ) 4038 related_contact_id: Optional[str] = Field(default=None, alias="RelatedContactId") 4039 wisdom_info: Optional[WisdomInfoModel] = Field(default=None, alias="WisdomInfo") 4040 4041 4042class ControlPlaneTagFilterModel(BaseModel): 4043 or_conditions: Optional[Sequence[Sequence[TagConditionModel]]] = Field( 4044 default=None, alias="OrConditions" 4045 ) 4046 and_conditions: Optional[Sequence[TagConditionModel]] = Field( 4047 default=None, alias="AndConditions" 4048 ) 4049 tag_condition: Optional[TagConditionModel] = Field( 4050 default=None, alias="TagCondition" 4051 ) 4052 4053 4054class CreateQueueRequestModel(BaseModel): 4055 instance_id: str = Field(alias="InstanceId") 4056 name: str = Field(alias="Name") 4057 hours_of_operation_id: str = Field(alias="HoursOfOperationId") 4058 description: Optional[str] = Field(default=None, alias="Description") 4059 outbound_caller_config: Optional[OutboundCallerConfigModel] = Field( 4060 default=None, alias="OutboundCallerConfig" 4061 ) 4062 max_contacts: Optional[int] = Field(default=None, alias="MaxContacts") 4063 quick_connect_ids: Optional[Sequence[str]] = Field( 4064 default=None, alias="QuickConnectIds" 4065 ) 4066 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 4067 4068 4069class QueueModel(BaseModel): 4070 name: Optional[str] = Field(default=None, alias="Name") 4071 queue_arn: Optional[str] = Field(default=None, alias="QueueArn") 4072 queue_id: Optional[str] = Field(default=None, alias="QueueId") 4073 description: Optional[str] = Field(default=None, alias="Description") 4074 outbound_caller_config: Optional[OutboundCallerConfigModel] = Field( 4075 default=None, alias="OutboundCallerConfig" 4076 ) 4077 hours_of_operation_id: Optional[str] = Field( 4078 default=None, alias="HoursOfOperationId" 4079 ) 4080 max_contacts: Optional[int] = Field(default=None, alias="MaxContacts") 4081 status: Optional[Literal["DISABLED", "ENABLED"]] = Field( 4082 default=None, alias="Status" 4083 ) 4084 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 4085 4086 4087class UpdateQueueOutboundCallerConfigRequestModel(BaseModel): 4088 instance_id: str = Field(alias="InstanceId") 4089 queue_id: str = Field(alias="QueueId") 4090 outbound_caller_config: OutboundCallerConfigModel = Field( 4091 alias="OutboundCallerConfig" 4092 ) 4093 4094 4095class RoutingProfileModel(BaseModel): 4096 instance_id: Optional[str] = Field(default=None, alias="InstanceId") 4097 name: Optional[str] = Field(default=None, alias="Name") 4098 routing_profile_arn: Optional[str] = Field(default=None, alias="RoutingProfileArn") 4099 routing_profile_id: Optional[str] = Field(default=None, alias="RoutingProfileId") 4100 description: Optional[str] = Field(default=None, alias="Description") 4101 media_concurrencies: Optional[List[MediaConcurrencyModel]] = Field( 4102 default=None, alias="MediaConcurrencies" 4103 ) 4104 default_outbound_queue_id: Optional[str] = Field( 4105 default=None, alias="DefaultOutboundQueueId" 4106 ) 4107 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 4108 number_of_associated_queues: Optional[int] = Field( 4109 default=None, alias="NumberOfAssociatedQueues" 4110 ) 4111 number_of_associated_users: Optional[int] = Field( 4112 default=None, alias="NumberOfAssociatedUsers" 4113 ) 4114 4115 4116class UpdateRoutingProfileConcurrencyRequestModel(BaseModel): 4117 instance_id: str = Field(alias="InstanceId") 4118 routing_profile_id: str = Field(alias="RoutingProfileId") 4119 media_concurrencies: Sequence[MediaConcurrencyModel] = Field( 4120 alias="MediaConcurrencies" 4121 ) 4122 4123 4124class UpdateUserIdentityInfoRequestModel(BaseModel): 4125 identity_info: UserIdentityInfoModel = Field(alias="IdentityInfo") 4126 user_id: str = Field(alias="UserId") 4127 instance_id: str = Field(alias="InstanceId") 4128 4129 4130class CreateUserRequestModel(BaseModel): 4131 username: str = Field(alias="Username") 4132 phone_config: UserPhoneConfigModel = Field(alias="PhoneConfig") 4133 security_profile_ids: Sequence[str] = Field(alias="SecurityProfileIds") 4134 routing_profile_id: str = Field(alias="RoutingProfileId") 4135 instance_id: str = Field(alias="InstanceId") 4136 password: Optional[str] = Field(default=None, alias="Password") 4137 identity_info: Optional[UserIdentityInfoModel] = Field( 4138 default=None, alias="IdentityInfo" 4139 ) 4140 directory_user_id: Optional[str] = Field(default=None, alias="DirectoryUserId") 4141 hierarchy_group_id: Optional[str] = Field(default=None, alias="HierarchyGroupId") 4142 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 4143 4144 4145class UpdateUserPhoneConfigRequestModel(BaseModel): 4146 phone_config: UserPhoneConfigModel = Field(alias="PhoneConfig") 4147 user_id: str = Field(alias="UserId") 4148 instance_id: str = Field(alias="InstanceId") 4149 4150 4151class UserModel(BaseModel): 4152 id: Optional[str] = Field(default=None, alias="Id") 4153 arn: Optional[str] = Field(default=None, alias="Arn") 4154 username: Optional[str] = Field(default=None, alias="Username") 4155 identity_info: Optional[UserIdentityInfoModel] = Field( 4156 default=None, alias="IdentityInfo" 4157 ) 4158 phone_config: Optional[UserPhoneConfigModel] = Field( 4159 default=None, alias="PhoneConfig" 4160 ) 4161 directory_user_id: Optional[str] = Field(default=None, alias="DirectoryUserId") 4162 security_profile_ids: Optional[List[str]] = Field( 4163 default=None, alias="SecurityProfileIds" 4164 ) 4165 routing_profile_id: Optional[str] = Field(default=None, alias="RoutingProfileId") 4166 hierarchy_group_id: Optional[str] = Field(default=None, alias="HierarchyGroupId") 4167 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 4168 4169 4170class GetFederationTokenResponseModel(BaseModel): 4171 credentials: CredentialsModel = Field(alias="Credentials") 4172 sign_in_url: str = Field(alias="SignInUrl") 4173 user_arn: str = Field(alias="UserArn") 4174 user_id: str = Field(alias="UserId") 4175 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 4176 4177 4178class CurrentMetricDataModel(BaseModel): 4179 metric: Optional[CurrentMetricModel] = Field(default=None, alias="Metric") 4180 value: Optional[float] = Field(default=None, alias="Value") 4181 4182 4183class ListDefaultVocabulariesResponseModel(BaseModel): 4184 default_vocabulary_list: List[DefaultVocabularyModel] = Field( 4185 alias="DefaultVocabularyList" 4186 ) 4187 next_token: str = Field(alias="NextToken") 4188 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 4189 4190 4191class DescribeSecurityProfileResponseModel(BaseModel): 4192 security_profile: SecurityProfileModel = Field(alias="SecurityProfile") 4193 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 4194 4195 4196class DescribeTrafficDistributionGroupResponseModel(BaseModel): 4197 traffic_distribution_group: TrafficDistributionGroupModel = Field( 4198 alias="TrafficDistributionGroup" 4199 ) 4200 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 4201 4202 4203class DescribeVocabularyResponseModel(BaseModel): 4204 vocabulary: VocabularyModel = Field(alias="Vocabulary") 4205 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 4206 4207 4208class DimensionsModel(BaseModel): 4209 queue: Optional[QueueReferenceModel] = Field(default=None, alias="Queue") 4210 channel: Optional[Literal["CHAT", "TASK", "VOICE"]] = Field( 4211 default=None, alias="Channel" 4212 ) 4213 routing_profile: Optional[RoutingProfileReferenceModel] = Field( 4214 default=None, alias="RoutingProfile" 4215 ) 4216 4217 4218class DisassociateRoutingProfileQueuesRequestModel(BaseModel): 4219 instance_id: str = Field(alias="InstanceId") 4220 routing_profile_id: str = Field(alias="RoutingProfileId") 4221 queue_references: Sequence[RoutingProfileQueueReferenceModel] = Field( 4222 alias="QueueReferences" 4223 ) 4224 4225 4226class RoutingProfileQueueConfigModel(BaseModel): 4227 queue_reference: RoutingProfileQueueReferenceModel = Field(alias="QueueReference") 4228 priority: int = Field(alias="Priority") 4229 delay: int = Field(alias="Delay") 4230 4231 4232class TelephonyConfigModel(BaseModel): 4233 distributions: List[DistributionModel] = Field(alias="Distributions") 4234 4235 4236class KinesisVideoStreamConfigModel(BaseModel): 4237 prefix: str = Field(alias="Prefix") 4238 retention_period_hours: int = Field(alias="RetentionPeriodHours") 4239 encryption_config: EncryptionConfigModel = Field(alias="EncryptionConfig") 4240 4241 4242class S3ConfigModel(BaseModel): 4243 bucket_name: str = Field(alias="BucketName") 4244 bucket_prefix: str = Field(alias="BucketPrefix") 4245 encryption_config: Optional[EncryptionConfigModel] = Field( 4246 default=None, alias="EncryptionConfig" 4247 ) 4248 4249 4250class GetCurrentMetricDataRequestModel(BaseModel): 4251 instance_id: str = Field(alias="InstanceId") 4252 filters: FiltersModel = Field(alias="Filters") 4253 current_metrics: Sequence[CurrentMetricModel] = Field(alias="CurrentMetrics") 4254 groupings: Optional[ 4255 Sequence[Literal["CHANNEL", "QUEUE", "ROUTING_PROFILE"]] 4256 ] = Field(default=None, alias="Groupings") 4257 next_token: Optional[str] = Field(default=None, alias="NextToken") 4258 max_results: Optional[int] = Field(default=None, alias="MaxResults") 4259 sort_criteria: Optional[Sequence[CurrentMetricSortCriteriaModel]] = Field( 4260 default=None, alias="SortCriteria" 4261 ) 4262 4263 4264class ListAgentStatusRequestListAgentStatusesPaginateModel(BaseModel): 4265 instance_id: str = Field(alias="InstanceId") 4266 agent_status_types: Optional[ 4267 Sequence[Literal["CUSTOM", "OFFLINE", "ROUTABLE"]] 4268 ] = Field(default=None, alias="AgentStatusTypes") 4269 pagination_config: Optional[PaginatorConfigModel] = Field( 4270 default=None, alias="PaginationConfig" 4271 ) 4272 4273 4274class ListApprovedOriginsRequestListApprovedOriginsPaginateModel(BaseModel): 4275 instance_id: str = Field(alias="InstanceId") 4276 pagination_config: Optional[PaginatorConfigModel] = Field( 4277 default=None, alias="PaginationConfig" 4278 ) 4279 4280 4281class ListBotsRequestListBotsPaginateModel(BaseModel): 4282 instance_id: str = Field(alias="InstanceId") 4283 lex_version: Literal["V1", "V2"] = Field(alias="LexVersion") 4284 pagination_config: Optional[PaginatorConfigModel] = Field( 4285 default=None, alias="PaginationConfig" 4286 ) 4287 4288 4289class ListContactFlowModulesRequestListContactFlowModulesPaginateModel(BaseModel): 4290 instance_id: str = Field(alias="InstanceId") 4291 contact_flow_module_state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field( 4292 default=None, alias="ContactFlowModuleState" 4293 ) 4294 pagination_config: Optional[PaginatorConfigModel] = Field( 4295 default=None, alias="PaginationConfig" 4296 ) 4297 4298 4299class ListContactFlowsRequestListContactFlowsPaginateModel(BaseModel): 4300 instance_id: str = Field(alias="InstanceId") 4301 contact_flow_types: Optional[ 4302 Sequence[ 4303 Literal[ 4304 "AGENT_HOLD", 4305 "AGENT_TRANSFER", 4306 "AGENT_WHISPER", 4307 "CONTACT_FLOW", 4308 "CUSTOMER_HOLD", 4309 "CUSTOMER_QUEUE", 4310 "CUSTOMER_WHISPER", 4311 "OUTBOUND_WHISPER", 4312 "QUEUE_TRANSFER", 4313 ] 4314 ] 4315 ] = Field(default=None, alias="ContactFlowTypes") 4316 pagination_config: Optional[PaginatorConfigModel] = Field( 4317 default=None, alias="PaginationConfig" 4318 ) 4319 4320 4321class ListContactReferencesRequestListContactReferencesPaginateModel(BaseModel): 4322 instance_id: str = Field(alias="InstanceId") 4323 contact_id: str = Field(alias="ContactId") 4324 reference_types: Sequence[ 4325 Literal["ATTACHMENT", "DATE", "EMAIL", "NUMBER", "STRING", "URL"] 4326 ] = Field(alias="ReferenceTypes") 4327 pagination_config: Optional[PaginatorConfigModel] = Field( 4328 default=None, alias="PaginationConfig" 4329 ) 4330 4331 4332class ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateModel(BaseModel): 4333 instance_id: str = Field(alias="InstanceId") 4334 language_code: Optional[ 4335 Literal[ 4336 "ar-AE", 4337 "de-CH", 4338 "de-DE", 4339 "en-AB", 4340 "en-AU", 4341 "en-GB", 4342 "en-IE", 4343 "en-IN", 4344 "en-NZ", 4345 "en-US", 4346 "en-WL", 4347 "en-ZA", 4348 "es-ES", 4349 "es-US", 4350 "fr-CA", 4351 "fr-FR", 4352 "hi-IN", 4353 "it-IT", 4354 "ja-JP", 4355 "ko-KR", 4356 "pt-BR", 4357 "pt-PT", 4358 "zh-CN", 4359 ] 4360 ] = Field(default=None, alias="LanguageCode") 4361 pagination_config: Optional[PaginatorConfigModel] = Field( 4362 default=None, alias="PaginationConfig" 4363 ) 4364 4365 4366class ListHoursOfOperationsRequestListHoursOfOperationsPaginateModel(BaseModel): 4367 instance_id: str = Field(alias="InstanceId") 4368 pagination_config: Optional[PaginatorConfigModel] = Field( 4369 default=None, alias="PaginationConfig" 4370 ) 4371 4372 4373class ListInstanceAttributesRequestListInstanceAttributesPaginateModel(BaseModel): 4374 instance_id: str = Field(alias="InstanceId") 4375 pagination_config: Optional[PaginatorConfigModel] = Field( 4376 default=None, alias="PaginationConfig" 4377 ) 4378 4379 4380class ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateModel( 4381 BaseModel 4382): 4383 instance_id: str = Field(alias="InstanceId") 4384 resource_type: Literal[ 4385 "AGENT_EVENTS", 4386 "ATTACHMENTS", 4387 "CALL_RECORDINGS", 4388 "CHAT_TRANSCRIPTS", 4389 "CONTACT_EVALUATIONS", 4390 "CONTACT_TRACE_RECORDS", 4391 "MEDIA_STREAMS", 4392 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 4393 "SCHEDULED_REPORTS", 4394 ] = Field(alias="ResourceType") 4395 pagination_config: Optional[PaginatorConfigModel] = Field( 4396 default=None, alias="PaginationConfig" 4397 ) 4398 4399 4400class ListInstancesRequestListInstancesPaginateModel(BaseModel): 4401 pagination_config: Optional[PaginatorConfigModel] = Field( 4402 default=None, alias="PaginationConfig" 4403 ) 4404 4405 4406class ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateModel( 4407 BaseModel 4408): 4409 instance_id: str = Field(alias="InstanceId") 4410 integration_type: Optional[ 4411 Literal[ 4412 "CASES_DOMAIN", 4413 "EVENT", 4414 "PINPOINT_APP", 4415 "VOICE_ID", 4416 "WISDOM_ASSISTANT", 4417 "WISDOM_KNOWLEDGE_BASE", 4418 ] 4419 ] = Field(default=None, alias="IntegrationType") 4420 pagination_config: Optional[PaginatorConfigModel] = Field( 4421 default=None, alias="PaginationConfig" 4422 ) 4423 4424 4425class ListLambdaFunctionsRequestListLambdaFunctionsPaginateModel(BaseModel): 4426 instance_id: str = Field(alias="InstanceId") 4427 pagination_config: Optional[PaginatorConfigModel] = Field( 4428 default=None, alias="PaginationConfig" 4429 ) 4430 4431 4432class ListLexBotsRequestListLexBotsPaginateModel(BaseModel): 4433 instance_id: str = Field(alias="InstanceId") 4434 pagination_config: Optional[PaginatorConfigModel] = Field( 4435 default=None, alias="PaginationConfig" 4436 ) 4437 4438 4439class ListPhoneNumbersRequestListPhoneNumbersPaginateModel(BaseModel): 4440 instance_id: str = Field(alias="InstanceId") 4441 phone_number_types: Optional[Sequence[Literal["DID", "TOLL_FREE"]]] = Field( 4442 default=None, alias="PhoneNumberTypes" 4443 ) 4444 phone_number_country_codes: Optional[ 4445 Sequence[ 4446 Literal[ 4447 "AD", 4448 "AE", 4449 "AF", 4450 "AG", 4451 "AI", 4452 "AL", 4453 "AM", 4454 "AN", 4455 "AO", 4456 "AQ", 4457 "AR", 4458 "AS", 4459 "AT", 4460 "AU", 4461 "AW", 4462 "AZ", 4463 "BA", 4464 "BB", 4465 "BD", 4466 "BE", 4467 "BF", 4468 "BG", 4469 "BH", 4470 "BI", 4471 "BJ", 4472 "BL", 4473 "BM", 4474 "BN", 4475 "BO", 4476 "BR", 4477 "BS", 4478 "BT", 4479 "BW", 4480 "BY", 4481 "BZ", 4482 "CA", 4483 "CC", 4484 "CD", 4485 "CF", 4486 "CG", 4487 "CH", 4488 "CI", 4489 "CK", 4490 "CL", 4491 "CM", 4492 "CN", 4493 "CO", 4494 "CR", 4495 "CU", 4496 "CV", 4497 "CW", 4498 "CX", 4499 "CY", 4500 "CZ", 4501 "DE", 4502 "DJ", 4503 "DK", 4504 "DM", 4505 "DO", 4506 "DZ", 4507 "EC", 4508 "EE", 4509 "EG", 4510 "EH", 4511 "ER", 4512 "ES", 4513 "ET", 4514 "FI", 4515 "FJ", 4516 "FK", 4517 "FM", 4518 "FO", 4519 "FR", 4520 "GA", 4521 "GB", 4522 "GD", 4523 "GE", 4524 "GG", 4525 "GH", 4526 "GI", 4527 "GL", 4528 "GM", 4529 "GN", 4530 "GQ", 4531 "GR", 4532 "GT", 4533 "GU", 4534 "GW", 4535 "GY", 4536 "HK", 4537 "HN", 4538 "HR", 4539 "HT", 4540 "HU", 4541 "ID", 4542 "IE", 4543 "IL", 4544 "IM", 4545 "IN", 4546 "Type[IO]", 4547 "IQ", 4548 "IR", 4549 "IS", 4550 "IT", 4551 "JE", 4552 "JM", 4553 "JO", 4554 "JP", 4555 "KE", 4556 "KG", 4557 "KH", 4558 "KI", 4559 "KM", 4560 "KN", 4561 "KP", 4562 "KR", 4563 "KW", 4564 "KY", 4565 "KZ", 4566 "LA", 4567 "LB", 4568 "LC", 4569 "LI", 4570 "LK", 4571 "LR", 4572 "LS", 4573 "LT", 4574 "LU", 4575 "LV", 4576 "LY", 4577 "MA", 4578 "MC", 4579 "MD", 4580 "ME", 4581 "MF", 4582 "MG", 4583 "MH", 4584 "MK", 4585 "ML", 4586 "MM", 4587 "MN", 4588 "MO", 4589 "MP", 4590 "MR", 4591 "MS", 4592 "MT", 4593 "MU", 4594 "MV", 4595 "MW", 4596 "MX", 4597 "MY", 4598 "MZ", 4599 "NA", 4600 "NC", 4601 "NE", 4602 "NG", 4603 "NI", 4604 "NL", 4605 "NO", 4606 "NP", 4607 "NR", 4608 "NU", 4609 "NZ", 4610 "OM", 4611 "PA", 4612 "PE", 4613 "PF", 4614 "PG", 4615 "PH", 4616 "PK", 4617 "PL", 4618 "PM", 4619 "PN", 4620 "PR", 4621 "PT", 4622 "PW", 4623 "PY", 4624 "QA", 4625 "RE", 4626 "RO", 4627 "RS", 4628 "RU", 4629 "RW", 4630 "SA", 4631 "SB", 4632 "SC", 4633 "SD", 4634 "SE", 4635 "SG", 4636 "SH", 4637 "SI", 4638 "SJ", 4639 "SK", 4640 "SL", 4641 "SM", 4642 "SN", 4643 "SO", 4644 "SR", 4645 "ST", 4646 "SV", 4647 "SX", 4648 "SY", 4649 "SZ", 4650 "TC", 4651 "TD", 4652 "TG", 4653 "TH", 4654 "TJ", 4655 "TK", 4656 "TL", 4657 "TM", 4658 "TN", 4659 "TO", 4660 "TR", 4661 "TT", 4662 "TV", 4663 "TW", 4664 "TZ", 4665 "UA", 4666 "UG", 4667 "US", 4668 "UY", 4669 "UZ", 4670 "VA", 4671 "VC", 4672 "VE", 4673 "VG", 4674 "VI", 4675 "VN", 4676 "VU", 4677 "WF", 4678 "WS", 4679 "YE", 4680 "YT", 4681 "ZA", 4682 "ZM", 4683 "ZW", 4684 ] 4685 ] 4686 ] = Field(default=None, alias="PhoneNumberCountryCodes") 4687 pagination_config: Optional[PaginatorConfigModel] = Field( 4688 default=None, alias="PaginationConfig" 4689 ) 4690 4691 4692class ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateModel(BaseModel): 4693 target_arn: Optional[str] = Field(default=None, alias="TargetArn") 4694 phone_number_country_codes: Optional[ 4695 Sequence[ 4696 Literal[ 4697 "AD", 4698 "AE", 4699 "AF", 4700 "AG", 4701 "AI", 4702 "AL", 4703 "AM", 4704 "AN", 4705 "AO", 4706 "AQ", 4707 "AR", 4708 "AS", 4709 "AT", 4710 "AU", 4711 "AW", 4712 "AZ", 4713 "BA", 4714 "BB", 4715 "BD", 4716 "BE", 4717 "BF", 4718 "BG", 4719 "BH", 4720 "BI", 4721 "BJ", 4722 "BL", 4723 "BM", 4724 "BN", 4725 "BO", 4726 "BR", 4727 "BS", 4728 "BT", 4729 "BW", 4730 "BY", 4731 "BZ", 4732 "CA", 4733 "CC", 4734 "CD", 4735 "CF", 4736 "CG", 4737 "CH", 4738 "CI", 4739 "CK", 4740 "CL", 4741 "CM", 4742 "CN", 4743 "CO", 4744 "CR", 4745 "CU", 4746 "CV", 4747 "CW", 4748 "CX", 4749 "CY", 4750 "CZ", 4751 "DE", 4752 "DJ", 4753 "DK", 4754 "DM", 4755 "DO", 4756 "DZ", 4757 "EC", 4758 "EE", 4759 "EG", 4760 "EH", 4761 "ER", 4762 "ES", 4763 "ET", 4764 "FI", 4765 "FJ", 4766 "FK", 4767 "FM", 4768 "FO", 4769 "FR", 4770 "GA", 4771 "GB", 4772 "GD", 4773 "GE", 4774 "GG", 4775 "GH", 4776 "GI", 4777 "GL", 4778 "GM", 4779 "GN", 4780 "GQ", 4781 "GR", 4782 "GT", 4783 "GU", 4784 "GW", 4785 "GY", 4786 "HK", 4787 "HN", 4788 "HR", 4789 "HT", 4790 "HU", 4791 "ID", 4792 "IE", 4793 "IL", 4794 "IM", 4795 "IN", 4796 "Type[IO]", 4797 "IQ", 4798 "IR", 4799 "IS", 4800 "IT", 4801 "JE", 4802 "JM", 4803 "JO", 4804 "JP", 4805 "KE", 4806 "KG", 4807 "KH", 4808 "KI", 4809 "KM", 4810 "KN", 4811 "KP", 4812 "KR", 4813 "KW", 4814 "KY", 4815 "KZ", 4816 "LA", 4817 "LB", 4818 "LC", 4819 "LI", 4820 "LK", 4821 "LR", 4822 "LS", 4823 "LT", 4824 "LU", 4825 "LV", 4826 "LY", 4827 "MA", 4828 "MC", 4829 "MD", 4830 "ME", 4831 "MF", 4832 "MG", 4833 "MH", 4834 "MK", 4835 "ML", 4836 "MM", 4837 "MN", 4838 "MO", 4839 "MP", 4840 "MR", 4841 "MS", 4842 "MT", 4843 "MU", 4844 "MV", 4845 "MW", 4846 "MX", 4847 "MY", 4848 "MZ", 4849 "NA", 4850 "NC", 4851 "NE", 4852 "NG", 4853 "NI", 4854 "NL", 4855 "NO", 4856 "NP", 4857 "NR", 4858 "NU", 4859 "NZ", 4860 "OM", 4861 "PA", 4862 "PE", 4863 "PF", 4864 "PG", 4865 "PH", 4866 "PK", 4867 "PL", 4868 "PM", 4869 "PN", 4870 "PR", 4871 "PT", 4872 "PW", 4873 "PY", 4874 "QA", 4875 "RE", 4876 "RO", 4877 "RS", 4878 "RU", 4879 "RW", 4880 "SA", 4881 "SB", 4882 "SC", 4883 "SD", 4884 "SE", 4885 "SG", 4886 "SH", 4887 "SI", 4888 "SJ", 4889 "SK", 4890 "SL", 4891 "SM", 4892 "SN", 4893 "SO", 4894 "SR", 4895 "ST", 4896 "SV", 4897 "SX", 4898 "SY", 4899 "SZ", 4900 "TC", 4901 "TD", 4902 "TG", 4903 "TH", 4904 "TJ", 4905 "TK", 4906 "TL", 4907 "TM", 4908 "TN", 4909 "TO", 4910 "TR", 4911 "TT", 4912 "TV", 4913 "TW", 4914 "TZ", 4915 "UA", 4916 "UG", 4917 "US", 4918 "UY", 4919 "UZ", 4920 "VA", 4921 "VC", 4922 "VE", 4923 "VG", 4924 "VI", 4925 "VN", 4926 "VU", 4927 "WF", 4928 "WS", 4929 "YE", 4930 "YT", 4931 "ZA", 4932 "ZM", 4933 "ZW", 4934 ] 4935 ] 4936 ] = Field(default=None, alias="PhoneNumberCountryCodes") 4937 phone_number_types: Optional[Sequence[Literal["DID", "TOLL_FREE"]]] = Field( 4938 default=None, alias="PhoneNumberTypes" 4939 ) 4940 phone_number_prefix: Optional[str] = Field(default=None, alias="PhoneNumberPrefix") 4941 pagination_config: Optional[PaginatorConfigModel] = Field( 4942 default=None, alias="PaginationConfig" 4943 ) 4944 4945 4946class ListPromptsRequestListPromptsPaginateModel(BaseModel): 4947 instance_id: str = Field(alias="InstanceId") 4948 pagination_config: Optional[PaginatorConfigModel] = Field( 4949 default=None, alias="PaginationConfig" 4950 ) 4951 4952 4953class ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateModel(BaseModel): 4954 instance_id: str = Field(alias="InstanceId") 4955 queue_id: str = Field(alias="QueueId") 4956 pagination_config: Optional[PaginatorConfigModel] = Field( 4957 default=None, alias="PaginationConfig" 4958 ) 4959 4960 4961class ListQueuesRequestListQueuesPaginateModel(BaseModel): 4962 instance_id: str = Field(alias="InstanceId") 4963 queue_types: Optional[Sequence[Literal["AGENT", "STANDARD"]]] = Field( 4964 default=None, alias="QueueTypes" 4965 ) 4966 pagination_config: Optional[PaginatorConfigModel] = Field( 4967 default=None, alias="PaginationConfig" 4968 ) 4969 4970 4971class ListQuickConnectsRequestListQuickConnectsPaginateModel(BaseModel): 4972 instance_id: str = Field(alias="InstanceId") 4973 quick_connect_types: Optional[ 4974 Sequence[Literal["PHONE_NUMBER", "QUEUE", "USER"]] 4975 ] = Field(default=None, alias="QuickConnectTypes") 4976 pagination_config: Optional[PaginatorConfigModel] = Field( 4977 default=None, alias="PaginationConfig" 4978 ) 4979 4980 4981class ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateModel(BaseModel): 4982 instance_id: str = Field(alias="InstanceId") 4983 routing_profile_id: str = Field(alias="RoutingProfileId") 4984 pagination_config: Optional[PaginatorConfigModel] = Field( 4985 default=None, alias="PaginationConfig" 4986 ) 4987 4988 4989class ListRoutingProfilesRequestListRoutingProfilesPaginateModel(BaseModel): 4990 instance_id: str = Field(alias="InstanceId") 4991 pagination_config: Optional[PaginatorConfigModel] = Field( 4992 default=None, alias="PaginationConfig" 4993 ) 4994 4995 4996class ListRulesRequestListRulesPaginateModel(BaseModel): 4997 instance_id: str = Field(alias="InstanceId") 4998 publish_status: Optional[Literal["DRAFT", "PUBLISHED"]] = Field( 4999 default=None, alias="PublishStatus" 5000 ) 5001 event_source_name: Optional[ 5002 Literal[ 5003 "OnPostCallAnalysisAvailable", 5004 "OnPostChatAnalysisAvailable", 5005 "OnRealTimeCallAnalysisAvailable", 5006 "OnSalesforceCaseCreate", 5007 "OnZendeskTicketCreate", 5008 "OnZendeskTicketStatusUpdate", 5009 ] 5010 ] = Field(default=None, alias="EventSourceName") 5011 pagination_config: Optional[PaginatorConfigModel] = Field( 5012 default=None, alias="PaginationConfig" 5013 ) 5014 5015 5016class ListSecurityKeysRequestListSecurityKeysPaginateModel(BaseModel): 5017 instance_id: str = Field(alias="InstanceId") 5018 pagination_config: Optional[PaginatorConfigModel] = Field( 5019 default=None, alias="PaginationConfig" 5020 ) 5021 5022 5023class ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateModel( 5024 BaseModel 5025): 5026 security_profile_id: str = Field(alias="SecurityProfileId") 5027 instance_id: str = Field(alias="InstanceId") 5028 pagination_config: Optional[PaginatorConfigModel] = Field( 5029 default=None, alias="PaginationConfig" 5030 ) 5031 5032 5033class ListSecurityProfilesRequestListSecurityProfilesPaginateModel(BaseModel): 5034 instance_id: str = Field(alias="InstanceId") 5035 pagination_config: Optional[PaginatorConfigModel] = Field( 5036 default=None, alias="PaginationConfig" 5037 ) 5038 5039 5040class ListTaskTemplatesRequestListTaskTemplatesPaginateModel(BaseModel): 5041 instance_id: str = Field(alias="InstanceId") 5042 status: Optional[Literal["ACTIVE", "INACTIVE"]] = Field( 5043 default=None, alias="Status" 5044 ) 5045 name: Optional[str] = Field(default=None, alias="Name") 5046 pagination_config: Optional[PaginatorConfigModel] = Field( 5047 default=None, alias="PaginationConfig" 5048 ) 5049 5050 5051class ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateModel( 5052 BaseModel 5053): 5054 instance_id: Optional[str] = Field(default=None, alias="InstanceId") 5055 pagination_config: Optional[PaginatorConfigModel] = Field( 5056 default=None, alias="PaginationConfig" 5057 ) 5058 5059 5060class ListUseCasesRequestListUseCasesPaginateModel(BaseModel): 5061 instance_id: str = Field(alias="InstanceId") 5062 integration_association_id: str = Field(alias="IntegrationAssociationId") 5063 pagination_config: Optional[PaginatorConfigModel] = Field( 5064 default=None, alias="PaginationConfig" 5065 ) 5066 5067 5068class ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateModel(BaseModel): 5069 instance_id: str = Field(alias="InstanceId") 5070 pagination_config: Optional[PaginatorConfigModel] = Field( 5071 default=None, alias="PaginationConfig" 5072 ) 5073 5074 5075class ListUsersRequestListUsersPaginateModel(BaseModel): 5076 instance_id: str = Field(alias="InstanceId") 5077 pagination_config: Optional[PaginatorConfigModel] = Field( 5078 default=None, alias="PaginationConfig" 5079 ) 5080 5081 5082class SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateModel( 5083 BaseModel 5084): 5085 target_arn: str = Field(alias="TargetArn") 5086 phone_number_country_code: Literal[ 5087 "AD", 5088 "AE", 5089 "AF", 5090 "AG", 5091 "AI", 5092 "AL", 5093 "AM", 5094 "AN", 5095 "AO", 5096 "AQ", 5097 "AR", 5098 "AS", 5099 "AT", 5100 "AU", 5101 "AW", 5102 "AZ", 5103 "BA", 5104 "BB", 5105 "BD", 5106 "BE", 5107 "BF", 5108 "BG", 5109 "BH", 5110 "BI", 5111 "BJ", 5112 "BL", 5113 "BM", 5114 "BN", 5115 "BO", 5116 "BR", 5117 "BS", 5118 "BT", 5119 "BW", 5120 "BY", 5121 "BZ", 5122 "CA", 5123 "CC", 5124 "CD", 5125 "CF", 5126 "CG", 5127 "CH", 5128 "CI", 5129 "CK", 5130 "CL", 5131 "CM", 5132 "CN", 5133 "CO", 5134 "CR", 5135 "CU", 5136 "CV", 5137 "CW", 5138 "CX", 5139 "CY", 5140 "CZ", 5141 "DE", 5142 "DJ", 5143 "DK", 5144 "DM", 5145 "DO", 5146 "DZ", 5147 "EC", 5148 "EE", 5149 "EG", 5150 "EH", 5151 "ER", 5152 "ES", 5153 "ET", 5154 "FI", 5155 "FJ", 5156 "FK", 5157 "FM", 5158 "FO", 5159 "FR", 5160 "GA", 5161 "GB", 5162 "GD", 5163 "GE", 5164 "GG", 5165 "GH", 5166 "GI", 5167 "GL", 5168 "GM", 5169 "GN", 5170 "GQ", 5171 "GR", 5172 "GT", 5173 "GU", 5174 "GW", 5175 "GY", 5176 "HK", 5177 "HN", 5178 "HR", 5179 "HT", 5180 "HU", 5181 "ID", 5182 "IE", 5183 "IL", 5184 "IM", 5185 "IN", 5186 "Type[IO]", 5187 "IQ", 5188 "IR", 5189 "IS", 5190 "IT", 5191 "JE", 5192 "JM", 5193 "JO", 5194 "JP", 5195 "KE", 5196 "KG", 5197 "KH", 5198 "KI", 5199 "KM", 5200 "KN", 5201 "KP", 5202 "KR", 5203 "KW", 5204 "KY", 5205 "KZ", 5206 "LA", 5207 "LB", 5208 "LC", 5209 "LI", 5210 "LK", 5211 "LR", 5212 "LS", 5213 "LT", 5214 "LU", 5215 "LV", 5216 "LY", 5217 "MA", 5218 "MC", 5219 "MD", 5220 "ME", 5221 "MF", 5222 "MG", 5223 "MH", 5224 "MK", 5225 "ML", 5226 "MM", 5227 "MN", 5228 "MO", 5229 "MP", 5230 "MR", 5231 "MS", 5232 "MT", 5233 "MU", 5234 "MV", 5235 "MW", 5236 "MX", 5237 "MY", 5238 "MZ", 5239 "NA", 5240 "NC", 5241 "NE", 5242 "NG", 5243 "NI", 5244 "NL", 5245 "NO", 5246 "NP", 5247 "NR", 5248 "NU", 5249 "NZ", 5250 "OM", 5251 "PA", 5252 "PE", 5253 "PF", 5254 "PG", 5255 "PH", 5256 "PK", 5257 "PL", 5258 "PM", 5259 "PN", 5260 "PR", 5261 "PT", 5262 "PW", 5263 "PY", 5264 "QA", 5265 "RE", 5266 "RO", 5267 "RS", 5268 "RU", 5269 "RW", 5270 "SA", 5271 "SB", 5272 "SC", 5273 "SD", 5274 "SE", 5275 "SG", 5276 "SH", 5277 "SI", 5278 "SJ", 5279 "SK", 5280 "SL", 5281 "SM", 5282 "SN", 5283 "SO", 5284 "SR", 5285 "ST", 5286 "SV", 5287 "SX", 5288 "SY", 5289 "SZ", 5290 "TC", 5291 "TD", 5292 "TG", 5293 "TH", 5294 "TJ", 5295 "TK", 5296 "TL", 5297 "TM", 5298 "TN", 5299 "TO", 5300 "TR", 5301 "TT", 5302 "TV", 5303 "TW", 5304 "TZ", 5305 "UA", 5306 "UG", 5307 "US", 5308 "UY", 5309 "UZ", 5310 "VA", 5311 "VC", 5312 "VE", 5313 "VG", 5314 "VI", 5315 "VN", 5316 "VU", 5317 "WF", 5318 "WS", 5319 "YE", 5320 "YT", 5321 "ZA", 5322 "ZM", 5323 "ZW", 5324 ] = Field(alias="PhoneNumberCountryCode") 5325 phone_number_type: Literal["DID", "TOLL_FREE"] = Field(alias="PhoneNumberType") 5326 phone_number_prefix: Optional[str] = Field(default=None, alias="PhoneNumberPrefix") 5327 pagination_config: Optional[PaginatorConfigModel] = Field( 5328 default=None, alias="PaginationConfig" 5329 ) 5330 5331 5332class SearchVocabulariesRequestSearchVocabulariesPaginateModel(BaseModel): 5333 instance_id: str = Field(alias="InstanceId") 5334 state: Optional[ 5335 Literal[ 5336 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 5337 ] 5338 ] = Field(default=None, alias="State") 5339 name_starts_with: Optional[str] = Field(default=None, alias="NameStartsWith") 5340 language_code: Optional[ 5341 Literal[ 5342 "ar-AE", 5343 "de-CH", 5344 "de-DE", 5345 "en-AB", 5346 "en-AU", 5347 "en-GB", 5348 "en-IE", 5349 "en-IN", 5350 "en-NZ", 5351 "en-US", 5352 "en-WL", 5353 "en-ZA", 5354 "es-ES", 5355 "es-US", 5356 "fr-CA", 5357 "fr-FR", 5358 "hi-IN", 5359 "it-IT", 5360 "ja-JP", 5361 "ko-KR", 5362 "pt-BR", 5363 "pt-PT", 5364 "zh-CN", 5365 ] 5366 ] = Field(default=None, alias="LanguageCode") 5367 pagination_config: Optional[PaginatorConfigModel] = Field( 5368 default=None, alias="PaginationConfig" 5369 ) 5370 5371 5372class HierarchyPathReferenceModel(BaseModel): 5373 level_one: Optional[HierarchyGroupSummaryReferenceModel] = Field( 5374 default=None, alias="LevelOne" 5375 ) 5376 level_two: Optional[HierarchyGroupSummaryReferenceModel] = Field( 5377 default=None, alias="LevelTwo" 5378 ) 5379 level_three: Optional[HierarchyGroupSummaryReferenceModel] = Field( 5380 default=None, alias="LevelThree" 5381 ) 5382 level_four: Optional[HierarchyGroupSummaryReferenceModel] = Field( 5383 default=None, alias="LevelFour" 5384 ) 5385 level_five: Optional[HierarchyGroupSummaryReferenceModel] = Field( 5386 default=None, alias="LevelFive" 5387 ) 5388 5389 5390class HierarchyPathModel(BaseModel): 5391 level_one: Optional[HierarchyGroupSummaryModel] = Field( 5392 default=None, alias="LevelOne" 5393 ) 5394 level_two: Optional[HierarchyGroupSummaryModel] = Field( 5395 default=None, alias="LevelTwo" 5396 ) 5397 level_three: Optional[HierarchyGroupSummaryModel] = Field( 5398 default=None, alias="LevelThree" 5399 ) 5400 level_four: Optional[HierarchyGroupSummaryModel] = Field( 5401 default=None, alias="LevelFour" 5402 ) 5403 level_five: Optional[HierarchyGroupSummaryModel] = Field( 5404 default=None, alias="LevelFive" 5405 ) 5406 5407 5408class ListUserHierarchyGroupsResponseModel(BaseModel): 5409 user_hierarchy_group_summary_list: List[HierarchyGroupSummaryModel] = Field( 5410 alias="UserHierarchyGroupSummaryList" 5411 ) 5412 next_token: str = Field(alias="NextToken") 5413 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5414 5415 5416class HierarchyStructureModel(BaseModel): 5417 level_one: Optional[HierarchyLevelModel] = Field(default=None, alias="LevelOne") 5418 level_two: Optional[HierarchyLevelModel] = Field(default=None, alias="LevelTwo") 5419 level_three: Optional[HierarchyLevelModel] = Field(default=None, alias="LevelThree") 5420 level_four: Optional[HierarchyLevelModel] = Field(default=None, alias="LevelFour") 5421 level_five: Optional[HierarchyLevelModel] = Field(default=None, alias="LevelFive") 5422 5423 5424class HierarchyStructureUpdateModel(BaseModel): 5425 level_one: Optional[HierarchyLevelUpdateModel] = Field( 5426 default=None, alias="LevelOne" 5427 ) 5428 level_two: Optional[HierarchyLevelUpdateModel] = Field( 5429 default=None, alias="LevelTwo" 5430 ) 5431 level_three: Optional[HierarchyLevelUpdateModel] = Field( 5432 default=None, alias="LevelThree" 5433 ) 5434 level_four: Optional[HierarchyLevelUpdateModel] = Field( 5435 default=None, alias="LevelFour" 5436 ) 5437 level_five: Optional[HierarchyLevelUpdateModel] = Field( 5438 default=None, alias="LevelFive" 5439 ) 5440 5441 5442class HistoricalMetricModel(BaseModel): 5443 name: Optional[ 5444 Literal[ 5445 "ABANDON_TIME", 5446 "AFTER_CONTACT_WORK_TIME", 5447 "API_CONTACTS_HANDLED", 5448 "CALLBACK_CONTACTS_HANDLED", 5449 "CONTACTS_ABANDONED", 5450 "CONTACTS_AGENT_HUNG_UP_FIRST", 5451 "CONTACTS_CONSULTED", 5452 "CONTACTS_HANDLED", 5453 "CONTACTS_HANDLED_INCOMING", 5454 "CONTACTS_HANDLED_OUTBOUND", 5455 "CONTACTS_HOLD_ABANDONS", 5456 "CONTACTS_MISSED", 5457 "CONTACTS_QUEUED", 5458 "CONTACTS_TRANSFERRED_IN", 5459 "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", 5460 "CONTACTS_TRANSFERRED_OUT", 5461 "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", 5462 "HANDLE_TIME", 5463 "HOLD_TIME", 5464 "INTERACTION_AND_HOLD_TIME", 5465 "INTERACTION_TIME", 5466 "OCCUPANCY", 5467 "QUEUED_TIME", 5468 "QUEUE_ANSWER_TIME", 5469 "SERVICE_LEVEL", 5470 ] 5471 ] = Field(default=None, alias="Name") 5472 threshold: Optional[ThresholdModel] = Field(default=None, alias="Threshold") 5473 statistic: Optional[Literal["AVG", "MAX", "SUM"]] = Field( 5474 default=None, alias="Statistic" 5475 ) 5476 unit: Optional[Literal["COUNT", "PERCENT", "SECONDS"]] = Field( 5477 default=None, alias="Unit" 5478 ) 5479 5480 5481class HoursOfOperationConfigModel(BaseModel): 5482 day: Literal[ 5483 "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" 5484 ] = Field(alias="Day") 5485 start_time: HoursOfOperationTimeSliceModel = Field(alias="StartTime") 5486 end_time: HoursOfOperationTimeSliceModel = Field(alias="EndTime") 5487 5488 5489class ListHoursOfOperationsResponseModel(BaseModel): 5490 hours_of_operation_summary_list: List[HoursOfOperationSummaryModel] = Field( 5491 alias="HoursOfOperationSummaryList" 5492 ) 5493 next_token: str = Field(alias="NextToken") 5494 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5495 5496 5497class InstanceModel(BaseModel): 5498 id: Optional[str] = Field(default=None, alias="Id") 5499 arn: Optional[str] = Field(default=None, alias="Arn") 5500 identity_management_type: Optional[ 5501 Literal["CONNECT_MANAGED", "EXISTING_DIRECTORY", "SAML"] 5502 ] = Field(default=None, alias="IdentityManagementType") 5503 instance_alias: Optional[str] = Field(default=None, alias="InstanceAlias") 5504 created_time: Optional[datetime] = Field(default=None, alias="CreatedTime") 5505 service_role: Optional[str] = Field(default=None, alias="ServiceRole") 5506 instance_status: Optional[ 5507 Literal["ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS"] 5508 ] = Field(default=None, alias="InstanceStatus") 5509 status_reason: Optional[InstanceStatusReasonModel] = Field( 5510 default=None, alias="StatusReason" 5511 ) 5512 inbound_calls_enabled: Optional[bool] = Field( 5513 default=None, alias="InboundCallsEnabled" 5514 ) 5515 outbound_calls_enabled: Optional[bool] = Field( 5516 default=None, alias="OutboundCallsEnabled" 5517 ) 5518 5519 5520class ListInstancesResponseModel(BaseModel): 5521 instance_summary_list: List[InstanceSummaryModel] = Field( 5522 alias="InstanceSummaryList" 5523 ) 5524 next_token: str = Field(alias="NextToken") 5525 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5526 5527 5528class ListIntegrationAssociationsResponseModel(BaseModel): 5529 integration_association_summary_list: List[ 5530 IntegrationAssociationSummaryModel 5531 ] = Field(alias="IntegrationAssociationSummaryList") 5532 next_token: str = Field(alias="NextToken") 5533 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5534 5535 5536class InvisibleFieldInfoModel(BaseModel): 5537 id: Optional[TaskTemplateFieldIdentifierModel] = Field(default=None, alias="Id") 5538 5539 5540class ReadOnlyFieldInfoModel(BaseModel): 5541 id: Optional[TaskTemplateFieldIdentifierModel] = Field(default=None, alias="Id") 5542 5543 5544class RequiredFieldInfoModel(BaseModel): 5545 id: Optional[TaskTemplateFieldIdentifierModel] = Field(default=None, alias="Id") 5546 5547 5548class TaskTemplateDefaultFieldValueModel(BaseModel): 5549 id: Optional[TaskTemplateFieldIdentifierModel] = Field(default=None, alias="Id") 5550 default_value: Optional[str] = Field(default=None, alias="DefaultValue") 5551 5552 5553class TaskTemplateFieldModel(BaseModel): 5554 id: TaskTemplateFieldIdentifierModel = Field(alias="Id") 5555 description: Optional[str] = Field(default=None, alias="Description") 5556 type: Optional[ 5557 Literal[ 5558 "BOOLEAN", 5559 "DATE_TIME", 5560 "DESCRIPTION", 5561 "EMAIL", 5562 "NAME", 5563 "NUMBER", 5564 "QUICK_CONNECT", 5565 "SCHEDULED_TIME", 5566 "SINGLE_SELECT", 5567 "TEXT", 5568 "TEXT_AREA", 5569 "URL", 5570 ] 5571 ] = Field(default=None, alias="Type") 5572 single_select_options: Optional[Sequence[str]] = Field( 5573 default=None, alias="SingleSelectOptions" 5574 ) 5575 5576 5577class ListPhoneNumbersResponseModel(BaseModel): 5578 phone_number_summary_list: List[PhoneNumberSummaryModel] = Field( 5579 alias="PhoneNumberSummaryList" 5580 ) 5581 next_token: str = Field(alias="NextToken") 5582 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5583 5584 5585class ListPhoneNumbersV2ResponseModel(BaseModel): 5586 next_token: str = Field(alias="NextToken") 5587 list_phone_numbers_summary_list: List[ListPhoneNumbersSummaryModel] = Field( 5588 alias="ListPhoneNumbersSummaryList" 5589 ) 5590 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5591 5592 5593class ListPromptsResponseModel(BaseModel): 5594 prompt_summary_list: List[PromptSummaryModel] = Field(alias="PromptSummaryList") 5595 next_token: str = Field(alias="NextToken") 5596 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5597 5598 5599class ListQueueQuickConnectsResponseModel(BaseModel): 5600 next_token: str = Field(alias="NextToken") 5601 quick_connect_summary_list: List[QuickConnectSummaryModel] = Field( 5602 alias="QuickConnectSummaryList" 5603 ) 5604 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5605 5606 5607class ListQuickConnectsResponseModel(BaseModel): 5608 quick_connect_summary_list: List[QuickConnectSummaryModel] = Field( 5609 alias="QuickConnectSummaryList" 5610 ) 5611 next_token: str = Field(alias="NextToken") 5612 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5613 5614 5615class ListQueuesResponseModel(BaseModel): 5616 queue_summary_list: List[QueueSummaryModel] = Field(alias="QueueSummaryList") 5617 next_token: str = Field(alias="NextToken") 5618 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5619 5620 5621class ListRoutingProfileQueuesResponseModel(BaseModel): 5622 next_token: str = Field(alias="NextToken") 5623 routing_profile_queue_config_summary_list: List[ 5624 RoutingProfileQueueConfigSummaryModel 5625 ] = Field(alias="RoutingProfileQueueConfigSummaryList") 5626 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5627 5628 5629class ListRoutingProfilesResponseModel(BaseModel): 5630 routing_profile_summary_list: List[RoutingProfileSummaryModel] = Field( 5631 alias="RoutingProfileSummaryList" 5632 ) 5633 next_token: str = Field(alias="NextToken") 5634 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5635 5636 5637class ListSecurityKeysResponseModel(BaseModel): 5638 security_keys: List[SecurityKeyModel] = Field(alias="SecurityKeys") 5639 next_token: str = Field(alias="NextToken") 5640 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5641 5642 5643class ListSecurityProfilesResponseModel(BaseModel): 5644 security_profile_summary_list: List[SecurityProfileSummaryModel] = Field( 5645 alias="SecurityProfileSummaryList" 5646 ) 5647 next_token: str = Field(alias="NextToken") 5648 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5649 5650 5651class ListTaskTemplatesResponseModel(BaseModel): 5652 task_templates: List[TaskTemplateMetadataModel] = Field(alias="TaskTemplates") 5653 next_token: str = Field(alias="NextToken") 5654 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5655 5656 5657class ListTrafficDistributionGroupsResponseModel(BaseModel): 5658 next_token: str = Field(alias="NextToken") 5659 traffic_distribution_group_summary_list: List[ 5660 TrafficDistributionGroupSummaryModel 5661 ] = Field(alias="TrafficDistributionGroupSummaryList") 5662 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5663 5664 5665class ListUseCasesResponseModel(BaseModel): 5666 use_case_summary_list: List[UseCaseModel] = Field(alias="UseCaseSummaryList") 5667 next_token: str = Field(alias="NextToken") 5668 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5669 5670 5671class ListUsersResponseModel(BaseModel): 5672 user_summary_list: List[UserSummaryModel] = Field(alias="UserSummaryList") 5673 next_token: str = Field(alias="NextToken") 5674 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5675 5676 5677class SendNotificationActionDefinitionModel(BaseModel): 5678 delivery_method: Literal["EMAIL"] = Field(alias="DeliveryMethod") 5679 content: str = Field(alias="Content") 5680 content_type: Literal["PLAIN_TEXT"] = Field(alias="ContentType") 5681 recipient: NotificationRecipientTypeModel = Field(alias="Recipient") 5682 subject: Optional[str] = Field(default=None, alias="Subject") 5683 5684 5685class ParticipantTimerConfigurationModel(BaseModel): 5686 participant_role: Literal["AGENT", "CUSTOMER"] = Field(alias="ParticipantRole") 5687 timer_type: Literal["DISCONNECT_NONCUSTOMER", "IDLE"] = Field(alias="TimerType") 5688 timer_value: ParticipantTimerValueModel = Field(alias="TimerValue") 5689 5690 5691class StartChatContactRequestModel(BaseModel): 5692 instance_id: str = Field(alias="InstanceId") 5693 contact_flow_id: str = Field(alias="ContactFlowId") 5694 participant_details: ParticipantDetailsModel = Field(alias="ParticipantDetails") 5695 attributes: Optional[Mapping[str, str]] = Field(default=None, alias="Attributes") 5696 initial_message: Optional[ChatMessageModel] = Field( 5697 default=None, alias="InitialMessage" 5698 ) 5699 client_token: Optional[str] = Field(default=None, alias="ClientToken") 5700 chat_duration_in_minutes: Optional[int] = Field( 5701 default=None, alias="ChatDurationInMinutes" 5702 ) 5703 supported_messaging_content_types: Optional[Sequence[str]] = Field( 5704 default=None, alias="SupportedMessagingContentTypes" 5705 ) 5706 persistent_chat: Optional[PersistentChatModel] = Field( 5707 default=None, alias="PersistentChat" 5708 ) 5709 5710 5711class QueueSearchCriteriaModel(BaseModel): 5712 or_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5713 default=None, alias="OrConditions" 5714 ) 5715 and_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5716 default=None, alias="AndConditions" 5717 ) 5718 string_condition: Optional[StringConditionModel] = Field( 5719 default=None, alias="StringCondition" 5720 ) 5721 queue_type_condition: Optional[Literal["STANDARD"]] = Field( 5722 default=None, alias="QueueTypeCondition" 5723 ) 5724 5725 5726class RoutingProfileSearchCriteriaModel(BaseModel): 5727 or_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5728 default=None, alias="OrConditions" 5729 ) 5730 and_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5731 default=None, alias="AndConditions" 5732 ) 5733 string_condition: Optional[StringConditionModel] = Field( 5734 default=None, alias="StringCondition" 5735 ) 5736 5737 5738class SecurityProfileSearchCriteriaModel(BaseModel): 5739 or_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5740 default=None, alias="OrConditions" 5741 ) 5742 and_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5743 default=None, alias="AndConditions" 5744 ) 5745 string_condition: Optional[StringConditionModel] = Field( 5746 default=None, alias="StringCondition" 5747 ) 5748 5749 5750class UserSearchCriteriaModel(BaseModel): 5751 or_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5752 default=None, alias="OrConditions" 5753 ) 5754 and_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5755 default=None, alias="AndConditions" 5756 ) 5757 string_condition: Optional[StringConditionModel] = Field( 5758 default=None, alias="StringCondition" 5759 ) 5760 hierarchy_group_condition: Optional[HierarchyGroupConditionModel] = Field( 5761 default=None, alias="HierarchyGroupCondition" 5762 ) 5763 5764 5765class QuickConnectConfigModel(BaseModel): 5766 quick_connect_type: Literal["PHONE_NUMBER", "QUEUE", "USER"] = Field( 5767 alias="QuickConnectType" 5768 ) 5769 user_config: Optional[UserQuickConnectConfigModel] = Field( 5770 default=None, alias="UserConfig" 5771 ) 5772 queue_config: Optional[QueueQuickConnectConfigModel] = Field( 5773 default=None, alias="QueueConfig" 5774 ) 5775 phone_config: Optional[PhoneNumberQuickConnectConfigModel] = Field( 5776 default=None, alias="PhoneConfig" 5777 ) 5778 5779 5780class ReferenceSummaryModel(BaseModel): 5781 url: Optional[UrlReferenceModel] = Field(default=None, alias="Url") 5782 attachment: Optional[AttachmentReferenceModel] = Field( 5783 default=None, alias="Attachment" 5784 ) 5785 string: Optional[StringReferenceModel] = Field(default=None, alias="String") 5786 number: Optional[NumberReferenceModel] = Field(default=None, alias="Number") 5787 date: Optional[DateReferenceModel] = Field(default=None, alias="Date") 5788 email: Optional[EmailReferenceModel] = Field(default=None, alias="Email") 5789 5790 5791class StartTaskContactRequestModel(BaseModel): 5792 instance_id: str = Field(alias="InstanceId") 5793 name: str = Field(alias="Name") 5794 previous_contact_id: Optional[str] = Field(default=None, alias="PreviousContactId") 5795 contact_flow_id: Optional[str] = Field(default=None, alias="ContactFlowId") 5796 attributes: Optional[Mapping[str, str]] = Field(default=None, alias="Attributes") 5797 references: Optional[Mapping[str, ReferenceModel]] = Field( 5798 default=None, alias="References" 5799 ) 5800 description: Optional[str] = Field(default=None, alias="Description") 5801 client_token: Optional[str] = Field(default=None, alias="ClientToken") 5802 scheduled_time: Optional[Union[datetime, str]] = Field( 5803 default=None, alias="ScheduledTime" 5804 ) 5805 task_template_id: Optional[str] = Field(default=None, alias="TaskTemplateId") 5806 quick_connect_id: Optional[str] = Field(default=None, alias="QuickConnectId") 5807 related_contact_id: Optional[str] = Field(default=None, alias="RelatedContactId") 5808 5809 5810class TaskActionDefinitionModel(BaseModel): 5811 name: str = Field(alias="Name") 5812 contact_flow_id: str = Field(alias="ContactFlowId") 5813 description: Optional[str] = Field(default=None, alias="Description") 5814 references: Optional[Mapping[str, ReferenceModel]] = Field( 5815 default=None, alias="References" 5816 ) 5817 5818 5819class UpdateContactRequestModel(BaseModel): 5820 instance_id: str = Field(alias="InstanceId") 5821 contact_id: str = Field(alias="ContactId") 5822 name: Optional[str] = Field(default=None, alias="Name") 5823 description: Optional[str] = Field(default=None, alias="Description") 5824 references: Optional[Mapping[str, ReferenceModel]] = Field( 5825 default=None, alias="References" 5826 ) 5827 5828 5829class SearchSecurityProfilesResponseModel(BaseModel): 5830 security_profiles: List[SecurityProfileSearchSummaryModel] = Field( 5831 alias="SecurityProfiles" 5832 ) 5833 next_token: str = Field(alias="NextToken") 5834 approximate_total_count: int = Field(alias="ApproximateTotalCount") 5835 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5836 5837 5838class SearchVocabulariesResponseModel(BaseModel): 5839 vocabulary_summary_list: List[VocabularySummaryModel] = Field( 5840 alias="VocabularySummaryList" 5841 ) 5842 next_token: str = Field(alias="NextToken") 5843 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5844 5845 5846class StartContactRecordingRequestModel(BaseModel): 5847 instance_id: str = Field(alias="InstanceId") 5848 contact_id: str = Field(alias="ContactId") 5849 initial_contact_id: str = Field(alias="InitialContactId") 5850 voice_recording_configuration: VoiceRecordingConfigurationModel = Field( 5851 alias="VoiceRecordingConfiguration" 5852 ) 5853 5854 5855class UserSearchSummaryModel(BaseModel): 5856 arn: Optional[str] = Field(default=None, alias="Arn") 5857 directory_user_id: Optional[str] = Field(default=None, alias="DirectoryUserId") 5858 hierarchy_group_id: Optional[str] = Field(default=None, alias="HierarchyGroupId") 5859 id: Optional[str] = Field(default=None, alias="Id") 5860 identity_info: Optional[UserIdentityInfoLiteModel] = Field( 5861 default=None, alias="IdentityInfo" 5862 ) 5863 phone_config: Optional[UserPhoneConfigModel] = Field( 5864 default=None, alias="PhoneConfig" 5865 ) 5866 routing_profile_id: Optional[str] = Field(default=None, alias="RoutingProfileId") 5867 security_profile_ids: Optional[List[str]] = Field( 5868 default=None, alias="SecurityProfileIds" 5869 ) 5870 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 5871 username: Optional[str] = Field(default=None, alias="Username") 5872 5873 5874class ListRulesResponseModel(BaseModel): 5875 rule_summary_list: List[RuleSummaryModel] = Field(alias="RuleSummaryList") 5876 next_token: str = Field(alias="NextToken") 5877 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5878 5879 5880class ListBotsResponseModel(BaseModel): 5881 lex_bots: List[LexBotConfigModel] = Field(alias="LexBots") 5882 next_token: str = Field(alias="NextToken") 5883 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5884 5885 5886class DescribePhoneNumberResponseModel(BaseModel): 5887 claimed_phone_number_summary: ClaimedPhoneNumberSummaryModel = Field( 5888 alias="ClaimedPhoneNumberSummary" 5889 ) 5890 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5891 5892 5893class GetCurrentUserDataRequestModel(BaseModel): 5894 instance_id: str = Field(alias="InstanceId") 5895 filters: UserDataFiltersModel = Field(alias="Filters") 5896 next_token: Optional[str] = Field(default=None, alias="NextToken") 5897 max_results: Optional[int] = Field(default=None, alias="MaxResults") 5898 5899 5900class DescribeContactResponseModel(BaseModel): 5901 contact: ContactModel = Field(alias="Contact") 5902 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5903 5904 5905class QueueSearchFilterModel(BaseModel): 5906 tag_filter: Optional[ControlPlaneTagFilterModel] = Field( 5907 default=None, alias="TagFilter" 5908 ) 5909 5910 5911class RoutingProfileSearchFilterModel(BaseModel): 5912 tag_filter: Optional[ControlPlaneTagFilterModel] = Field( 5913 default=None, alias="TagFilter" 5914 ) 5915 5916 5917class SecurityProfilesSearchFilterModel(BaseModel): 5918 tag_filter: Optional[ControlPlaneTagFilterModel] = Field( 5919 default=None, alias="TagFilter" 5920 ) 5921 5922 5923class UserSearchFilterModel(BaseModel): 5924 tag_filter: Optional[ControlPlaneTagFilterModel] = Field( 5925 default=None, alias="TagFilter" 5926 ) 5927 5928 5929class DescribeQueueResponseModel(BaseModel): 5930 queue: QueueModel = Field(alias="Queue") 5931 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5932 5933 5934class SearchQueuesResponseModel(BaseModel): 5935 queues: List[QueueModel] = Field(alias="Queues") 5936 next_token: str = Field(alias="NextToken") 5937 approximate_total_count: int = Field(alias="ApproximateTotalCount") 5938 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5939 5940 5941class DescribeRoutingProfileResponseModel(BaseModel): 5942 routing_profile: RoutingProfileModel = Field(alias="RoutingProfile") 5943 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5944 5945 5946class SearchRoutingProfilesResponseModel(BaseModel): 5947 routing_profiles: List[RoutingProfileModel] = Field(alias="RoutingProfiles") 5948 next_token: str = Field(alias="NextToken") 5949 approximate_total_count: int = Field(alias="ApproximateTotalCount") 5950 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5951 5952 5953class DescribeUserResponseModel(BaseModel): 5954 user: UserModel = Field(alias="User") 5955 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 5956 5957 5958class CurrentMetricResultModel(BaseModel): 5959 dimensions: Optional[DimensionsModel] = Field(default=None, alias="Dimensions") 5960 collections: Optional[List[CurrentMetricDataModel]] = Field( 5961 default=None, alias="Collections" 5962 ) 5963 5964 5965class AssociateRoutingProfileQueuesRequestModel(BaseModel): 5966 instance_id: str = Field(alias="InstanceId") 5967 routing_profile_id: str = Field(alias="RoutingProfileId") 5968 queue_configs: Sequence[RoutingProfileQueueConfigModel] = Field( 5969 alias="QueueConfigs" 5970 ) 5971 5972 5973class CreateRoutingProfileRequestModel(BaseModel): 5974 instance_id: str = Field(alias="InstanceId") 5975 name: str = Field(alias="Name") 5976 description: str = Field(alias="Description") 5977 default_outbound_queue_id: str = Field(alias="DefaultOutboundQueueId") 5978 media_concurrencies: Sequence[MediaConcurrencyModel] = Field( 5979 alias="MediaConcurrencies" 5980 ) 5981 queue_configs: Optional[Sequence[RoutingProfileQueueConfigModel]] = Field( 5982 default=None, alias="QueueConfigs" 5983 ) 5984 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 5985 5986 5987class UpdateRoutingProfileQueuesRequestModel(BaseModel): 5988 instance_id: str = Field(alias="InstanceId") 5989 routing_profile_id: str = Field(alias="RoutingProfileId") 5990 queue_configs: Sequence[RoutingProfileQueueConfigModel] = Field( 5991 alias="QueueConfigs" 5992 ) 5993 5994 5995class GetTrafficDistributionResponseModel(BaseModel): 5996 telephony_config: TelephonyConfigModel = Field(alias="TelephonyConfig") 5997 id: str = Field(alias="Id") 5998 arn: str = Field(alias="Arn") 5999 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6000 6001 6002class UpdateTrafficDistributionRequestModel(BaseModel): 6003 id: str = Field(alias="Id") 6004 telephony_config: Optional[TelephonyConfigModel] = Field( 6005 default=None, alias="TelephonyConfig" 6006 ) 6007 6008 6009class InstanceStorageConfigModel(BaseModel): 6010 storage_type: Literal[ 6011 "KINESIS_FIREHOSE", "KINESIS_STREAM", "KINESIS_VIDEO_STREAM", "S3" 6012 ] = Field(alias="StorageType") 6013 association_id: Optional[str] = Field(default=None, alias="AssociationId") 6014 s3_config: Optional[S3ConfigModel] = Field(default=None, alias="S3Config") 6015 kinesis_video_stream_config: Optional[KinesisVideoStreamConfigModel] = Field( 6016 default=None, alias="KinesisVideoStreamConfig" 6017 ) 6018 kinesis_stream_config: Optional[KinesisStreamConfigModel] = Field( 6019 default=None, alias="KinesisStreamConfig" 6020 ) 6021 kinesis_firehose_config: Optional[KinesisFirehoseConfigModel] = Field( 6022 default=None, alias="KinesisFirehoseConfig" 6023 ) 6024 6025 6026class UserDataModel(BaseModel): 6027 user: Optional[UserReferenceModel] = Field(default=None, alias="User") 6028 routing_profile: Optional[RoutingProfileReferenceModel] = Field( 6029 default=None, alias="RoutingProfile" 6030 ) 6031 hierarchy_path: Optional[HierarchyPathReferenceModel] = Field( 6032 default=None, alias="HierarchyPath" 6033 ) 6034 status: Optional[AgentStatusReferenceModel] = Field(default=None, alias="Status") 6035 available_slots_by_channel: Optional[ 6036 Dict[Literal["CHAT", "TASK", "VOICE"], int] 6037 ] = Field(default=None, alias="AvailableSlotsByChannel") 6038 max_slots_by_channel: Optional[Dict[Literal["CHAT", "TASK", "VOICE"], int]] = Field( 6039 default=None, alias="MaxSlotsByChannel" 6040 ) 6041 active_slots_by_channel: Optional[ 6042 Dict[Literal["CHAT", "TASK", "VOICE"], int] 6043 ] = Field(default=None, alias="ActiveSlotsByChannel") 6044 contacts: Optional[List[AgentContactReferenceModel]] = Field( 6045 default=None, alias="Contacts" 6046 ) 6047 next_status: Optional[str] = Field(default=None, alias="NextStatus") 6048 6049 6050class HierarchyGroupModel(BaseModel): 6051 id: Optional[str] = Field(default=None, alias="Id") 6052 arn: Optional[str] = Field(default=None, alias="Arn") 6053 name: Optional[str] = Field(default=None, alias="Name") 6054 level_id: Optional[str] = Field(default=None, alias="LevelId") 6055 hierarchy_path: Optional[HierarchyPathModel] = Field( 6056 default=None, alias="HierarchyPath" 6057 ) 6058 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 6059 6060 6061class DescribeUserHierarchyStructureResponseModel(BaseModel): 6062 hierarchy_structure: HierarchyStructureModel = Field(alias="HierarchyStructure") 6063 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6064 6065 6066class UpdateUserHierarchyStructureRequestModel(BaseModel): 6067 hierarchy_structure: HierarchyStructureUpdateModel = Field( 6068 alias="HierarchyStructure" 6069 ) 6070 instance_id: str = Field(alias="InstanceId") 6071 6072 6073class GetMetricDataRequestGetMetricDataPaginateModel(BaseModel): 6074 instance_id: str = Field(alias="InstanceId") 6075 start_time: Union[datetime, str] = Field(alias="StartTime") 6076 end_time: Union[datetime, str] = Field(alias="EndTime") 6077 filters: FiltersModel = Field(alias="Filters") 6078 historical_metrics: Sequence[HistoricalMetricModel] = Field( 6079 alias="HistoricalMetrics" 6080 ) 6081 groupings: Optional[ 6082 Sequence[Literal["CHANNEL", "QUEUE", "ROUTING_PROFILE"]] 6083 ] = Field(default=None, alias="Groupings") 6084 pagination_config: Optional[PaginatorConfigModel] = Field( 6085 default=None, alias="PaginationConfig" 6086 ) 6087 6088 6089class GetMetricDataRequestModel(BaseModel): 6090 instance_id: str = Field(alias="InstanceId") 6091 start_time: Union[datetime, str] = Field(alias="StartTime") 6092 end_time: Union[datetime, str] = Field(alias="EndTime") 6093 filters: FiltersModel = Field(alias="Filters") 6094 historical_metrics: Sequence[HistoricalMetricModel] = Field( 6095 alias="HistoricalMetrics" 6096 ) 6097 groupings: Optional[ 6098 Sequence[Literal["CHANNEL", "QUEUE", "ROUTING_PROFILE"]] 6099 ] = Field(default=None, alias="Groupings") 6100 next_token: Optional[str] = Field(default=None, alias="NextToken") 6101 max_results: Optional[int] = Field(default=None, alias="MaxResults") 6102 6103 6104class HistoricalMetricDataModel(BaseModel): 6105 metric: Optional[HistoricalMetricModel] = Field(default=None, alias="Metric") 6106 value: Optional[float] = Field(default=None, alias="Value") 6107 6108 6109class CreateHoursOfOperationRequestModel(BaseModel): 6110 instance_id: str = Field(alias="InstanceId") 6111 name: str = Field(alias="Name") 6112 time_zone: str = Field(alias="TimeZone") 6113 config: Sequence[HoursOfOperationConfigModel] = Field(alias="Config") 6114 description: Optional[str] = Field(default=None, alias="Description") 6115 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 6116 6117 6118class HoursOfOperationModel(BaseModel): 6119 hours_of_operation_id: Optional[str] = Field( 6120 default=None, alias="HoursOfOperationId" 6121 ) 6122 hours_of_operation_arn: Optional[str] = Field( 6123 default=None, alias="HoursOfOperationArn" 6124 ) 6125 name: Optional[str] = Field(default=None, alias="Name") 6126 description: Optional[str] = Field(default=None, alias="Description") 6127 time_zone: Optional[str] = Field(default=None, alias="TimeZone") 6128 config: Optional[List[HoursOfOperationConfigModel]] = Field( 6129 default=None, alias="Config" 6130 ) 6131 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 6132 6133 6134class UpdateHoursOfOperationRequestModel(BaseModel): 6135 instance_id: str = Field(alias="InstanceId") 6136 hours_of_operation_id: str = Field(alias="HoursOfOperationId") 6137 name: Optional[str] = Field(default=None, alias="Name") 6138 description: Optional[str] = Field(default=None, alias="Description") 6139 time_zone: Optional[str] = Field(default=None, alias="TimeZone") 6140 config: Optional[Sequence[HoursOfOperationConfigModel]] = Field( 6141 default=None, alias="Config" 6142 ) 6143 6144 6145class DescribeInstanceResponseModel(BaseModel): 6146 instance: InstanceModel = Field(alias="Instance") 6147 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6148 6149 6150class TaskTemplateConstraintsModel(BaseModel): 6151 required_fields: Optional[Sequence[RequiredFieldInfoModel]] = Field( 6152 default=None, alias="RequiredFields" 6153 ) 6154 read_only_fields: Optional[Sequence[ReadOnlyFieldInfoModel]] = Field( 6155 default=None, alias="ReadOnlyFields" 6156 ) 6157 invisible_fields: Optional[Sequence[InvisibleFieldInfoModel]] = Field( 6158 default=None, alias="InvisibleFields" 6159 ) 6160 6161 6162class TaskTemplateDefaultsModel(BaseModel): 6163 default_field_values: Optional[ 6164 Sequence[TaskTemplateDefaultFieldValueModel] 6165 ] = Field(default=None, alias="DefaultFieldValues") 6166 6167 6168class ChatParticipantRoleConfigModel(BaseModel): 6169 participant_timer_config_list: Sequence[ParticipantTimerConfigurationModel] = Field( 6170 alias="ParticipantTimerConfigList" 6171 ) 6172 6173 6174class CreateQuickConnectRequestModel(BaseModel): 6175 instance_id: str = Field(alias="InstanceId") 6176 name: str = Field(alias="Name") 6177 quick_connect_config: QuickConnectConfigModel = Field(alias="QuickConnectConfig") 6178 description: Optional[str] = Field(default=None, alias="Description") 6179 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 6180 6181 6182class QuickConnectModel(BaseModel): 6183 quick_connect_arn: Optional[str] = Field(default=None, alias="QuickConnectARN") 6184 quick_connect_id: Optional[str] = Field(default=None, alias="QuickConnectId") 6185 name: Optional[str] = Field(default=None, alias="Name") 6186 description: Optional[str] = Field(default=None, alias="Description") 6187 quick_connect_config: Optional[QuickConnectConfigModel] = Field( 6188 default=None, alias="QuickConnectConfig" 6189 ) 6190 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 6191 6192 6193class UpdateQuickConnectConfigRequestModel(BaseModel): 6194 instance_id: str = Field(alias="InstanceId") 6195 quick_connect_id: str = Field(alias="QuickConnectId") 6196 quick_connect_config: QuickConnectConfigModel = Field(alias="QuickConnectConfig") 6197 6198 6199class ListContactReferencesResponseModel(BaseModel): 6200 reference_summary_list: List[ReferenceSummaryModel] = Field( 6201 alias="ReferenceSummaryList" 6202 ) 6203 next_token: str = Field(alias="NextToken") 6204 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6205 6206 6207class RuleActionModel(BaseModel): 6208 action_type: Literal[ 6209 "ASSIGN_CONTACT_CATEGORY", 6210 "CREATE_TASK", 6211 "GENERATE_EVENTBRIDGE_EVENT", 6212 "SEND_NOTIFICATION", 6213 ] = Field(alias="ActionType") 6214 task_action: Optional[TaskActionDefinitionModel] = Field( 6215 default=None, alias="TaskAction" 6216 ) 6217 event_bridge_action: Optional[EventBridgeActionDefinitionModel] = Field( 6218 default=None, alias="EventBridgeAction" 6219 ) 6220 assign_contact_category_action: Optional[Mapping[str, Any]] = Field( 6221 default=None, alias="AssignContactCategoryAction" 6222 ) 6223 send_notification_action: Optional[SendNotificationActionDefinitionModel] = Field( 6224 default=None, alias="SendNotificationAction" 6225 ) 6226 6227 6228class SearchUsersResponseModel(BaseModel): 6229 users: List[UserSearchSummaryModel] = Field(alias="Users") 6230 next_token: str = Field(alias="NextToken") 6231 approximate_total_count: int = Field(alias="ApproximateTotalCount") 6232 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6233 6234 6235class SearchQueuesRequestModel(BaseModel): 6236 instance_id: str = Field(alias="InstanceId") 6237 next_token: Optional[str] = Field(default=None, alias="NextToken") 6238 max_results: Optional[int] = Field(default=None, alias="MaxResults") 6239 search_filter: Optional[QueueSearchFilterModel] = Field( 6240 default=None, alias="SearchFilter" 6241 ) 6242 search_criteria: Optional[QueueSearchCriteriaModel] = Field( 6243 default=None, alias="SearchCriteria" 6244 ) 6245 6246 6247class SearchQueuesRequestSearchQueuesPaginateModel(BaseModel): 6248 instance_id: str = Field(alias="InstanceId") 6249 search_filter: Optional[QueueSearchFilterModel] = Field( 6250 default=None, alias="SearchFilter" 6251 ) 6252 search_criteria: Optional[QueueSearchCriteriaModel] = Field( 6253 default=None, alias="SearchCriteria" 6254 ) 6255 pagination_config: Optional[PaginatorConfigModel] = Field( 6256 default=None, alias="PaginationConfig" 6257 ) 6258 6259 6260class SearchRoutingProfilesRequestModel(BaseModel): 6261 instance_id: str = Field(alias="InstanceId") 6262 next_token: Optional[str] = Field(default=None, alias="NextToken") 6263 max_results: Optional[int] = Field(default=None, alias="MaxResults") 6264 search_filter: Optional[RoutingProfileSearchFilterModel] = Field( 6265 default=None, alias="SearchFilter" 6266 ) 6267 search_criteria: Optional[RoutingProfileSearchCriteriaModel] = Field( 6268 default=None, alias="SearchCriteria" 6269 ) 6270 6271 6272class SearchRoutingProfilesRequestSearchRoutingProfilesPaginateModel(BaseModel): 6273 instance_id: str = Field(alias="InstanceId") 6274 search_filter: Optional[RoutingProfileSearchFilterModel] = Field( 6275 default=None, alias="SearchFilter" 6276 ) 6277 search_criteria: Optional[RoutingProfileSearchCriteriaModel] = Field( 6278 default=None, alias="SearchCriteria" 6279 ) 6280 pagination_config: Optional[PaginatorConfigModel] = Field( 6281 default=None, alias="PaginationConfig" 6282 ) 6283 6284 6285class SearchSecurityProfilesRequestModel(BaseModel): 6286 instance_id: str = Field(alias="InstanceId") 6287 next_token: Optional[str] = Field(default=None, alias="NextToken") 6288 max_results: Optional[int] = Field(default=None, alias="MaxResults") 6289 search_criteria: Optional[SecurityProfileSearchCriteriaModel] = Field( 6290 default=None, alias="SearchCriteria" 6291 ) 6292 search_filter: Optional[SecurityProfilesSearchFilterModel] = Field( 6293 default=None, alias="SearchFilter" 6294 ) 6295 6296 6297class SearchSecurityProfilesRequestSearchSecurityProfilesPaginateModel(BaseModel): 6298 instance_id: str = Field(alias="InstanceId") 6299 search_criteria: Optional[SecurityProfileSearchCriteriaModel] = Field( 6300 default=None, alias="SearchCriteria" 6301 ) 6302 search_filter: Optional[SecurityProfilesSearchFilterModel] = Field( 6303 default=None, alias="SearchFilter" 6304 ) 6305 pagination_config: Optional[PaginatorConfigModel] = Field( 6306 default=None, alias="PaginationConfig" 6307 ) 6308 6309 6310class SearchUsersRequestModel(BaseModel): 6311 instance_id: Optional[str] = Field(default=None, alias="InstanceId") 6312 next_token: Optional[str] = Field(default=None, alias="NextToken") 6313 max_results: Optional[int] = Field(default=None, alias="MaxResults") 6314 search_filter: Optional[UserSearchFilterModel] = Field( 6315 default=None, alias="SearchFilter" 6316 ) 6317 search_criteria: Optional[UserSearchCriteriaModel] = Field( 6318 default=None, alias="SearchCriteria" 6319 ) 6320 6321 6322class SearchUsersRequestSearchUsersPaginateModel(BaseModel): 6323 instance_id: Optional[str] = Field(default=None, alias="InstanceId") 6324 search_filter: Optional[UserSearchFilterModel] = Field( 6325 default=None, alias="SearchFilter" 6326 ) 6327 search_criteria: Optional[UserSearchCriteriaModel] = Field( 6328 default=None, alias="SearchCriteria" 6329 ) 6330 pagination_config: Optional[PaginatorConfigModel] = Field( 6331 default=None, alias="PaginationConfig" 6332 ) 6333 6334 6335class GetCurrentMetricDataResponseModel(BaseModel): 6336 next_token: str = Field(alias="NextToken") 6337 metric_results: List[CurrentMetricResultModel] = Field(alias="MetricResults") 6338 data_snapshot_time: datetime = Field(alias="DataSnapshotTime") 6339 approximate_total_count: int = Field(alias="ApproximateTotalCount") 6340 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6341 6342 6343class AssociateInstanceStorageConfigRequestModel(BaseModel): 6344 instance_id: str = Field(alias="InstanceId") 6345 resource_type: Literal[ 6346 "AGENT_EVENTS", 6347 "ATTACHMENTS", 6348 "CALL_RECORDINGS", 6349 "CHAT_TRANSCRIPTS", 6350 "CONTACT_EVALUATIONS", 6351 "CONTACT_TRACE_RECORDS", 6352 "MEDIA_STREAMS", 6353 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 6354 "SCHEDULED_REPORTS", 6355 ] = Field(alias="ResourceType") 6356 storage_config: InstanceStorageConfigModel = Field(alias="StorageConfig") 6357 6358 6359class DescribeInstanceStorageConfigResponseModel(BaseModel): 6360 storage_config: InstanceStorageConfigModel = Field(alias="StorageConfig") 6361 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6362 6363 6364class ListInstanceStorageConfigsResponseModel(BaseModel): 6365 storage_configs: List[InstanceStorageConfigModel] = Field(alias="StorageConfigs") 6366 next_token: str = Field(alias="NextToken") 6367 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6368 6369 6370class UpdateInstanceStorageConfigRequestModel(BaseModel): 6371 instance_id: str = Field(alias="InstanceId") 6372 association_id: str = Field(alias="AssociationId") 6373 resource_type: Literal[ 6374 "AGENT_EVENTS", 6375 "ATTACHMENTS", 6376 "CALL_RECORDINGS", 6377 "CHAT_TRANSCRIPTS", 6378 "CONTACT_EVALUATIONS", 6379 "CONTACT_TRACE_RECORDS", 6380 "MEDIA_STREAMS", 6381 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 6382 "SCHEDULED_REPORTS", 6383 ] = Field(alias="ResourceType") 6384 storage_config: InstanceStorageConfigModel = Field(alias="StorageConfig") 6385 6386 6387class GetCurrentUserDataResponseModel(BaseModel): 6388 next_token: str = Field(alias="NextToken") 6389 user_data_list: List[UserDataModel] = Field(alias="UserDataList") 6390 approximate_total_count: int = Field(alias="ApproximateTotalCount") 6391 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6392 6393 6394class DescribeUserHierarchyGroupResponseModel(BaseModel): 6395 hierarchy_group: HierarchyGroupModel = Field(alias="HierarchyGroup") 6396 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6397 6398 6399class HistoricalMetricResultModel(BaseModel): 6400 dimensions: Optional[DimensionsModel] = Field(default=None, alias="Dimensions") 6401 collections: Optional[List[HistoricalMetricDataModel]] = Field( 6402 default=None, alias="Collections" 6403 ) 6404 6405 6406class DescribeHoursOfOperationResponseModel(BaseModel): 6407 hours_of_operation: HoursOfOperationModel = Field(alias="HoursOfOperation") 6408 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6409 6410 6411class CreateTaskTemplateRequestModel(BaseModel): 6412 instance_id: str = Field(alias="InstanceId") 6413 name: str = Field(alias="Name") 6414 fields: Sequence[TaskTemplateFieldModel] = Field(alias="Fields") 6415 description: Optional[str] = Field(default=None, alias="Description") 6416 contact_flow_id: Optional[str] = Field(default=None, alias="ContactFlowId") 6417 constraints: Optional[TaskTemplateConstraintsModel] = Field( 6418 default=None, alias="Constraints" 6419 ) 6420 defaults: Optional[TaskTemplateDefaultsModel] = Field( 6421 default=None, alias="Defaults" 6422 ) 6423 status: Optional[Literal["ACTIVE", "INACTIVE"]] = Field( 6424 default=None, alias="Status" 6425 ) 6426 client_token: Optional[str] = Field(default=None, alias="ClientToken") 6427 6428 6429class GetTaskTemplateResponseModel(BaseModel): 6430 instance_id: str = Field(alias="InstanceId") 6431 id: str = Field(alias="Id") 6432 arn: str = Field(alias="Arn") 6433 name: str = Field(alias="Name") 6434 description: str = Field(alias="Description") 6435 contact_flow_id: str = Field(alias="ContactFlowId") 6436 constraints: TaskTemplateConstraintsModel = Field(alias="Constraints") 6437 defaults: TaskTemplateDefaultsModel = Field(alias="Defaults") 6438 fields: List[TaskTemplateFieldModel] = Field(alias="Fields") 6439 status: Literal["ACTIVE", "INACTIVE"] = Field(alias="Status") 6440 last_modified_time: datetime = Field(alias="LastModifiedTime") 6441 created_time: datetime = Field(alias="CreatedTime") 6442 tags: Dict[str, str] = Field(alias="Tags") 6443 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6444 6445 6446class UpdateTaskTemplateRequestModel(BaseModel): 6447 task_template_id: str = Field(alias="TaskTemplateId") 6448 instance_id: str = Field(alias="InstanceId") 6449 name: Optional[str] = Field(default=None, alias="Name") 6450 description: Optional[str] = Field(default=None, alias="Description") 6451 contact_flow_id: Optional[str] = Field(default=None, alias="ContactFlowId") 6452 constraints: Optional[TaskTemplateConstraintsModel] = Field( 6453 default=None, alias="Constraints" 6454 ) 6455 defaults: Optional[TaskTemplateDefaultsModel] = Field( 6456 default=None, alias="Defaults" 6457 ) 6458 status: Optional[Literal["ACTIVE", "INACTIVE"]] = Field( 6459 default=None, alias="Status" 6460 ) 6461 fields: Optional[Sequence[TaskTemplateFieldModel]] = Field( 6462 default=None, alias="Fields" 6463 ) 6464 6465 6466class UpdateTaskTemplateResponseModel(BaseModel): 6467 instance_id: str = Field(alias="InstanceId") 6468 id: str = Field(alias="Id") 6469 arn: str = Field(alias="Arn") 6470 name: str = Field(alias="Name") 6471 description: str = Field(alias="Description") 6472 contact_flow_id: str = Field(alias="ContactFlowId") 6473 constraints: TaskTemplateConstraintsModel = Field(alias="Constraints") 6474 defaults: TaskTemplateDefaultsModel = Field(alias="Defaults") 6475 fields: List[TaskTemplateFieldModel] = Field(alias="Fields") 6476 status: Literal["ACTIVE", "INACTIVE"] = Field(alias="Status") 6477 last_modified_time: datetime = Field(alias="LastModifiedTime") 6478 created_time: datetime = Field(alias="CreatedTime") 6479 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6480 6481 6482class UpdateParticipantRoleConfigChannelInfoModel(BaseModel): 6483 chat: Optional[ChatParticipantRoleConfigModel] = Field(default=None, alias="Chat") 6484 6485 6486class DescribeQuickConnectResponseModel(BaseModel): 6487 quick_connect: QuickConnectModel = Field(alias="QuickConnect") 6488 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6489 6490 6491class CreateRuleRequestModel(BaseModel): 6492 instance_id: str = Field(alias="InstanceId") 6493 name: str = Field(alias="Name") 6494 trigger_event_source: RuleTriggerEventSourceModel = Field( 6495 alias="TriggerEventSource" 6496 ) 6497 function: str = Field(alias="Function") 6498 actions: Sequence[RuleActionModel] = Field(alias="Actions") 6499 publish_status: Literal["DRAFT", "PUBLISHED"] = Field(alias="PublishStatus") 6500 client_token: Optional[str] = Field(default=None, alias="ClientToken") 6501 6502 6503class RuleModel(BaseModel): 6504 name: str = Field(alias="Name") 6505 rule_id: str = Field(alias="RuleId") 6506 rule_arn: str = Field(alias="RuleArn") 6507 trigger_event_source: RuleTriggerEventSourceModel = Field( 6508 alias="TriggerEventSource" 6509 ) 6510 function: str = Field(alias="Function") 6511 actions: List[RuleActionModel] = Field(alias="Actions") 6512 publish_status: Literal["DRAFT", "PUBLISHED"] = Field(alias="PublishStatus") 6513 created_time: datetime = Field(alias="CreatedTime") 6514 last_updated_time: datetime = Field(alias="LastUpdatedTime") 6515 last_updated_by: str = Field(alias="LastUpdatedBy") 6516 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 6517 6518 6519class UpdateRuleRequestModel(BaseModel): 6520 rule_id: str = Field(alias="RuleId") 6521 instance_id: str = Field(alias="InstanceId") 6522 name: str = Field(alias="Name") 6523 function: str = Field(alias="Function") 6524 actions: Sequence[RuleActionModel] = Field(alias="Actions") 6525 publish_status: Literal["DRAFT", "PUBLISHED"] = Field(alias="PublishStatus") 6526 6527 6528class GetMetricDataResponseModel(BaseModel): 6529 next_token: str = Field(alias="NextToken") 6530 metric_results: List[HistoricalMetricResultModel] = Field(alias="MetricResults") 6531 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 6532 6533 6534class UpdateParticipantRoleConfigRequestModel(BaseModel): 6535 instance_id: str = Field(alias="InstanceId") 6536 contact_id: str = Field(alias="ContactId") 6537 channel_configuration: UpdateParticipantRoleConfigChannelInfoModel = Field( 6538 alias="ChannelConfiguration" 6539 ) 6540 6541 6542class DescribeRuleResponseModel(BaseModel): 6543 rule: RuleModel = Field(alias="Rule") 6544 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
14class ActionSummaryModel(BaseModel): 15 action_type: Literal[ 16 "ASSIGN_CONTACT_CATEGORY", 17 "CREATE_TASK", 18 "GENERATE_EVENTBRIDGE_EVENT", 19 "SEND_NOTIFICATION", 20 ] = Field(alias="ActionType")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
23class QueueReferenceModel(BaseModel): 24 id: Optional[str] = Field(default=None, alias="Id") 25 arn: Optional[str] = Field(default=None, alias="Arn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
28class AgentInfoModel(BaseModel): 29 id: Optional[str] = Field(default=None, alias="Id") 30 connected_to_agent_timestamp: Optional[datetime] = Field( 31 default=None, alias="ConnectedToAgentTimestamp" 32 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
35class AgentStatusReferenceModel(BaseModel): 36 status_start_timestamp: Optional[datetime] = Field( 37 default=None, alias="StatusStartTimestamp" 38 ) 39 status_arn: Optional[str] = Field(default=None, alias="StatusArn") 40 status_name: Optional[str] = Field(default=None, alias="StatusName")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
43class AgentStatusSummaryModel(BaseModel): 44 id: Optional[str] = Field(default=None, alias="Id") 45 arn: Optional[str] = Field(default=None, alias="Arn") 46 name: Optional[str] = Field(default=None, alias="Name") 47 type: Optional[Literal["CUSTOM", "OFFLINE", "ROUTABLE"]] = Field( 48 default=None, alias="Type" 49 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
52class AgentStatusModel(BaseModel): 53 agent_status_arn: Optional[str] = Field(default=None, alias="AgentStatusARN") 54 agent_status_id: Optional[str] = Field(default=None, alias="AgentStatusId") 55 name: Optional[str] = Field(default=None, alias="Name") 56 description: Optional[str] = Field(default=None, alias="Description") 57 type: Optional[Literal["CUSTOM", "OFFLINE", "ROUTABLE"]] = Field( 58 default=None, alias="Type" 59 ) 60 display_order: Optional[int] = Field(default=None, alias="DisplayOrder") 61 state: Optional[Literal["DISABLED", "ENABLED"]] = Field(default=None, alias="State") 62 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
65class AnswerMachineDetectionConfigModel(BaseModel): 66 enable_answer_machine_detection: Optional[bool] = Field( 67 default=None, alias="EnableAnswerMachineDetection" 68 ) 69 await_answer_machine_prompt: Optional[bool] = Field( 70 default=None, alias="AwaitAnswerMachinePrompt" 71 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
74class AssociateApprovedOriginRequestModel(BaseModel): 75 instance_id: str = Field(alias="InstanceId") 76 origin: str = Field(alias="Origin")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
79class LexBotModel(BaseModel): 80 name: str = Field(alias="Name") 81 lex_region: str = Field(alias="LexRegion")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
84class LexV2BotModel(BaseModel): 85 alias_arn: Optional[str] = Field(default=None, alias="AliasArn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
88class AssociateDefaultVocabularyRequestModel(BaseModel): 89 instance_id: str = Field(alias="InstanceId") 90 language_code: Literal[ 91 "ar-AE", 92 "de-CH", 93 "de-DE", 94 "en-AB", 95 "en-AU", 96 "en-GB", 97 "en-IE", 98 "en-IN", 99 "en-NZ", 100 "en-US", 101 "en-WL", 102 "en-ZA", 103 "es-ES", 104 "es-US", 105 "fr-CA", 106 "fr-FR", 107 "hi-IN", 108 "it-IT", 109 "ja-JP", 110 "ko-KR", 111 "pt-BR", 112 "pt-PT", 113 "zh-CN", 114 ] = Field(alias="LanguageCode") 115 vocabulary_id: Optional[str] = Field(default=None, alias="VocabularyId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
118class ResponseMetadataModel(BaseModel): 119 request_id: str = Field(alias="RequestId") 120 host_id: str = Field(alias="HostId") 121 http_status_code: int = Field(alias="HTTPStatusCode") 122 http_headers: Dict[str, str] = Field(alias="HTTPHeaders") 123 retry_attempts: int = Field(alias="RetryAttempts")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
126class AssociateLambdaFunctionRequestModel(BaseModel): 127 instance_id: str = Field(alias="InstanceId") 128 function_arn: str = Field(alias="FunctionArn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
131class AssociatePhoneNumberContactFlowRequestModel(BaseModel): 132 phone_number_id: str = Field(alias="PhoneNumberId") 133 instance_id: str = Field(alias="InstanceId") 134 contact_flow_id: str = Field(alias="ContactFlowId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
137class AssociateQueueQuickConnectsRequestModel(BaseModel): 138 instance_id: str = Field(alias="InstanceId") 139 queue_id: str = Field(alias="QueueId") 140 quick_connect_ids: Sequence[str] = Field(alias="QuickConnectIds")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
143class AssociateSecurityKeyRequestModel(BaseModel): 144 instance_id: str = Field(alias="InstanceId") 145 key: str = Field(alias="Key")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
148class AttachmentReferenceModel(BaseModel): 149 name: Optional[str] = Field(default=None, alias="Name") 150 value: Optional[str] = Field(default=None, alias="Value") 151 status: Optional[Literal["APPROVED", "REJECTED"]] = Field( 152 default=None, alias="Status" 153 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
156class AttributeModel(BaseModel): 157 attribute_type: Optional[ 158 Literal[ 159 "AUTO_RESOLVE_BEST_VOICES", 160 "CONTACTFLOW_LOGS", 161 "CONTACT_LENS", 162 "EARLY_MEDIA", 163 "ENHANCED_CONTACT_MONITORING", 164 "HIGH_VOLUME_OUTBOUND", 165 "INBOUND_CALLS", 166 "MULTI_PARTY_CONFERENCE", 167 "OUTBOUND_CALLS", 168 "USE_CUSTOM_TTS_VOICES", 169 ] 170 ] = Field(default=None, alias="AttributeType") 171 value: Optional[str] = Field(default=None, alias="Value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
174class AvailableNumberSummaryModel(BaseModel): 175 phone_number: Optional[str] = Field(default=None, alias="PhoneNumber") 176 phone_number_country_code: Optional[ 177 Literal[ 178 "AD", 179 "AE", 180 "AF", 181 "AG", 182 "AI", 183 "AL", 184 "AM", 185 "AN", 186 "AO", 187 "AQ", 188 "AR", 189 "AS", 190 "AT", 191 "AU", 192 "AW", 193 "AZ", 194 "BA", 195 "BB", 196 "BD", 197 "BE", 198 "BF", 199 "BG", 200 "BH", 201 "BI", 202 "BJ", 203 "BL", 204 "BM", 205 "BN", 206 "BO", 207 "BR", 208 "BS", 209 "BT", 210 "BW", 211 "BY", 212 "BZ", 213 "CA", 214 "CC", 215 "CD", 216 "CF", 217 "CG", 218 "CH", 219 "CI", 220 "CK", 221 "CL", 222 "CM", 223 "CN", 224 "CO", 225 "CR", 226 "CU", 227 "CV", 228 "CW", 229 "CX", 230 "CY", 231 "CZ", 232 "DE", 233 "DJ", 234 "DK", 235 "DM", 236 "DO", 237 "DZ", 238 "EC", 239 "EE", 240 "EG", 241 "EH", 242 "ER", 243 "ES", 244 "ET", 245 "FI", 246 "FJ", 247 "FK", 248 "FM", 249 "FO", 250 "FR", 251 "GA", 252 "GB", 253 "GD", 254 "GE", 255 "GG", 256 "GH", 257 "GI", 258 "GL", 259 "GM", 260 "GN", 261 "GQ", 262 "GR", 263 "GT", 264 "GU", 265 "GW", 266 "GY", 267 "HK", 268 "HN", 269 "HR", 270 "HT", 271 "HU", 272 "ID", 273 "IE", 274 "IL", 275 "IM", 276 "IN", 277 "Type[IO]", 278 "IQ", 279 "IR", 280 "IS", 281 "IT", 282 "JE", 283 "JM", 284 "JO", 285 "JP", 286 "KE", 287 "KG", 288 "KH", 289 "KI", 290 "KM", 291 "KN", 292 "KP", 293 "KR", 294 "KW", 295 "KY", 296 "KZ", 297 "LA", 298 "LB", 299 "LC", 300 "LI", 301 "LK", 302 "LR", 303 "LS", 304 "LT", 305 "LU", 306 "LV", 307 "LY", 308 "MA", 309 "MC", 310 "MD", 311 "ME", 312 "MF", 313 "MG", 314 "MH", 315 "MK", 316 "ML", 317 "MM", 318 "MN", 319 "MO", 320 "MP", 321 "MR", 322 "MS", 323 "MT", 324 "MU", 325 "MV", 326 "MW", 327 "MX", 328 "MY", 329 "MZ", 330 "NA", 331 "NC", 332 "NE", 333 "NG", 334 "NI", 335 "NL", 336 "NO", 337 "NP", 338 "NR", 339 "NU", 340 "NZ", 341 "OM", 342 "PA", 343 "PE", 344 "PF", 345 "PG", 346 "PH", 347 "PK", 348 "PL", 349 "PM", 350 "PN", 351 "PR", 352 "PT", 353 "PW", 354 "PY", 355 "QA", 356 "RE", 357 "RO", 358 "RS", 359 "RU", 360 "RW", 361 "SA", 362 "SB", 363 "SC", 364 "SD", 365 "SE", 366 "SG", 367 "SH", 368 "SI", 369 "SJ", 370 "SK", 371 "SL", 372 "SM", 373 "SN", 374 "SO", 375 "SR", 376 "ST", 377 "SV", 378 "SX", 379 "SY", 380 "SZ", 381 "TC", 382 "TD", 383 "TG", 384 "TH", 385 "TJ", 386 "TK", 387 "TL", 388 "TM", 389 "TN", 390 "TO", 391 "TR", 392 "TT", 393 "TV", 394 "TW", 395 "TZ", 396 "UA", 397 "UG", 398 "US", 399 "UY", 400 "UZ", 401 "VA", 402 "VC", 403 "VE", 404 "VG", 405 "VI", 406 "VN", 407 "VU", 408 "WF", 409 "WS", 410 "YE", 411 "YT", 412 "ZA", 413 "ZM", 414 "ZW", 415 ] 416 ] = Field(default=None, alias="PhoneNumberCountryCode") 417 phone_number_type: Optional[Literal["DID", "TOLL_FREE"]] = Field( 418 default=None, alias="PhoneNumberType" 419 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
422class ChatMessageModel(BaseModel): 423 content_type: str = Field(alias="ContentType") 424 content: str = Field(alias="Content")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
427class ChatStreamingConfigurationModel(BaseModel): 428 streaming_endpoint_arn: str = Field(alias="StreamingEndpointArn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
431class ClaimPhoneNumberRequestModel(BaseModel): 432 target_arn: str = Field(alias="TargetArn") 433 phone_number: str = Field(alias="PhoneNumber") 434 phone_number_description: Optional[str] = Field( 435 default=None, alias="PhoneNumberDescription" 436 ) 437 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 438 client_token: Optional[str] = Field(default=None, alias="ClientToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
441class PhoneNumberStatusModel(BaseModel): 442 status: Optional[Literal["CLAIMED", "FAILED", "IN_PROGRESS"]] = Field( 443 default=None, alias="Status" 444 ) 445 message: Optional[str] = Field(default=None, alias="Message")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
448class ContactFilterModel(BaseModel): 449 contact_states: Optional[ 450 Sequence[ 451 Literal[ 452 "CONNECTED", 453 "CONNECTED_ONHOLD", 454 "CONNECTING", 455 "ENDED", 456 "ERROR", 457 "INCOMING", 458 "MISSED", 459 "PENDING", 460 "REJECTED", 461 ] 462 ] 463 ] = Field(default=None, alias="ContactStates")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
466class ContactFlowModuleSummaryModel(BaseModel): 467 id: Optional[str] = Field(default=None, alias="Id") 468 arn: Optional[str] = Field(default=None, alias="Arn") 469 name: Optional[str] = Field(default=None, alias="Name") 470 state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field(default=None, alias="State")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
473class ContactFlowModuleModel(BaseModel): 474 arn: Optional[str] = Field(default=None, alias="Arn") 475 id: Optional[str] = Field(default=None, alias="Id") 476 name: Optional[str] = Field(default=None, alias="Name") 477 content: Optional[str] = Field(default=None, alias="Content") 478 description: Optional[str] = Field(default=None, alias="Description") 479 state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field(default=None, alias="State") 480 status: Optional[Literal["PUBLISHED", "SAVED"]] = Field( 481 default=None, alias="Status" 482 ) 483 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
486class ContactFlowSummaryModel(BaseModel): 487 id: Optional[str] = Field(default=None, alias="Id") 488 arn: Optional[str] = Field(default=None, alias="Arn") 489 name: Optional[str] = Field(default=None, alias="Name") 490 contact_flow_type: Optional[ 491 Literal[ 492 "AGENT_HOLD", 493 "AGENT_TRANSFER", 494 "AGENT_WHISPER", 495 "CONTACT_FLOW", 496 "CUSTOMER_HOLD", 497 "CUSTOMER_QUEUE", 498 "CUSTOMER_WHISPER", 499 "OUTBOUND_WHISPER", 500 "QUEUE_TRANSFER", 501 ] 502 ] = Field(default=None, alias="ContactFlowType") 503 contact_flow_state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field( 504 default=None, alias="ContactFlowState" 505 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
508class ContactFlowModel(BaseModel): 509 arn: Optional[str] = Field(default=None, alias="Arn") 510 id: Optional[str] = Field(default=None, alias="Id") 511 name: Optional[str] = Field(default=None, alias="Name") 512 type: Optional[ 513 Literal[ 514 "AGENT_HOLD", 515 "AGENT_TRANSFER", 516 "AGENT_WHISPER", 517 "CONTACT_FLOW", 518 "CUSTOMER_HOLD", 519 "CUSTOMER_QUEUE", 520 "CUSTOMER_WHISPER", 521 "OUTBOUND_WHISPER", 522 "QUEUE_TRANSFER", 523 ] 524 ] = Field(default=None, alias="Type") 525 state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field(default=None, alias="State") 526 description: Optional[str] = Field(default=None, alias="Description") 527 content: Optional[str] = Field(default=None, alias="Content") 528 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
531class QueueInfoModel(BaseModel): 532 id: Optional[str] = Field(default=None, alias="Id") 533 enqueue_timestamp: Optional[datetime] = Field( 534 default=None, alias="EnqueueTimestamp" 535 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
538class WisdomInfoModel(BaseModel): 539 session_arn: Optional[str] = Field(default=None, alias="SessionArn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
542class TagConditionModel(BaseModel): 543 tag_key: Optional[str] = Field(default=None, alias="TagKey") 544 tag_value: Optional[str] = Field(default=None, alias="TagValue")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
547class CreateAgentStatusRequestModel(BaseModel): 548 instance_id: str = Field(alias="InstanceId") 549 name: str = Field(alias="Name") 550 state: Literal["DISABLED", "ENABLED"] = Field(alias="State") 551 description: Optional[str] = Field(default=None, alias="Description") 552 display_order: Optional[int] = Field(default=None, alias="DisplayOrder") 553 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
556class CreateContactFlowModuleRequestModel(BaseModel): 557 instance_id: str = Field(alias="InstanceId") 558 name: str = Field(alias="Name") 559 content: str = Field(alias="Content") 560 description: Optional[str] = Field(default=None, alias="Description") 561 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 562 client_token: Optional[str] = Field(default=None, alias="ClientToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
565class CreateContactFlowRequestModel(BaseModel): 566 instance_id: str = Field(alias="InstanceId") 567 name: str = Field(alias="Name") 568 type: Literal[ 569 "AGENT_HOLD", 570 "AGENT_TRANSFER", 571 "AGENT_WHISPER", 572 "CONTACT_FLOW", 573 "CUSTOMER_HOLD", 574 "CUSTOMER_QUEUE", 575 "CUSTOMER_WHISPER", 576 "OUTBOUND_WHISPER", 577 "QUEUE_TRANSFER", 578 ] = Field(alias="Type") 579 content: str = Field(alias="Content") 580 description: Optional[str] = Field(default=None, alias="Description") 581 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
584class CreateInstanceRequestModel(BaseModel): 585 identity_management_type: Literal[ 586 "CONNECT_MANAGED", "EXISTING_DIRECTORY", "SAML" 587 ] = Field(alias="IdentityManagementType") 588 inbound_calls_enabled: bool = Field(alias="InboundCallsEnabled") 589 outbound_calls_enabled: bool = Field(alias="OutboundCallsEnabled") 590 client_token: Optional[str] = Field(default=None, alias="ClientToken") 591 instance_alias: Optional[str] = Field(default=None, alias="InstanceAlias") 592 directory_id: Optional[str] = Field(default=None, alias="DirectoryId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
595class CreateIntegrationAssociationRequestModel(BaseModel): 596 instance_id: str = Field(alias="InstanceId") 597 integration_type: Literal[ 598 "CASES_DOMAIN", 599 "EVENT", 600 "PINPOINT_APP", 601 "VOICE_ID", 602 "WISDOM_ASSISTANT", 603 "WISDOM_KNOWLEDGE_BASE", 604 ] = Field(alias="IntegrationType") 605 integration_arn: str = Field(alias="IntegrationArn") 606 source_application_url: Optional[str] = Field( 607 default=None, alias="SourceApplicationUrl" 608 ) 609 source_application_name: Optional[str] = Field( 610 default=None, alias="SourceApplicationName" 611 ) 612 source_type: Optional[Literal["SALESFORCE", "ZENDESK"]] = Field( 613 default=None, alias="SourceType" 614 ) 615 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
618class OutboundCallerConfigModel(BaseModel): 619 outbound_caller_id_name: Optional[str] = Field( 620 default=None, alias="OutboundCallerIdName" 621 ) 622 outbound_caller_id_number_id: Optional[str] = Field( 623 default=None, alias="OutboundCallerIdNumberId" 624 ) 625 outbound_flow_id: Optional[str] = Field(default=None, alias="OutboundFlowId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
628class MediaConcurrencyModel(BaseModel): 629 channel: Literal["CHAT", "TASK", "VOICE"] = Field(alias="Channel") 630 concurrency: int = Field(alias="Concurrency")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
633class RuleTriggerEventSourceModel(BaseModel): 634 event_source_name: Literal[ 635 "OnPostCallAnalysisAvailable", 636 "OnPostChatAnalysisAvailable", 637 "OnRealTimeCallAnalysisAvailable", 638 "OnSalesforceCaseCreate", 639 "OnZendeskTicketCreate", 640 "OnZendeskTicketStatusUpdate", 641 ] = Field(alias="EventSourceName") 642 integration_association_id: Optional[str] = Field( 643 default=None, alias="IntegrationAssociationId" 644 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
647class CreateSecurityProfileRequestModel(BaseModel): 648 security_profile_name: str = Field(alias="SecurityProfileName") 649 instance_id: str = Field(alias="InstanceId") 650 description: Optional[str] = Field(default=None, alias="Description") 651 permissions: Optional[Sequence[str]] = Field(default=None, alias="Permissions") 652 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags") 653 allowed_access_control_tags: Optional[Mapping[str, str]] = Field( 654 default=None, alias="AllowedAccessControlTags" 655 ) 656 tag_restricted_resources: Optional[Sequence[str]] = Field( 657 default=None, alias="TagRestrictedResources" 658 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
661class CreateTrafficDistributionGroupRequestModel(BaseModel): 662 name: str = Field(alias="Name") 663 instance_id: str = Field(alias="InstanceId") 664 description: Optional[str] = Field(default=None, alias="Description") 665 client_token: Optional[str] = Field(default=None, alias="ClientToken") 666 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
669class CreateUseCaseRequestModel(BaseModel): 670 instance_id: str = Field(alias="InstanceId") 671 integration_association_id: str = Field(alias="IntegrationAssociationId") 672 use_case_type: Literal["CONNECT_CAMPAIGNS", "RULES_EVALUATION"] = Field( 673 alias="UseCaseType" 674 ) 675 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
678class CreateUserHierarchyGroupRequestModel(BaseModel): 679 name: str = Field(alias="Name") 680 instance_id: str = Field(alias="InstanceId") 681 parent_group_id: Optional[str] = Field(default=None, alias="ParentGroupId") 682 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
685class UserIdentityInfoModel(BaseModel): 686 first_name: Optional[str] = Field(default=None, alias="FirstName") 687 last_name: Optional[str] = Field(default=None, alias="LastName") 688 email: Optional[str] = Field(default=None, alias="Email") 689 secondary_email: Optional[str] = Field(default=None, alias="SecondaryEmail") 690 mobile: Optional[str] = Field(default=None, alias="Mobile")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
693class UserPhoneConfigModel(BaseModel): 694 phone_type: Literal["DESK_PHONE", "SOFT_PHONE"] = Field(alias="PhoneType") 695 auto_accept: Optional[bool] = Field(default=None, alias="AutoAccept") 696 after_contact_work_time_limit: Optional[int] = Field( 697 default=None, alias="AfterContactWorkTimeLimit" 698 ) 699 desk_phone_number: Optional[str] = Field(default=None, alias="DeskPhoneNumber")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
702class CreateVocabularyRequestModel(BaseModel): 703 instance_id: str = Field(alias="InstanceId") 704 vocabulary_name: str = Field(alias="VocabularyName") 705 language_code: Literal[ 706 "ar-AE", 707 "de-CH", 708 "de-DE", 709 "en-AB", 710 "en-AU", 711 "en-GB", 712 "en-IE", 713 "en-IN", 714 "en-NZ", 715 "en-US", 716 "en-WL", 717 "en-ZA", 718 "es-ES", 719 "es-US", 720 "fr-CA", 721 "fr-FR", 722 "hi-IN", 723 "it-IT", 724 "ja-JP", 725 "ko-KR", 726 "pt-BR", 727 "pt-PT", 728 "zh-CN", 729 ] = Field(alias="LanguageCode") 730 content: str = Field(alias="Content") 731 client_token: Optional[str] = Field(default=None, alias="ClientToken") 732 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
735class CredentialsModel(BaseModel): 736 access_token: Optional[str] = Field(default=None, alias="AccessToken") 737 access_token_expiration: Optional[datetime] = Field( 738 default=None, alias="AccessTokenExpiration" 739 ) 740 refresh_token: Optional[str] = Field(default=None, alias="RefreshToken") 741 refresh_token_expiration: Optional[datetime] = Field( 742 default=None, alias="RefreshTokenExpiration" 743 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
746class CurrentMetricModel(BaseModel): 747 name: Optional[ 748 Literal[ 749 "AGENTS_AFTER_CONTACT_WORK", 750 "AGENTS_AVAILABLE", 751 "AGENTS_ERROR", 752 "AGENTS_NON_PRODUCTIVE", 753 "AGENTS_ONLINE", 754 "AGENTS_ON_CALL", 755 "AGENTS_ON_CONTACT", 756 "AGENTS_STAFFED", 757 "CONTACTS_IN_QUEUE", 758 "CONTACTS_SCHEDULED", 759 "OLDEST_CONTACT_AGE", 760 "SLOTS_ACTIVE", 761 "SLOTS_AVAILABLE", 762 ] 763 ] = Field(default=None, alias="Name") 764 unit: Optional[Literal["COUNT", "PERCENT", "SECONDS"]] = Field( 765 default=None, alias="Unit" 766 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
769class CurrentMetricSortCriteriaModel(BaseModel): 770 sort_by_metric: Optional[ 771 Literal[ 772 "AGENTS_AFTER_CONTACT_WORK", 773 "AGENTS_AVAILABLE", 774 "AGENTS_ERROR", 775 "AGENTS_NON_PRODUCTIVE", 776 "AGENTS_ONLINE", 777 "AGENTS_ON_CALL", 778 "AGENTS_ON_CONTACT", 779 "AGENTS_STAFFED", 780 "CONTACTS_IN_QUEUE", 781 "CONTACTS_SCHEDULED", 782 "OLDEST_CONTACT_AGE", 783 "SLOTS_ACTIVE", 784 "SLOTS_AVAILABLE", 785 ] 786 ] = Field(default=None, alias="SortByMetric") 787 sort_order: Optional[Literal["ASCENDING", "DESCENDING"]] = Field( 788 default=None, alias="SortOrder" 789 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
792class DateReferenceModel(BaseModel): 793 name: Optional[str] = Field(default=None, alias="Name") 794 value: Optional[str] = Field(default=None, alias="Value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
797class DefaultVocabularyModel(BaseModel): 798 instance_id: str = Field(alias="InstanceId") 799 language_code: Literal[ 800 "ar-AE", 801 "de-CH", 802 "de-DE", 803 "en-AB", 804 "en-AU", 805 "en-GB", 806 "en-IE", 807 "en-IN", 808 "en-NZ", 809 "en-US", 810 "en-WL", 811 "en-ZA", 812 "es-ES", 813 "es-US", 814 "fr-CA", 815 "fr-FR", 816 "hi-IN", 817 "it-IT", 818 "ja-JP", 819 "ko-KR", 820 "pt-BR", 821 "pt-PT", 822 "zh-CN", 823 ] = Field(alias="LanguageCode") 824 vocabulary_id: str = Field(alias="VocabularyId") 825 vocabulary_name: str = Field(alias="VocabularyName")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
828class DeleteContactFlowModuleRequestModel(BaseModel): 829 instance_id: str = Field(alias="InstanceId") 830 contact_flow_module_id: str = Field(alias="ContactFlowModuleId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
833class DeleteContactFlowRequestModel(BaseModel): 834 instance_id: str = Field(alias="InstanceId") 835 contact_flow_id: str = Field(alias="ContactFlowId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
838class DeleteHoursOfOperationRequestModel(BaseModel): 839 instance_id: str = Field(alias="InstanceId") 840 hours_of_operation_id: str = Field(alias="HoursOfOperationId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
847class DeleteIntegrationAssociationRequestModel(BaseModel): 848 instance_id: str = Field(alias="InstanceId") 849 integration_association_id: str = Field(alias="IntegrationAssociationId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
852class DeleteQuickConnectRequestModel(BaseModel): 853 instance_id: str = Field(alias="InstanceId") 854 quick_connect_id: str = Field(alias="QuickConnectId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
857class DeleteRuleRequestModel(BaseModel): 858 instance_id: str = Field(alias="InstanceId") 859 rule_id: str = Field(alias="RuleId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
862class DeleteSecurityProfileRequestModel(BaseModel): 863 instance_id: str = Field(alias="InstanceId") 864 security_profile_id: str = Field(alias="SecurityProfileId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
867class DeleteTaskTemplateRequestModel(BaseModel): 868 instance_id: str = Field(alias="InstanceId") 869 task_template_id: str = Field(alias="TaskTemplateId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
872class DeleteTrafficDistributionGroupRequestModel(BaseModel): 873 traffic_distribution_group_id: str = Field(alias="TrafficDistributionGroupId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
876class DeleteUseCaseRequestModel(BaseModel): 877 instance_id: str = Field(alias="InstanceId") 878 integration_association_id: str = Field(alias="IntegrationAssociationId") 879 use_case_id: str = Field(alias="UseCaseId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
882class DeleteUserHierarchyGroupRequestModel(BaseModel): 883 hierarchy_group_id: str = Field(alias="HierarchyGroupId") 884 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
887class DeleteUserRequestModel(BaseModel): 888 instance_id: str = Field(alias="InstanceId") 889 user_id: str = Field(alias="UserId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
892class DeleteVocabularyRequestModel(BaseModel): 893 instance_id: str = Field(alias="InstanceId") 894 vocabulary_id: str = Field(alias="VocabularyId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
897class DescribeAgentStatusRequestModel(BaseModel): 898 instance_id: str = Field(alias="InstanceId") 899 agent_status_id: str = Field(alias="AgentStatusId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
902class DescribeContactFlowModuleRequestModel(BaseModel): 903 instance_id: str = Field(alias="InstanceId") 904 contact_flow_module_id: str = Field(alias="ContactFlowModuleId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
907class DescribeContactFlowRequestModel(BaseModel): 908 instance_id: str = Field(alias="InstanceId") 909 contact_flow_id: str = Field(alias="ContactFlowId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
912class DescribeContactRequestModel(BaseModel): 913 instance_id: str = Field(alias="InstanceId") 914 contact_id: str = Field(alias="ContactId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
917class DescribeHoursOfOperationRequestModel(BaseModel): 918 instance_id: str = Field(alias="InstanceId") 919 hours_of_operation_id: str = Field(alias="HoursOfOperationId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
922class DescribeInstanceAttributeRequestModel(BaseModel): 923 instance_id: str = Field(alias="InstanceId") 924 attribute_type: Literal[ 925 "AUTO_RESOLVE_BEST_VOICES", 926 "CONTACTFLOW_LOGS", 927 "CONTACT_LENS", 928 "EARLY_MEDIA", 929 "ENHANCED_CONTACT_MONITORING", 930 "HIGH_VOLUME_OUTBOUND", 931 "INBOUND_CALLS", 932 "MULTI_PARTY_CONFERENCE", 933 "OUTBOUND_CALLS", 934 "USE_CUSTOM_TTS_VOICES", 935 ] = Field(alias="AttributeType")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
942class DescribeInstanceStorageConfigRequestModel(BaseModel): 943 instance_id: str = Field(alias="InstanceId") 944 association_id: str = Field(alias="AssociationId") 945 resource_type: Literal[ 946 "AGENT_EVENTS", 947 "ATTACHMENTS", 948 "CALL_RECORDINGS", 949 "CHAT_TRANSCRIPTS", 950 "CONTACT_EVALUATIONS", 951 "CONTACT_TRACE_RECORDS", 952 "MEDIA_STREAMS", 953 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 954 "SCHEDULED_REPORTS", 955 ] = Field(alias="ResourceType")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
958class DescribePhoneNumberRequestModel(BaseModel): 959 phone_number_id: str = Field(alias="PhoneNumberId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
962class DescribeQueueRequestModel(BaseModel): 963 instance_id: str = Field(alias="InstanceId") 964 queue_id: str = Field(alias="QueueId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
967class DescribeQuickConnectRequestModel(BaseModel): 968 instance_id: str = Field(alias="InstanceId") 969 quick_connect_id: str = Field(alias="QuickConnectId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
972class DescribeRoutingProfileRequestModel(BaseModel): 973 instance_id: str = Field(alias="InstanceId") 974 routing_profile_id: str = Field(alias="RoutingProfileId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
977class DescribeRuleRequestModel(BaseModel): 978 instance_id: str = Field(alias="InstanceId") 979 rule_id: str = Field(alias="RuleId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
982class DescribeSecurityProfileRequestModel(BaseModel): 983 security_profile_id: str = Field(alias="SecurityProfileId") 984 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
987class SecurityProfileModel(BaseModel): 988 id: Optional[str] = Field(default=None, alias="Id") 989 organization_resource_id: Optional[str] = Field( 990 default=None, alias="OrganizationResourceId" 991 ) 992 arn: Optional[str] = Field(default=None, alias="Arn") 993 security_profile_name: Optional[str] = Field( 994 default=None, alias="SecurityProfileName" 995 ) 996 description: Optional[str] = Field(default=None, alias="Description") 997 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 998 allowed_access_control_tags: Optional[Dict[str, str]] = Field( 999 default=None, alias="AllowedAccessControlTags" 1000 ) 1001 tag_restricted_resources: Optional[List[str]] = Field( 1002 default=None, alias="TagRestrictedResources" 1003 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1006class DescribeTrafficDistributionGroupRequestModel(BaseModel): 1007 traffic_distribution_group_id: str = Field(alias="TrafficDistributionGroupId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1010class TrafficDistributionGroupModel(BaseModel): 1011 id: Optional[str] = Field(default=None, alias="Id") 1012 arn: Optional[str] = Field(default=None, alias="Arn") 1013 name: Optional[str] = Field(default=None, alias="Name") 1014 description: Optional[str] = Field(default=None, alias="Description") 1015 instance_arn: Optional[str] = Field(default=None, alias="InstanceArn") 1016 status: Optional[ 1017 Literal[ 1018 "ACTIVE", 1019 "CREATION_FAILED", 1020 "CREATION_IN_PROGRESS", 1021 "DELETION_FAILED", 1022 "PENDING_DELETION", 1023 "UPDATE_IN_PROGRESS", 1024 ] 1025 ] = Field(default=None, alias="Status") 1026 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1029class DescribeUserHierarchyGroupRequestModel(BaseModel): 1030 hierarchy_group_id: str = Field(alias="HierarchyGroupId") 1031 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1034class DescribeUserHierarchyStructureRequestModel(BaseModel): 1035 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1038class DescribeUserRequestModel(BaseModel): 1039 user_id: str = Field(alias="UserId") 1040 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1043class DescribeVocabularyRequestModel(BaseModel): 1044 instance_id: str = Field(alias="InstanceId") 1045 vocabulary_id: str = Field(alias="VocabularyId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1048class VocabularyModel(BaseModel): 1049 name: str = Field(alias="Name") 1050 id: str = Field(alias="Id") 1051 arn: str = Field(alias="Arn") 1052 language_code: Literal[ 1053 "ar-AE", 1054 "de-CH", 1055 "de-DE", 1056 "en-AB", 1057 "en-AU", 1058 "en-GB", 1059 "en-IE", 1060 "en-IN", 1061 "en-NZ", 1062 "en-US", 1063 "en-WL", 1064 "en-ZA", 1065 "es-ES", 1066 "es-US", 1067 "fr-CA", 1068 "fr-FR", 1069 "hi-IN", 1070 "it-IT", 1071 "ja-JP", 1072 "ko-KR", 1073 "pt-BR", 1074 "pt-PT", 1075 "zh-CN", 1076 ] = Field(alias="LanguageCode") 1077 state: Literal[ 1078 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 1079 ] = Field(alias="State") 1080 last_modified_time: datetime = Field(alias="LastModifiedTime") 1081 failure_reason: Optional[str] = Field(default=None, alias="FailureReason") 1082 content: Optional[str] = Field(default=None, alias="Content") 1083 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1086class RoutingProfileReferenceModel(BaseModel): 1087 id: Optional[str] = Field(default=None, alias="Id") 1088 arn: Optional[str] = Field(default=None, alias="Arn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1091class DisassociateApprovedOriginRequestModel(BaseModel): 1092 instance_id: str = Field(alias="InstanceId") 1093 origin: str = Field(alias="Origin")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1096class DisassociateInstanceStorageConfigRequestModel(BaseModel): 1097 instance_id: str = Field(alias="InstanceId") 1098 association_id: str = Field(alias="AssociationId") 1099 resource_type: Literal[ 1100 "AGENT_EVENTS", 1101 "ATTACHMENTS", 1102 "CALL_RECORDINGS", 1103 "CHAT_TRANSCRIPTS", 1104 "CONTACT_EVALUATIONS", 1105 "CONTACT_TRACE_RECORDS", 1106 "MEDIA_STREAMS", 1107 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 1108 "SCHEDULED_REPORTS", 1109 ] = Field(alias="ResourceType")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1112class DisassociateLambdaFunctionRequestModel(BaseModel): 1113 instance_id: str = Field(alias="InstanceId") 1114 function_arn: str = Field(alias="FunctionArn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1117class DisassociateLexBotRequestModel(BaseModel): 1118 instance_id: str = Field(alias="InstanceId") 1119 bot_name: str = Field(alias="BotName") 1120 lex_region: str = Field(alias="LexRegion")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1123class DisassociatePhoneNumberContactFlowRequestModel(BaseModel): 1124 phone_number_id: str = Field(alias="PhoneNumberId") 1125 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1128class DisassociateQueueQuickConnectsRequestModel(BaseModel): 1129 instance_id: str = Field(alias="InstanceId") 1130 queue_id: str = Field(alias="QueueId") 1131 quick_connect_ids: Sequence[str] = Field(alias="QuickConnectIds")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1134class RoutingProfileQueueReferenceModel(BaseModel): 1135 queue_id: str = Field(alias="QueueId") 1136 channel: Literal["CHAT", "TASK", "VOICE"] = Field(alias="Channel")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1139class DisassociateSecurityKeyRequestModel(BaseModel): 1140 instance_id: str = Field(alias="InstanceId") 1141 association_id: str = Field(alias="AssociationId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1144class DismissUserContactRequestModel(BaseModel): 1145 user_id: str = Field(alias="UserId") 1146 instance_id: str = Field(alias="InstanceId") 1147 contact_id: str = Field(alias="ContactId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1150class DistributionModel(BaseModel): 1151 region: str = Field(alias="Region") 1152 percentage: int = Field(alias="Percentage")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1155class EmailReferenceModel(BaseModel): 1156 name: Optional[str] = Field(default=None, alias="Name") 1157 value: Optional[str] = Field(default=None, alias="Value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1160class EncryptionConfigModel(BaseModel): 1161 encryption_type: Literal["KMS"] = Field(alias="EncryptionType") 1162 key_id: str = Field(alias="KeyId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1169class FiltersModel(BaseModel): 1170 queues: Optional[Sequence[str]] = Field(default=None, alias="Queues") 1171 channels: Optional[Sequence[Literal["CHAT", "TASK", "VOICE"]]] = Field( 1172 default=None, alias="Channels" 1173 ) 1174 routing_profiles: Optional[Sequence[str]] = Field( 1175 default=None, alias="RoutingProfiles" 1176 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1179class GetContactAttributesRequestModel(BaseModel): 1180 instance_id: str = Field(alias="InstanceId") 1181 initial_contact_id: str = Field(alias="InitialContactId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1184class GetFederationTokenRequestModel(BaseModel): 1185 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1188class PaginatorConfigModel(BaseModel): 1189 max_items: Optional[int] = Field(default=None, alias="MaxItems") 1190 page_size: Optional[int] = Field(default=None, alias="PageSize") 1191 starting_token: Optional[str] = Field(default=None, alias="StartingToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1194class GetTaskTemplateRequestModel(BaseModel): 1195 instance_id: str = Field(alias="InstanceId") 1196 task_template_id: str = Field(alias="TaskTemplateId") 1197 snapshot_version: Optional[str] = Field(default=None, alias="SnapshotVersion")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1204class HierarchyGroupConditionModel(BaseModel): 1205 value: Optional[str] = Field(default=None, alias="Value") 1206 hierarchy_group_match_type: Optional[Literal["EXACT", "WITH_CHILD_GROUPS"]] = Field( 1207 default=None, alias="HierarchyGroupMatchType" 1208 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1211class HierarchyGroupSummaryReferenceModel(BaseModel): 1212 id: Optional[str] = Field(default=None, alias="Id") 1213 arn: Optional[str] = Field(default=None, alias="Arn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1216class HierarchyGroupSummaryModel(BaseModel): 1217 id: Optional[str] = Field(default=None, alias="Id") 1218 arn: Optional[str] = Field(default=None, alias="Arn") 1219 name: Optional[str] = Field(default=None, alias="Name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1222class HierarchyLevelModel(BaseModel): 1223 id: Optional[str] = Field(default=None, alias="Id") 1224 arn: Optional[str] = Field(default=None, alias="Arn") 1225 name: Optional[str] = Field(default=None, alias="Name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1232class ThresholdModel(BaseModel): 1233 comparison: Optional[Literal["LT"]] = Field(default=None, alias="Comparison") 1234 threshold_value: Optional[float] = Field(default=None, alias="ThresholdValue")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1237class HoursOfOperationTimeSliceModel(BaseModel): 1238 hours: int = Field(alias="Hours") 1239 minutes: int = Field(alias="Minutes")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1242class HoursOfOperationSummaryModel(BaseModel): 1243 id: Optional[str] = Field(default=None, alias="Id") 1244 arn: Optional[str] = Field(default=None, alias="Arn") 1245 name: Optional[str] = Field(default=None, alias="Name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1248class InstanceStatusReasonModel(BaseModel): 1249 message: Optional[str] = Field(default=None, alias="Message")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1252class KinesisFirehoseConfigModel(BaseModel): 1253 firehose_arn: str = Field(alias="FirehoseArn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1260class InstanceSummaryModel(BaseModel): 1261 id: Optional[str] = Field(default=None, alias="Id") 1262 arn: Optional[str] = Field(default=None, alias="Arn") 1263 identity_management_type: Optional[ 1264 Literal["CONNECT_MANAGED", "EXISTING_DIRECTORY", "SAML"] 1265 ] = Field(default=None, alias="IdentityManagementType") 1266 instance_alias: Optional[str] = Field(default=None, alias="InstanceAlias") 1267 created_time: Optional[datetime] = Field(default=None, alias="CreatedTime") 1268 service_role: Optional[str] = Field(default=None, alias="ServiceRole") 1269 instance_status: Optional[ 1270 Literal["ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS"] 1271 ] = Field(default=None, alias="InstanceStatus") 1272 inbound_calls_enabled: Optional[bool] = Field( 1273 default=None, alias="InboundCallsEnabled" 1274 ) 1275 outbound_calls_enabled: Optional[bool] = Field( 1276 default=None, alias="OutboundCallsEnabled" 1277 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1280class IntegrationAssociationSummaryModel(BaseModel): 1281 integration_association_id: Optional[str] = Field( 1282 default=None, alias="IntegrationAssociationId" 1283 ) 1284 integration_association_arn: Optional[str] = Field( 1285 default=None, alias="IntegrationAssociationArn" 1286 ) 1287 instance_id: Optional[str] = Field(default=None, alias="InstanceId") 1288 integration_type: Optional[ 1289 Literal[ 1290 "CASES_DOMAIN", 1291 "EVENT", 1292 "PINPOINT_APP", 1293 "VOICE_ID", 1294 "WISDOM_ASSISTANT", 1295 "WISDOM_KNOWLEDGE_BASE", 1296 ] 1297 ] = Field(default=None, alias="IntegrationType") 1298 integration_arn: Optional[str] = Field(default=None, alias="IntegrationArn") 1299 source_application_url: Optional[str] = Field( 1300 default=None, alias="SourceApplicationUrl" 1301 ) 1302 source_application_name: Optional[str] = Field( 1303 default=None, alias="SourceApplicationName" 1304 ) 1305 source_type: Optional[Literal["SALESFORCE", "ZENDESK"]] = Field( 1306 default=None, alias="SourceType" 1307 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1310class TaskTemplateFieldIdentifierModel(BaseModel): 1311 name: Optional[str] = Field(default=None, alias="Name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1314class ListAgentStatusRequestModel(BaseModel): 1315 instance_id: str = Field(alias="InstanceId") 1316 next_token: Optional[str] = Field(default=None, alias="NextToken") 1317 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1318 agent_status_types: Optional[ 1319 Sequence[Literal["CUSTOM", "OFFLINE", "ROUTABLE"]] 1320 ] = Field(default=None, alias="AgentStatusTypes")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1323class ListApprovedOriginsRequestModel(BaseModel): 1324 instance_id: str = Field(alias="InstanceId") 1325 next_token: Optional[str] = Field(default=None, alias="NextToken") 1326 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1329class ListBotsRequestModel(BaseModel): 1330 instance_id: str = Field(alias="InstanceId") 1331 lex_version: Literal["V1", "V2"] = Field(alias="LexVersion") 1332 next_token: Optional[str] = Field(default=None, alias="NextToken") 1333 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1336class ListContactFlowModulesRequestModel(BaseModel): 1337 instance_id: str = Field(alias="InstanceId") 1338 next_token: Optional[str] = Field(default=None, alias="NextToken") 1339 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1340 contact_flow_module_state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field( 1341 default=None, alias="ContactFlowModuleState" 1342 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1345class ListContactFlowsRequestModel(BaseModel): 1346 instance_id: str = Field(alias="InstanceId") 1347 contact_flow_types: Optional[ 1348 Sequence[ 1349 Literal[ 1350 "AGENT_HOLD", 1351 "AGENT_TRANSFER", 1352 "AGENT_WHISPER", 1353 "CONTACT_FLOW", 1354 "CUSTOMER_HOLD", 1355 "CUSTOMER_QUEUE", 1356 "CUSTOMER_WHISPER", 1357 "OUTBOUND_WHISPER", 1358 "QUEUE_TRANSFER", 1359 ] 1360 ] 1361 ] = Field(default=None, alias="ContactFlowTypes") 1362 next_token: Optional[str] = Field(default=None, alias="NextToken") 1363 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1366class ListContactReferencesRequestModel(BaseModel): 1367 instance_id: str = Field(alias="InstanceId") 1368 contact_id: str = Field(alias="ContactId") 1369 reference_types: Sequence[ 1370 Literal["ATTACHMENT", "DATE", "EMAIL", "NUMBER", "STRING", "URL"] 1371 ] = Field(alias="ReferenceTypes") 1372 next_token: Optional[str] = Field(default=None, alias="NextToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1375class ListDefaultVocabulariesRequestModel(BaseModel): 1376 instance_id: str = Field(alias="InstanceId") 1377 language_code: Optional[ 1378 Literal[ 1379 "ar-AE", 1380 "de-CH", 1381 "de-DE", 1382 "en-AB", 1383 "en-AU", 1384 "en-GB", 1385 "en-IE", 1386 "en-IN", 1387 "en-NZ", 1388 "en-US", 1389 "en-WL", 1390 "en-ZA", 1391 "es-ES", 1392 "es-US", 1393 "fr-CA", 1394 "fr-FR", 1395 "hi-IN", 1396 "it-IT", 1397 "ja-JP", 1398 "ko-KR", 1399 "pt-BR", 1400 "pt-PT", 1401 "zh-CN", 1402 ] 1403 ] = Field(default=None, alias="LanguageCode") 1404 max_results: Optional[int] = Field(default=None, alias="MaxResults") 1405 next_token: Optional[str] = Field(default=None, alias="NextToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1408class ListHoursOfOperationsRequestModel(BaseModel): 1409 instance_id: str = Field(alias="InstanceId") 1410 next_token: Optional[str] = Field(default=None, alias="NextToken") 1411 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1414class ListInstanceAttributesRequestModel(BaseModel): 1415 instance_id: str = Field(alias="InstanceId") 1416 next_token: Optional[str] = Field(default=None, alias="NextToken") 1417 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1420class ListInstanceStorageConfigsRequestModel(BaseModel): 1421 instance_id: str = Field(alias="InstanceId") 1422 resource_type: Literal[ 1423 "AGENT_EVENTS", 1424 "ATTACHMENTS", 1425 "CALL_RECORDINGS", 1426 "CHAT_TRANSCRIPTS", 1427 "CONTACT_EVALUATIONS", 1428 "CONTACT_TRACE_RECORDS", 1429 "MEDIA_STREAMS", 1430 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 1431 "SCHEDULED_REPORTS", 1432 ] = Field(alias="ResourceType") 1433 next_token: Optional[str] = Field(default=None, alias="NextToken") 1434 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1437class ListInstancesRequestModel(BaseModel): 1438 next_token: Optional[str] = Field(default=None, alias="NextToken") 1439 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1442class ListIntegrationAssociationsRequestModel(BaseModel): 1443 instance_id: str = Field(alias="InstanceId") 1444 integration_type: Optional[ 1445 Literal[ 1446 "CASES_DOMAIN", 1447 "EVENT", 1448 "PINPOINT_APP", 1449 "VOICE_ID", 1450 "WISDOM_ASSISTANT", 1451 "WISDOM_KNOWLEDGE_BASE", 1452 ] 1453 ] = Field(default=None, alias="IntegrationType") 1454 next_token: Optional[str] = Field(default=None, alias="NextToken") 1455 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1458class ListLambdaFunctionsRequestModel(BaseModel): 1459 instance_id: str = Field(alias="InstanceId") 1460 next_token: Optional[str] = Field(default=None, alias="NextToken") 1461 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1464class ListLexBotsRequestModel(BaseModel): 1465 instance_id: str = Field(alias="InstanceId") 1466 next_token: Optional[str] = Field(default=None, alias="NextToken") 1467 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1470class ListPhoneNumbersRequestModel(BaseModel): 1471 instance_id: str = Field(alias="InstanceId") 1472 phone_number_types: Optional[Sequence[Literal["DID", "TOLL_FREE"]]] = Field( 1473 default=None, alias="PhoneNumberTypes" 1474 ) 1475 phone_number_country_codes: Optional[ 1476 Sequence[ 1477 Literal[ 1478 "AD", 1479 "AE", 1480 "AF", 1481 "AG", 1482 "AI", 1483 "AL", 1484 "AM", 1485 "AN", 1486 "AO", 1487 "AQ", 1488 "AR", 1489 "AS", 1490 "AT", 1491 "AU", 1492 "AW", 1493 "AZ", 1494 "BA", 1495 "BB", 1496 "BD", 1497 "BE", 1498 "BF", 1499 "BG", 1500 "BH", 1501 "BI", 1502 "BJ", 1503 "BL", 1504 "BM", 1505 "BN", 1506 "BO", 1507 "BR", 1508 "BS", 1509 "BT", 1510 "BW", 1511 "BY", 1512 "BZ", 1513 "CA", 1514 "CC", 1515 "CD", 1516 "CF", 1517 "CG", 1518 "CH", 1519 "CI", 1520 "CK", 1521 "CL", 1522 "CM", 1523 "CN", 1524 "CO", 1525 "CR", 1526 "CU", 1527 "CV", 1528 "CW", 1529 "CX", 1530 "CY", 1531 "CZ", 1532 "DE", 1533 "DJ", 1534 "DK", 1535 "DM", 1536 "DO", 1537 "DZ", 1538 "EC", 1539 "EE", 1540 "EG", 1541 "EH", 1542 "ER", 1543 "ES", 1544 "ET", 1545 "FI", 1546 "FJ", 1547 "FK", 1548 "FM", 1549 "FO", 1550 "FR", 1551 "GA", 1552 "GB", 1553 "GD", 1554 "GE", 1555 "GG", 1556 "GH", 1557 "GI", 1558 "GL", 1559 "GM", 1560 "GN", 1561 "GQ", 1562 "GR", 1563 "GT", 1564 "GU", 1565 "GW", 1566 "GY", 1567 "HK", 1568 "HN", 1569 "HR", 1570 "HT", 1571 "HU", 1572 "ID", 1573 "IE", 1574 "IL", 1575 "IM", 1576 "IN", 1577 "Type[IO]", 1578 "IQ", 1579 "IR", 1580 "IS", 1581 "IT", 1582 "JE", 1583 "JM", 1584 "JO", 1585 "JP", 1586 "KE", 1587 "KG", 1588 "KH", 1589 "KI", 1590 "KM", 1591 "KN", 1592 "KP", 1593 "KR", 1594 "KW", 1595 "KY", 1596 "KZ", 1597 "LA", 1598 "LB", 1599 "LC", 1600 "LI", 1601 "LK", 1602 "LR", 1603 "LS", 1604 "LT", 1605 "LU", 1606 "LV", 1607 "LY", 1608 "MA", 1609 "MC", 1610 "MD", 1611 "ME", 1612 "MF", 1613 "MG", 1614 "MH", 1615 "MK", 1616 "ML", 1617 "MM", 1618 "MN", 1619 "MO", 1620 "MP", 1621 "MR", 1622 "MS", 1623 "MT", 1624 "MU", 1625 "MV", 1626 "MW", 1627 "MX", 1628 "MY", 1629 "MZ", 1630 "NA", 1631 "NC", 1632 "NE", 1633 "NG", 1634 "NI", 1635 "NL", 1636 "NO", 1637 "NP", 1638 "NR", 1639 "NU", 1640 "NZ", 1641 "OM", 1642 "PA", 1643 "PE", 1644 "PF", 1645 "PG", 1646 "PH", 1647 "PK", 1648 "PL", 1649 "PM", 1650 "PN", 1651 "PR", 1652 "PT", 1653 "PW", 1654 "PY", 1655 "QA", 1656 "RE", 1657 "RO", 1658 "RS", 1659 "RU", 1660 "RW", 1661 "SA", 1662 "SB", 1663 "SC", 1664 "SD", 1665 "SE", 1666 "SG", 1667 "SH", 1668 "SI", 1669 "SJ", 1670 "SK", 1671 "SL", 1672 "SM", 1673 "SN", 1674 "SO", 1675 "SR", 1676 "ST", 1677 "SV", 1678 "SX", 1679 "SY", 1680 "SZ", 1681 "TC", 1682 "TD", 1683 "TG", 1684 "TH", 1685 "TJ", 1686 "TK", 1687 "TL", 1688 "TM", 1689 "TN", 1690 "TO", 1691 "TR", 1692 "TT", 1693 "TV", 1694 "TW", 1695 "TZ", 1696 "UA", 1697 "UG", 1698 "US", 1699 "UY", 1700 "UZ", 1701 "VA", 1702 "VC", 1703 "VE", 1704 "VG", 1705 "VI", 1706 "VN", 1707 "VU", 1708 "WF", 1709 "WS", 1710 "YE", 1711 "YT", 1712 "ZA", 1713 "ZM", 1714 "ZW", 1715 ] 1716 ] 1717 ] = Field(default=None, alias="PhoneNumberCountryCodes") 1718 next_token: Optional[str] = Field(default=None, alias="NextToken") 1719 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1722class PhoneNumberSummaryModel(BaseModel): 1723 id: Optional[str] = Field(default=None, alias="Id") 1724 arn: Optional[str] = Field(default=None, alias="Arn") 1725 phone_number: Optional[str] = Field(default=None, alias="PhoneNumber") 1726 phone_number_type: Optional[Literal["DID", "TOLL_FREE"]] = Field( 1727 default=None, alias="PhoneNumberType" 1728 ) 1729 phone_number_country_code: Optional[ 1730 Literal[ 1731 "AD", 1732 "AE", 1733 "AF", 1734 "AG", 1735 "AI", 1736 "AL", 1737 "AM", 1738 "AN", 1739 "AO", 1740 "AQ", 1741 "AR", 1742 "AS", 1743 "AT", 1744 "AU", 1745 "AW", 1746 "AZ", 1747 "BA", 1748 "BB", 1749 "BD", 1750 "BE", 1751 "BF", 1752 "BG", 1753 "BH", 1754 "BI", 1755 "BJ", 1756 "BL", 1757 "BM", 1758 "BN", 1759 "BO", 1760 "BR", 1761 "BS", 1762 "BT", 1763 "BW", 1764 "BY", 1765 "BZ", 1766 "CA", 1767 "CC", 1768 "CD", 1769 "CF", 1770 "CG", 1771 "CH", 1772 "CI", 1773 "CK", 1774 "CL", 1775 "CM", 1776 "CN", 1777 "CO", 1778 "CR", 1779 "CU", 1780 "CV", 1781 "CW", 1782 "CX", 1783 "CY", 1784 "CZ", 1785 "DE", 1786 "DJ", 1787 "DK", 1788 "DM", 1789 "DO", 1790 "DZ", 1791 "EC", 1792 "EE", 1793 "EG", 1794 "EH", 1795 "ER", 1796 "ES", 1797 "ET", 1798 "FI", 1799 "FJ", 1800 "FK", 1801 "FM", 1802 "FO", 1803 "FR", 1804 "GA", 1805 "GB", 1806 "GD", 1807 "GE", 1808 "GG", 1809 "GH", 1810 "GI", 1811 "GL", 1812 "GM", 1813 "GN", 1814 "GQ", 1815 "GR", 1816 "GT", 1817 "GU", 1818 "GW", 1819 "GY", 1820 "HK", 1821 "HN", 1822 "HR", 1823 "HT", 1824 "HU", 1825 "ID", 1826 "IE", 1827 "IL", 1828 "IM", 1829 "IN", 1830 "Type[IO]", 1831 "IQ", 1832 "IR", 1833 "IS", 1834 "IT", 1835 "JE", 1836 "JM", 1837 "JO", 1838 "JP", 1839 "KE", 1840 "KG", 1841 "KH", 1842 "KI", 1843 "KM", 1844 "KN", 1845 "KP", 1846 "KR", 1847 "KW", 1848 "KY", 1849 "KZ", 1850 "LA", 1851 "LB", 1852 "LC", 1853 "LI", 1854 "LK", 1855 "LR", 1856 "LS", 1857 "LT", 1858 "LU", 1859 "LV", 1860 "LY", 1861 "MA", 1862 "MC", 1863 "MD", 1864 "ME", 1865 "MF", 1866 "MG", 1867 "MH", 1868 "MK", 1869 "ML", 1870 "MM", 1871 "MN", 1872 "MO", 1873 "MP", 1874 "MR", 1875 "MS", 1876 "MT", 1877 "MU", 1878 "MV", 1879 "MW", 1880 "MX", 1881 "MY", 1882 "MZ", 1883 "NA", 1884 "NC", 1885 "NE", 1886 "NG", 1887 "NI", 1888 "NL", 1889 "NO", 1890 "NP", 1891 "NR", 1892 "NU", 1893 "NZ", 1894 "OM", 1895 "PA", 1896 "PE", 1897 "PF", 1898 "PG", 1899 "PH", 1900 "PK", 1901 "PL", 1902 "PM", 1903 "PN", 1904 "PR", 1905 "PT", 1906 "PW", 1907 "PY", 1908 "QA", 1909 "RE", 1910 "RO", 1911 "RS", 1912 "RU", 1913 "RW", 1914 "SA", 1915 "SB", 1916 "SC", 1917 "SD", 1918 "SE", 1919 "SG", 1920 "SH", 1921 "SI", 1922 "SJ", 1923 "SK", 1924 "SL", 1925 "SM", 1926 "SN", 1927 "SO", 1928 "SR", 1929 "ST", 1930 "SV", 1931 "SX", 1932 "SY", 1933 "SZ", 1934 "TC", 1935 "TD", 1936 "TG", 1937 "TH", 1938 "TJ", 1939 "TK", 1940 "TL", 1941 "TM", 1942 "TN", 1943 "TO", 1944 "TR", 1945 "TT", 1946 "TV", 1947 "TW", 1948 "TZ", 1949 "UA", 1950 "UG", 1951 "US", 1952 "UY", 1953 "UZ", 1954 "VA", 1955 "VC", 1956 "VE", 1957 "VG", 1958 "VI", 1959 "VN", 1960 "VU", 1961 "WF", 1962 "WS", 1963 "YE", 1964 "YT", 1965 "ZA", 1966 "ZM", 1967 "ZW", 1968 ] 1969 ] = Field(default=None, alias="PhoneNumberCountryCode")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
1972class ListPhoneNumbersSummaryModel(BaseModel): 1973 phone_number_id: Optional[str] = Field(default=None, alias="PhoneNumberId") 1974 phone_number_arn: Optional[str] = Field(default=None, alias="PhoneNumberArn") 1975 phone_number: Optional[str] = Field(default=None, alias="PhoneNumber") 1976 phone_number_country_code: Optional[ 1977 Literal[ 1978 "AD", 1979 "AE", 1980 "AF", 1981 "AG", 1982 "AI", 1983 "AL", 1984 "AM", 1985 "AN", 1986 "AO", 1987 "AQ", 1988 "AR", 1989 "AS", 1990 "AT", 1991 "AU", 1992 "AW", 1993 "AZ", 1994 "BA", 1995 "BB", 1996 "BD", 1997 "BE", 1998 "BF", 1999 "BG", 2000 "BH", 2001 "BI", 2002 "BJ", 2003 "BL", 2004 "BM", 2005 "BN", 2006 "BO", 2007 "BR", 2008 "BS", 2009 "BT", 2010 "BW", 2011 "BY", 2012 "BZ", 2013 "CA", 2014 "CC", 2015 "CD", 2016 "CF", 2017 "CG", 2018 "CH", 2019 "CI", 2020 "CK", 2021 "CL", 2022 "CM", 2023 "CN", 2024 "CO", 2025 "CR", 2026 "CU", 2027 "CV", 2028 "CW", 2029 "CX", 2030 "CY", 2031 "CZ", 2032 "DE", 2033 "DJ", 2034 "DK", 2035 "DM", 2036 "DO", 2037 "DZ", 2038 "EC", 2039 "EE", 2040 "EG", 2041 "EH", 2042 "ER", 2043 "ES", 2044 "ET", 2045 "FI", 2046 "FJ", 2047 "FK", 2048 "FM", 2049 "FO", 2050 "FR", 2051 "GA", 2052 "GB", 2053 "GD", 2054 "GE", 2055 "GG", 2056 "GH", 2057 "GI", 2058 "GL", 2059 "GM", 2060 "GN", 2061 "GQ", 2062 "GR", 2063 "GT", 2064 "GU", 2065 "GW", 2066 "GY", 2067 "HK", 2068 "HN", 2069 "HR", 2070 "HT", 2071 "HU", 2072 "ID", 2073 "IE", 2074 "IL", 2075 "IM", 2076 "IN", 2077 "Type[IO]", 2078 "IQ", 2079 "IR", 2080 "IS", 2081 "IT", 2082 "JE", 2083 "JM", 2084 "JO", 2085 "JP", 2086 "KE", 2087 "KG", 2088 "KH", 2089 "KI", 2090 "KM", 2091 "KN", 2092 "KP", 2093 "KR", 2094 "KW", 2095 "KY", 2096 "KZ", 2097 "LA", 2098 "LB", 2099 "LC", 2100 "LI", 2101 "LK", 2102 "LR", 2103 "LS", 2104 "LT", 2105 "LU", 2106 "LV", 2107 "LY", 2108 "MA", 2109 "MC", 2110 "MD", 2111 "ME", 2112 "MF", 2113 "MG", 2114 "MH", 2115 "MK", 2116 "ML", 2117 "MM", 2118 "MN", 2119 "MO", 2120 "MP", 2121 "MR", 2122 "MS", 2123 "MT", 2124 "MU", 2125 "MV", 2126 "MW", 2127 "MX", 2128 "MY", 2129 "MZ", 2130 "NA", 2131 "NC", 2132 "NE", 2133 "NG", 2134 "NI", 2135 "NL", 2136 "NO", 2137 "NP", 2138 "NR", 2139 "NU", 2140 "NZ", 2141 "OM", 2142 "PA", 2143 "PE", 2144 "PF", 2145 "PG", 2146 "PH", 2147 "PK", 2148 "PL", 2149 "PM", 2150 "PN", 2151 "PR", 2152 "PT", 2153 "PW", 2154 "PY", 2155 "QA", 2156 "RE", 2157 "RO", 2158 "RS", 2159 "RU", 2160 "RW", 2161 "SA", 2162 "SB", 2163 "SC", 2164 "SD", 2165 "SE", 2166 "SG", 2167 "SH", 2168 "SI", 2169 "SJ", 2170 "SK", 2171 "SL", 2172 "SM", 2173 "SN", 2174 "SO", 2175 "SR", 2176 "ST", 2177 "SV", 2178 "SX", 2179 "SY", 2180 "SZ", 2181 "TC", 2182 "TD", 2183 "TG", 2184 "TH", 2185 "TJ", 2186 "TK", 2187 "TL", 2188 "TM", 2189 "TN", 2190 "TO", 2191 "TR", 2192 "TT", 2193 "TV", 2194 "TW", 2195 "TZ", 2196 "UA", 2197 "UG", 2198 "US", 2199 "UY", 2200 "UZ", 2201 "VA", 2202 "VC", 2203 "VE", 2204 "VG", 2205 "VI", 2206 "VN", 2207 "VU", 2208 "WF", 2209 "WS", 2210 "YE", 2211 "YT", 2212 "ZA", 2213 "ZM", 2214 "ZW", 2215 ] 2216 ] = Field(default=None, alias="PhoneNumberCountryCode") 2217 phone_number_type: Optional[Literal["DID", "TOLL_FREE"]] = Field( 2218 default=None, alias="PhoneNumberType" 2219 ) 2220 target_arn: Optional[str] = Field(default=None, alias="TargetArn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2223class ListPhoneNumbersV2RequestModel(BaseModel): 2224 target_arn: Optional[str] = Field(default=None, alias="TargetArn") 2225 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2226 next_token: Optional[str] = Field(default=None, alias="NextToken") 2227 phone_number_country_codes: Optional[ 2228 Sequence[ 2229 Literal[ 2230 "AD", 2231 "AE", 2232 "AF", 2233 "AG", 2234 "AI", 2235 "AL", 2236 "AM", 2237 "AN", 2238 "AO", 2239 "AQ", 2240 "AR", 2241 "AS", 2242 "AT", 2243 "AU", 2244 "AW", 2245 "AZ", 2246 "BA", 2247 "BB", 2248 "BD", 2249 "BE", 2250 "BF", 2251 "BG", 2252 "BH", 2253 "BI", 2254 "BJ", 2255 "BL", 2256 "BM", 2257 "BN", 2258 "BO", 2259 "BR", 2260 "BS", 2261 "BT", 2262 "BW", 2263 "BY", 2264 "BZ", 2265 "CA", 2266 "CC", 2267 "CD", 2268 "CF", 2269 "CG", 2270 "CH", 2271 "CI", 2272 "CK", 2273 "CL", 2274 "CM", 2275 "CN", 2276 "CO", 2277 "CR", 2278 "CU", 2279 "CV", 2280 "CW", 2281 "CX", 2282 "CY", 2283 "CZ", 2284 "DE", 2285 "DJ", 2286 "DK", 2287 "DM", 2288 "DO", 2289 "DZ", 2290 "EC", 2291 "EE", 2292 "EG", 2293 "EH", 2294 "ER", 2295 "ES", 2296 "ET", 2297 "FI", 2298 "FJ", 2299 "FK", 2300 "FM", 2301 "FO", 2302 "FR", 2303 "GA", 2304 "GB", 2305 "GD", 2306 "GE", 2307 "GG", 2308 "GH", 2309 "GI", 2310 "GL", 2311 "GM", 2312 "GN", 2313 "GQ", 2314 "GR", 2315 "GT", 2316 "GU", 2317 "GW", 2318 "GY", 2319 "HK", 2320 "HN", 2321 "HR", 2322 "HT", 2323 "HU", 2324 "ID", 2325 "IE", 2326 "IL", 2327 "IM", 2328 "IN", 2329 "Type[IO]", 2330 "IQ", 2331 "IR", 2332 "IS", 2333 "IT", 2334 "JE", 2335 "JM", 2336 "JO", 2337 "JP", 2338 "KE", 2339 "KG", 2340 "KH", 2341 "KI", 2342 "KM", 2343 "KN", 2344 "KP", 2345 "KR", 2346 "KW", 2347 "KY", 2348 "KZ", 2349 "LA", 2350 "LB", 2351 "LC", 2352 "LI", 2353 "LK", 2354 "LR", 2355 "LS", 2356 "LT", 2357 "LU", 2358 "LV", 2359 "LY", 2360 "MA", 2361 "MC", 2362 "MD", 2363 "ME", 2364 "MF", 2365 "MG", 2366 "MH", 2367 "MK", 2368 "ML", 2369 "MM", 2370 "MN", 2371 "MO", 2372 "MP", 2373 "MR", 2374 "MS", 2375 "MT", 2376 "MU", 2377 "MV", 2378 "MW", 2379 "MX", 2380 "MY", 2381 "MZ", 2382 "NA", 2383 "NC", 2384 "NE", 2385 "NG", 2386 "NI", 2387 "NL", 2388 "NO", 2389 "NP", 2390 "NR", 2391 "NU", 2392 "NZ", 2393 "OM", 2394 "PA", 2395 "PE", 2396 "PF", 2397 "PG", 2398 "PH", 2399 "PK", 2400 "PL", 2401 "PM", 2402 "PN", 2403 "PR", 2404 "PT", 2405 "PW", 2406 "PY", 2407 "QA", 2408 "RE", 2409 "RO", 2410 "RS", 2411 "RU", 2412 "RW", 2413 "SA", 2414 "SB", 2415 "SC", 2416 "SD", 2417 "SE", 2418 "SG", 2419 "SH", 2420 "SI", 2421 "SJ", 2422 "SK", 2423 "SL", 2424 "SM", 2425 "SN", 2426 "SO", 2427 "SR", 2428 "ST", 2429 "SV", 2430 "SX", 2431 "SY", 2432 "SZ", 2433 "TC", 2434 "TD", 2435 "TG", 2436 "TH", 2437 "TJ", 2438 "TK", 2439 "TL", 2440 "TM", 2441 "TN", 2442 "TO", 2443 "TR", 2444 "TT", 2445 "TV", 2446 "TW", 2447 "TZ", 2448 "UA", 2449 "UG", 2450 "US", 2451 "UY", 2452 "UZ", 2453 "VA", 2454 "VC", 2455 "VE", 2456 "VG", 2457 "VI", 2458 "VN", 2459 "VU", 2460 "WF", 2461 "WS", 2462 "YE", 2463 "YT", 2464 "ZA", 2465 "ZM", 2466 "ZW", 2467 ] 2468 ] 2469 ] = Field(default=None, alias="PhoneNumberCountryCodes") 2470 phone_number_types: Optional[Sequence[Literal["DID", "TOLL_FREE"]]] = Field( 2471 default=None, alias="PhoneNumberTypes" 2472 ) 2473 phone_number_prefix: Optional[str] = Field(default=None, alias="PhoneNumberPrefix")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2476class ListPromptsRequestModel(BaseModel): 2477 instance_id: str = Field(alias="InstanceId") 2478 next_token: Optional[str] = Field(default=None, alias="NextToken") 2479 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2482class PromptSummaryModel(BaseModel): 2483 id: Optional[str] = Field(default=None, alias="Id") 2484 arn: Optional[str] = Field(default=None, alias="Arn") 2485 name: Optional[str] = Field(default=None, alias="Name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2488class ListQueueQuickConnectsRequestModel(BaseModel): 2489 instance_id: str = Field(alias="InstanceId") 2490 queue_id: str = Field(alias="QueueId") 2491 next_token: Optional[str] = Field(default=None, alias="NextToken") 2492 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2495class QuickConnectSummaryModel(BaseModel): 2496 id: Optional[str] = Field(default=None, alias="Id") 2497 arn: Optional[str] = Field(default=None, alias="Arn") 2498 name: Optional[str] = Field(default=None, alias="Name") 2499 quick_connect_type: Optional[Literal["PHONE_NUMBER", "QUEUE", "USER"]] = Field( 2500 default=None, alias="QuickConnectType" 2501 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2504class ListQueuesRequestModel(BaseModel): 2505 instance_id: str = Field(alias="InstanceId") 2506 queue_types: Optional[Sequence[Literal["AGENT", "STANDARD"]]] = Field( 2507 default=None, alias="QueueTypes" 2508 ) 2509 next_token: Optional[str] = Field(default=None, alias="NextToken") 2510 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2513class QueueSummaryModel(BaseModel): 2514 id: Optional[str] = Field(default=None, alias="Id") 2515 arn: Optional[str] = Field(default=None, alias="Arn") 2516 name: Optional[str] = Field(default=None, alias="Name") 2517 queue_type: Optional[Literal["AGENT", "STANDARD"]] = Field( 2518 default=None, alias="QueueType" 2519 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2522class ListQuickConnectsRequestModel(BaseModel): 2523 instance_id: str = Field(alias="InstanceId") 2524 next_token: Optional[str] = Field(default=None, alias="NextToken") 2525 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2526 quick_connect_types: Optional[ 2527 Sequence[Literal["PHONE_NUMBER", "QUEUE", "USER"]] 2528 ] = Field(default=None, alias="QuickConnectTypes")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2531class ListRoutingProfileQueuesRequestModel(BaseModel): 2532 instance_id: str = Field(alias="InstanceId") 2533 routing_profile_id: str = Field(alias="RoutingProfileId") 2534 next_token: Optional[str] = Field(default=None, alias="NextToken") 2535 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2538class RoutingProfileQueueConfigSummaryModel(BaseModel): 2539 queue_id: str = Field(alias="QueueId") 2540 queue_arn: str = Field(alias="QueueArn") 2541 queue_name: str = Field(alias="QueueName") 2542 priority: int = Field(alias="Priority") 2543 delay: int = Field(alias="Delay") 2544 channel: Literal["CHAT", "TASK", "VOICE"] = Field(alias="Channel")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2547class ListRoutingProfilesRequestModel(BaseModel): 2548 instance_id: str = Field(alias="InstanceId") 2549 next_token: Optional[str] = Field(default=None, alias="NextToken") 2550 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2553class RoutingProfileSummaryModel(BaseModel): 2554 id: Optional[str] = Field(default=None, alias="Id") 2555 arn: Optional[str] = Field(default=None, alias="Arn") 2556 name: Optional[str] = Field(default=None, alias="Name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2559class ListRulesRequestModel(BaseModel): 2560 instance_id: str = Field(alias="InstanceId") 2561 publish_status: Optional[Literal["DRAFT", "PUBLISHED"]] = Field( 2562 default=None, alias="PublishStatus" 2563 ) 2564 event_source_name: Optional[ 2565 Literal[ 2566 "OnPostCallAnalysisAvailable", 2567 "OnPostChatAnalysisAvailable", 2568 "OnRealTimeCallAnalysisAvailable", 2569 "OnSalesforceCaseCreate", 2570 "OnZendeskTicketCreate", 2571 "OnZendeskTicketStatusUpdate", 2572 ] 2573 ] = Field(default=None, alias="EventSourceName") 2574 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2575 next_token: Optional[str] = Field(default=None, alias="NextToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2578class ListSecurityKeysRequestModel(BaseModel): 2579 instance_id: str = Field(alias="InstanceId") 2580 next_token: Optional[str] = Field(default=None, alias="NextToken") 2581 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2584class SecurityKeyModel(BaseModel): 2585 association_id: Optional[str] = Field(default=None, alias="AssociationId") 2586 key: Optional[str] = Field(default=None, alias="Key") 2587 creation_time: Optional[datetime] = Field(default=None, alias="CreationTime")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2590class ListSecurityProfilePermissionsRequestModel(BaseModel): 2591 security_profile_id: str = Field(alias="SecurityProfileId") 2592 instance_id: str = Field(alias="InstanceId") 2593 next_token: Optional[str] = Field(default=None, alias="NextToken") 2594 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2597class ListSecurityProfilesRequestModel(BaseModel): 2598 instance_id: str = Field(alias="InstanceId") 2599 next_token: Optional[str] = Field(default=None, alias="NextToken") 2600 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2603class SecurityProfileSummaryModel(BaseModel): 2604 id: Optional[str] = Field(default=None, alias="Id") 2605 arn: Optional[str] = Field(default=None, alias="Arn") 2606 name: Optional[str] = Field(default=None, alias="Name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2609class ListTagsForResourceRequestModel(BaseModel): 2610 resource_arn: str = Field(alias="resourceArn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2613class ListTaskTemplatesRequestModel(BaseModel): 2614 instance_id: str = Field(alias="InstanceId") 2615 next_token: Optional[str] = Field(default=None, alias="NextToken") 2616 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2617 status: Optional[Literal["ACTIVE", "INACTIVE"]] = Field( 2618 default=None, alias="Status" 2619 ) 2620 name: Optional[str] = Field(default=None, alias="Name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2623class TaskTemplateMetadataModel(BaseModel): 2624 id: Optional[str] = Field(default=None, alias="Id") 2625 arn: Optional[str] = Field(default=None, alias="Arn") 2626 name: Optional[str] = Field(default=None, alias="Name") 2627 description: Optional[str] = Field(default=None, alias="Description") 2628 status: Optional[Literal["ACTIVE", "INACTIVE"]] = Field( 2629 default=None, alias="Status" 2630 ) 2631 last_modified_time: Optional[datetime] = Field( 2632 default=None, alias="LastModifiedTime" 2633 ) 2634 created_time: Optional[datetime] = Field(default=None, alias="CreatedTime")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2637class ListTrafficDistributionGroupsRequestModel(BaseModel): 2638 max_results: Optional[int] = Field(default=None, alias="MaxResults") 2639 next_token: Optional[str] = Field(default=None, alias="NextToken") 2640 instance_id: Optional[str] = Field(default=None, alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2643class TrafficDistributionGroupSummaryModel(BaseModel): 2644 id: Optional[str] = Field(default=None, alias="Id") 2645 arn: Optional[str] = Field(default=None, alias="Arn") 2646 name: Optional[str] = Field(default=None, alias="Name") 2647 instance_arn: Optional[str] = Field(default=None, alias="InstanceArn") 2648 status: Optional[ 2649 Literal[ 2650 "ACTIVE", 2651 "CREATION_FAILED", 2652 "CREATION_IN_PROGRESS", 2653 "DELETION_FAILED", 2654 "PENDING_DELETION", 2655 "UPDATE_IN_PROGRESS", 2656 ] 2657 ] = Field(default=None, alias="Status")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2660class ListUseCasesRequestModel(BaseModel): 2661 instance_id: str = Field(alias="InstanceId") 2662 integration_association_id: str = Field(alias="IntegrationAssociationId") 2663 next_token: Optional[str] = Field(default=None, alias="NextToken") 2664 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2667class UseCaseModel(BaseModel): 2668 use_case_id: Optional[str] = Field(default=None, alias="UseCaseId") 2669 use_case_arn: Optional[str] = Field(default=None, alias="UseCaseArn") 2670 use_case_type: Optional[Literal["CONNECT_CAMPAIGNS", "RULES_EVALUATION"]] = Field( 2671 default=None, alias="UseCaseType" 2672 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2675class ListUserHierarchyGroupsRequestModel(BaseModel): 2676 instance_id: str = Field(alias="InstanceId") 2677 next_token: Optional[str] = Field(default=None, alias="NextToken") 2678 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2681class ListUsersRequestModel(BaseModel): 2682 instance_id: str = Field(alias="InstanceId") 2683 next_token: Optional[str] = Field(default=None, alias="NextToken") 2684 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2687class UserSummaryModel(BaseModel): 2688 id: Optional[str] = Field(default=None, alias="Id") 2689 arn: Optional[str] = Field(default=None, alias="Arn") 2690 username: Optional[str] = Field(default=None, alias="Username")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2693class MonitorContactRequestModel(BaseModel): 2694 instance_id: str = Field(alias="InstanceId") 2695 contact_id: str = Field(alias="ContactId") 2696 user_id: str = Field(alias="UserId") 2697 allowed_monitor_capabilities: Optional[ 2698 Sequence[Literal["BARGE", "SILENT_MONITOR"]] 2699 ] = Field(default=None, alias="AllowedMonitorCapabilities") 2700 client_token: Optional[str] = Field(default=None, alias="ClientToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2703class NotificationRecipientTypeModel(BaseModel): 2704 user_tags: Optional[Mapping[str, str]] = Field(default=None, alias="UserTags") 2705 user_ids: Optional[Sequence[str]] = Field(default=None, alias="UserIds")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2708class NumberReferenceModel(BaseModel): 2709 name: Optional[str] = Field(default=None, alias="Name") 2710 value: Optional[str] = Field(default=None, alias="Value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2717class ParticipantTimerValueModel(BaseModel): 2718 participant_timer_action: Optional[Literal["Unset"]] = Field( 2719 default=None, alias="ParticipantTimerAction" 2720 ) 2721 participant_timer_duration_in_minutes: Optional[int] = Field( 2722 default=None, alias="ParticipantTimerDurationInMinutes" 2723 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2726class PersistentChatModel(BaseModel): 2727 rehydration_type: Optional[Literal["ENTIRE_PAST_SESSION", "FROM_SEGMENT"]] = Field( 2728 default=None, alias="RehydrationType" 2729 ) 2730 source_contact_id: Optional[str] = Field(default=None, alias="SourceContactId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2733class PhoneNumberQuickConnectConfigModel(BaseModel): 2734 phone_number: str = Field(alias="PhoneNumber")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2737class PutUserStatusRequestModel(BaseModel): 2738 user_id: str = Field(alias="UserId") 2739 instance_id: str = Field(alias="InstanceId") 2740 agent_status_id: str = Field(alias="AgentStatusId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2743class QueueQuickConnectConfigModel(BaseModel): 2744 queue_id: str = Field(alias="QueueId") 2745 contact_flow_id: str = Field(alias="ContactFlowId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2748class StringConditionModel(BaseModel): 2749 field_name: Optional[str] = Field(default=None, alias="FieldName") 2750 value: Optional[str] = Field(default=None, alias="Value") 2751 comparison_type: Optional[Literal["CONTAINS", "EXACT", "STARTS_WITH"]] = Field( 2752 default=None, alias="ComparisonType" 2753 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2756class UserQuickConnectConfigModel(BaseModel): 2757 user_id: str = Field(alias="UserId") 2758 contact_flow_id: str = Field(alias="ContactFlowId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2761class StringReferenceModel(BaseModel): 2762 name: Optional[str] = Field(default=None, alias="Name") 2763 value: Optional[str] = Field(default=None, alias="Value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2766class UrlReferenceModel(BaseModel): 2767 name: Optional[str] = Field(default=None, alias="Name") 2768 value: Optional[str] = Field(default=None, alias="Value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2771class ReferenceModel(BaseModel): 2772 value: str = Field(alias="Value") 2773 type: Literal["ATTACHMENT", "DATE", "EMAIL", "NUMBER", "STRING", "URL"] = Field( 2774 alias="Type" 2775 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2778class ReleasePhoneNumberRequestModel(BaseModel): 2779 phone_number_id: str = Field(alias="PhoneNumberId") 2780 client_token: Optional[str] = Field(default=None, alias="ClientToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2783class ReplicateInstanceRequestModel(BaseModel): 2784 instance_id: str = Field(alias="InstanceId") 2785 replica_region: str = Field(alias="ReplicaRegion") 2786 replica_alias: str = Field(alias="ReplicaAlias") 2787 client_token: Optional[str] = Field(default=None, alias="ClientToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2790class ResumeContactRecordingRequestModel(BaseModel): 2791 instance_id: str = Field(alias="InstanceId") 2792 contact_id: str = Field(alias="ContactId") 2793 initial_contact_id: str = Field(alias="InitialContactId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
2796class SearchAvailablePhoneNumbersRequestModel(BaseModel): 2797 target_arn: str = Field(alias="TargetArn") 2798 phone_number_country_code: Literal[ 2799 "AD", 2800 "AE", 2801 "AF", 2802 "AG", 2803 "AI", 2804 "AL", 2805 "AM", 2806 "AN", 2807 "AO", 2808 "AQ", 2809 "AR", 2810 "AS", 2811 "AT", 2812 "AU", 2813 "AW", 2814 "AZ", 2815 "BA", 2816 "BB", 2817 "BD", 2818 "BE", 2819 "BF", 2820 "BG", 2821 "BH", 2822 "BI", 2823 "BJ", 2824 "BL", 2825 "BM", 2826 "BN", 2827 "BO", 2828 "BR", 2829 "BS", 2830 "BT", 2831 "BW", 2832 "BY", 2833 "BZ", 2834 "CA", 2835 "CC", 2836 "CD", 2837 "CF", 2838 "CG", 2839 "CH", 2840 "CI", 2841 "CK", 2842 "CL", 2843 "CM", 2844 "CN", 2845 "CO", 2846 "CR", 2847 "CU", 2848 "CV", 2849 "CW", 2850 "CX", 2851 "CY", 2852 "CZ", 2853 "DE", 2854 "DJ", 2855 "DK", 2856 "DM", 2857 "DO", 2858 "DZ", 2859 "EC", 2860 "EE", 2861 "EG", 2862 "EH", 2863 "ER", 2864 "ES", 2865 "ET", 2866 "FI", 2867 "FJ", 2868 "FK", 2869 "FM", 2870 "FO", 2871 "FR", 2872 "GA", 2873 "GB", 2874 "GD", 2875 "GE", 2876 "GG", 2877 "GH", 2878 "GI", 2879 "GL", 2880 "GM", 2881 "GN", 2882 "GQ", 2883 "GR", 2884 "GT", 2885 "GU", 2886 "GW", 2887 "GY", 2888 "HK", 2889 "HN", 2890 "HR", 2891 "HT", 2892 "HU", 2893 "ID", 2894 "IE", 2895 "IL", 2896 "IM", 2897 "IN", 2898 "Type[IO]", 2899 "IQ", 2900 "IR", 2901 "IS", 2902 "IT", 2903 "JE", 2904 "JM", 2905 "JO", 2906 "JP", 2907 "KE", 2908 "KG", 2909 "KH", 2910 "KI", 2911 "KM", 2912 "KN", 2913 "KP", 2914 "KR", 2915 "KW", 2916 "KY", 2917 "KZ", 2918 "LA", 2919 "LB", 2920 "LC", 2921 "LI", 2922 "LK", 2923 "LR", 2924 "LS", 2925 "LT", 2926 "LU", 2927 "LV", 2928 "LY", 2929 "MA", 2930 "MC", 2931 "MD", 2932 "ME", 2933 "MF", 2934 "MG", 2935 "MH", 2936 "MK", 2937 "ML", 2938 "MM", 2939 "MN", 2940 "MO", 2941 "MP", 2942 "MR", 2943 "MS", 2944 "MT", 2945 "MU", 2946 "MV", 2947 "MW", 2948 "MX", 2949 "MY", 2950 "MZ", 2951 "NA", 2952 "NC", 2953 "NE", 2954 "NG", 2955 "NI", 2956 "NL", 2957 "NO", 2958 "NP", 2959 "NR", 2960 "NU", 2961 "NZ", 2962 "OM", 2963 "PA", 2964 "PE", 2965 "PF", 2966 "PG", 2967 "PH", 2968 "PK", 2969 "PL", 2970 "PM", 2971 "PN", 2972 "PR", 2973 "PT", 2974 "PW", 2975 "PY", 2976 "QA", 2977 "RE", 2978 "RO", 2979 "RS", 2980 "RU", 2981 "RW", 2982 "SA", 2983 "SB", 2984 "SC", 2985 "SD", 2986 "SE", 2987 "SG", 2988 "SH", 2989 "SI", 2990 "SJ", 2991 "SK", 2992 "SL", 2993 "SM", 2994 "SN", 2995 "SO", 2996 "SR", 2997 "ST", 2998 "SV", 2999 "SX", 3000 "SY", 3001 "SZ", 3002 "TC", 3003 "TD", 3004 "TG", 3005 "TH", 3006 "TJ", 3007 "TK", 3008 "TL", 3009 "TM", 3010 "TN", 3011 "TO", 3012 "TR", 3013 "TT", 3014 "TV", 3015 "TW", 3016 "TZ", 3017 "UA", 3018 "UG", 3019 "US", 3020 "UY", 3021 "UZ", 3022 "VA", 3023 "VC", 3024 "VE", 3025 "VG", 3026 "VI", 3027 "VN", 3028 "VU", 3029 "WF", 3030 "WS", 3031 "YE", 3032 "YT", 3033 "ZA", 3034 "ZM", 3035 "ZW", 3036 ] = Field(alias="PhoneNumberCountryCode") 3037 phone_number_type: Literal["DID", "TOLL_FREE"] = Field(alias="PhoneNumberType") 3038 phone_number_prefix: Optional[str] = Field(default=None, alias="PhoneNumberPrefix") 3039 max_results: Optional[int] = Field(default=None, alias="MaxResults") 3040 next_token: Optional[str] = Field(default=None, alias="NextToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3043class SecurityProfileSearchSummaryModel(BaseModel): 3044 id: Optional[str] = Field(default=None, alias="Id") 3045 organization_resource_id: Optional[str] = Field( 3046 default=None, alias="OrganizationResourceId" 3047 ) 3048 arn: Optional[str] = Field(default=None, alias="Arn") 3049 security_profile_name: Optional[str] = Field( 3050 default=None, alias="SecurityProfileName" 3051 ) 3052 description: Optional[str] = Field(default=None, alias="Description") 3053 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3056class SearchVocabulariesRequestModel(BaseModel): 3057 instance_id: str = Field(alias="InstanceId") 3058 max_results: Optional[int] = Field(default=None, alias="MaxResults") 3059 next_token: Optional[str] = Field(default=None, alias="NextToken") 3060 state: Optional[ 3061 Literal[ 3062 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 3063 ] 3064 ] = Field(default=None, alias="State") 3065 name_starts_with: Optional[str] = Field(default=None, alias="NameStartsWith") 3066 language_code: Optional[ 3067 Literal[ 3068 "ar-AE", 3069 "de-CH", 3070 "de-DE", 3071 "en-AB", 3072 "en-AU", 3073 "en-GB", 3074 "en-IE", 3075 "en-IN", 3076 "en-NZ", 3077 "en-US", 3078 "en-WL", 3079 "en-ZA", 3080 "es-ES", 3081 "es-US", 3082 "fr-CA", 3083 "fr-FR", 3084 "hi-IN", 3085 "it-IT", 3086 "ja-JP", 3087 "ko-KR", 3088 "pt-BR", 3089 "pt-PT", 3090 "zh-CN", 3091 ] 3092 ] = Field(default=None, alias="LanguageCode")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3095class VocabularySummaryModel(BaseModel): 3096 name: str = Field(alias="Name") 3097 id: str = Field(alias="Id") 3098 arn: str = Field(alias="Arn") 3099 language_code: Literal[ 3100 "ar-AE", 3101 "de-CH", 3102 "de-DE", 3103 "en-AB", 3104 "en-AU", 3105 "en-GB", 3106 "en-IE", 3107 "en-IN", 3108 "en-NZ", 3109 "en-US", 3110 "en-WL", 3111 "en-ZA", 3112 "es-ES", 3113 "es-US", 3114 "fr-CA", 3115 "fr-FR", 3116 "hi-IN", 3117 "it-IT", 3118 "ja-JP", 3119 "ko-KR", 3120 "pt-BR", 3121 "pt-PT", 3122 "zh-CN", 3123 ] = Field(alias="LanguageCode") 3124 state: Literal[ 3125 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 3126 ] = Field(alias="State") 3127 last_modified_time: datetime = Field(alias="LastModifiedTime") 3128 failure_reason: Optional[str] = Field(default=None, alias="FailureReason")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3131class VoiceRecordingConfigurationModel(BaseModel): 3132 voice_recording_track: Optional[Literal["ALL", "FROM_AGENT", "TO_AGENT"]] = Field( 3133 default=None, alias="VoiceRecordingTrack" 3134 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3137class StopContactRecordingRequestModel(BaseModel): 3138 instance_id: str = Field(alias="InstanceId") 3139 contact_id: str = Field(alias="ContactId") 3140 initial_contact_id: str = Field(alias="InitialContactId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3143class StopContactRequestModel(BaseModel): 3144 contact_id: str = Field(alias="ContactId") 3145 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3148class StopContactStreamingRequestModel(BaseModel): 3149 instance_id: str = Field(alias="InstanceId") 3150 contact_id: str = Field(alias="ContactId") 3151 streaming_id: str = Field(alias="StreamingId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3154class SuspendContactRecordingRequestModel(BaseModel): 3155 instance_id: str = Field(alias="InstanceId") 3156 contact_id: str = Field(alias="ContactId") 3157 initial_contact_id: str = Field(alias="InitialContactId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3160class TagResourceRequestModel(BaseModel): 3161 resource_arn: str = Field(alias="resourceArn") 3162 tags: Mapping[str, str] = Field(alias="tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3165class TransferContactRequestModel(BaseModel): 3166 instance_id: str = Field(alias="InstanceId") 3167 contact_id: str = Field(alias="ContactId") 3168 contact_flow_id: str = Field(alias="ContactFlowId") 3169 queue_id: Optional[str] = Field(default=None, alias="QueueId") 3170 user_id: Optional[str] = Field(default=None, alias="UserId") 3171 client_token: Optional[str] = Field(default=None, alias="ClientToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3174class UntagResourceRequestModel(BaseModel): 3175 resource_arn: str = Field(alias="resourceArn") 3176 tag_keys: Sequence[str] = Field(alias="tagKeys")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3179class UpdateAgentStatusRequestModel(BaseModel): 3180 instance_id: str = Field(alias="InstanceId") 3181 agent_status_id: str = Field(alias="AgentStatusId") 3182 name: Optional[str] = Field(default=None, alias="Name") 3183 description: Optional[str] = Field(default=None, alias="Description") 3184 state: Optional[Literal["DISABLED", "ENABLED"]] = Field(default=None, alias="State") 3185 display_order: Optional[int] = Field(default=None, alias="DisplayOrder") 3186 reset_order_number: Optional[bool] = Field(default=None, alias="ResetOrderNumber")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3189class UpdateContactAttributesRequestModel(BaseModel): 3190 initial_contact_id: str = Field(alias="InitialContactId") 3191 instance_id: str = Field(alias="InstanceId") 3192 attributes: Mapping[str, str] = Field(alias="Attributes")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3195class UpdateContactFlowContentRequestModel(BaseModel): 3196 instance_id: str = Field(alias="InstanceId") 3197 contact_flow_id: str = Field(alias="ContactFlowId") 3198 content: str = Field(alias="Content")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3201class UpdateContactFlowMetadataRequestModel(BaseModel): 3202 instance_id: str = Field(alias="InstanceId") 3203 contact_flow_id: str = Field(alias="ContactFlowId") 3204 name: Optional[str] = Field(default=None, alias="Name") 3205 description: Optional[str] = Field(default=None, alias="Description") 3206 contact_flow_state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field( 3207 default=None, alias="ContactFlowState" 3208 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3211class UpdateContactFlowModuleContentRequestModel(BaseModel): 3212 instance_id: str = Field(alias="InstanceId") 3213 contact_flow_module_id: str = Field(alias="ContactFlowModuleId") 3214 content: str = Field(alias="Content")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3217class UpdateContactFlowModuleMetadataRequestModel(BaseModel): 3218 instance_id: str = Field(alias="InstanceId") 3219 contact_flow_module_id: str = Field(alias="ContactFlowModuleId") 3220 name: Optional[str] = Field(default=None, alias="Name") 3221 description: Optional[str] = Field(default=None, alias="Description") 3222 state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field(default=None, alias="State")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3225class UpdateContactFlowNameRequestModel(BaseModel): 3226 instance_id: str = Field(alias="InstanceId") 3227 contact_flow_id: str = Field(alias="ContactFlowId") 3228 name: Optional[str] = Field(default=None, alias="Name") 3229 description: Optional[str] = Field(default=None, alias="Description")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3232class UpdateContactScheduleRequestModel(BaseModel): 3233 instance_id: str = Field(alias="InstanceId") 3234 contact_id: str = Field(alias="ContactId") 3235 scheduled_time: Union[datetime, str] = Field(alias="ScheduledTime")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3238class UpdateInstanceAttributeRequestModel(BaseModel): 3239 instance_id: str = Field(alias="InstanceId") 3240 attribute_type: Literal[ 3241 "AUTO_RESOLVE_BEST_VOICES", 3242 "CONTACTFLOW_LOGS", 3243 "CONTACT_LENS", 3244 "EARLY_MEDIA", 3245 "ENHANCED_CONTACT_MONITORING", 3246 "HIGH_VOLUME_OUTBOUND", 3247 "INBOUND_CALLS", 3248 "MULTI_PARTY_CONFERENCE", 3249 "OUTBOUND_CALLS", 3250 "USE_CUSTOM_TTS_VOICES", 3251 ] = Field(alias="AttributeType") 3252 value: str = Field(alias="Value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3255class UpdatePhoneNumberRequestModel(BaseModel): 3256 phone_number_id: str = Field(alias="PhoneNumberId") 3257 target_arn: str = Field(alias="TargetArn") 3258 client_token: Optional[str] = Field(default=None, alias="ClientToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3261class UpdateQueueHoursOfOperationRequestModel(BaseModel): 3262 instance_id: str = Field(alias="InstanceId") 3263 queue_id: str = Field(alias="QueueId") 3264 hours_of_operation_id: str = Field(alias="HoursOfOperationId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3267class UpdateQueueMaxContactsRequestModel(BaseModel): 3268 instance_id: str = Field(alias="InstanceId") 3269 queue_id: str = Field(alias="QueueId") 3270 max_contacts: Optional[int] = Field(default=None, alias="MaxContacts")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3273class UpdateQueueNameRequestModel(BaseModel): 3274 instance_id: str = Field(alias="InstanceId") 3275 queue_id: str = Field(alias="QueueId") 3276 name: Optional[str] = Field(default=None, alias="Name") 3277 description: Optional[str] = Field(default=None, alias="Description")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3280class UpdateQueueStatusRequestModel(BaseModel): 3281 instance_id: str = Field(alias="InstanceId") 3282 queue_id: str = Field(alias="QueueId") 3283 status: Literal["DISABLED", "ENABLED"] = Field(alias="Status")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3286class UpdateQuickConnectNameRequestModel(BaseModel): 3287 instance_id: str = Field(alias="InstanceId") 3288 quick_connect_id: str = Field(alias="QuickConnectId") 3289 name: Optional[str] = Field(default=None, alias="Name") 3290 description: Optional[str] = Field(default=None, alias="Description")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3293class UpdateRoutingProfileDefaultOutboundQueueRequestModel(BaseModel): 3294 instance_id: str = Field(alias="InstanceId") 3295 routing_profile_id: str = Field(alias="RoutingProfileId") 3296 default_outbound_queue_id: str = Field(alias="DefaultOutboundQueueId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3299class UpdateRoutingProfileNameRequestModel(BaseModel): 3300 instance_id: str = Field(alias="InstanceId") 3301 routing_profile_id: str = Field(alias="RoutingProfileId") 3302 name: Optional[str] = Field(default=None, alias="Name") 3303 description: Optional[str] = Field(default=None, alias="Description")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3306class UpdateSecurityProfileRequestModel(BaseModel): 3307 security_profile_id: str = Field(alias="SecurityProfileId") 3308 instance_id: str = Field(alias="InstanceId") 3309 description: Optional[str] = Field(default=None, alias="Description") 3310 permissions: Optional[Sequence[str]] = Field(default=None, alias="Permissions") 3311 allowed_access_control_tags: Optional[Mapping[str, str]] = Field( 3312 default=None, alias="AllowedAccessControlTags" 3313 ) 3314 tag_restricted_resources: Optional[Sequence[str]] = Field( 3315 default=None, alias="TagRestrictedResources" 3316 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3319class UpdateUserHierarchyGroupNameRequestModel(BaseModel): 3320 name: str = Field(alias="Name") 3321 hierarchy_group_id: str = Field(alias="HierarchyGroupId") 3322 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3325class UpdateUserHierarchyRequestModel(BaseModel): 3326 user_id: str = Field(alias="UserId") 3327 instance_id: str = Field(alias="InstanceId") 3328 hierarchy_group_id: Optional[str] = Field(default=None, alias="HierarchyGroupId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3331class UpdateUserRoutingProfileRequestModel(BaseModel): 3332 routing_profile_id: str = Field(alias="RoutingProfileId") 3333 user_id: str = Field(alias="UserId") 3334 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3337class UpdateUserSecurityProfilesRequestModel(BaseModel): 3338 security_profile_ids: Sequence[str] = Field(alias="SecurityProfileIds") 3339 user_id: str = Field(alias="UserId") 3340 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3343class UserReferenceModel(BaseModel): 3344 id: Optional[str] = Field(default=None, alias="Id") 3345 arn: Optional[str] = Field(default=None, alias="Arn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3348class UserIdentityInfoLiteModel(BaseModel): 3349 first_name: Optional[str] = Field(default=None, alias="FirstName") 3350 last_name: Optional[str] = Field(default=None, alias="LastName")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3353class RuleSummaryModel(BaseModel): 3354 name: str = Field(alias="Name") 3355 rule_id: str = Field(alias="RuleId") 3356 rule_arn: str = Field(alias="RuleArn") 3357 event_source_name: Literal[ 3358 "OnPostCallAnalysisAvailable", 3359 "OnPostChatAnalysisAvailable", 3360 "OnRealTimeCallAnalysisAvailable", 3361 "OnSalesforceCaseCreate", 3362 "OnZendeskTicketCreate", 3363 "OnZendeskTicketStatusUpdate", 3364 ] = Field(alias="EventSourceName") 3365 publish_status: Literal["DRAFT", "PUBLISHED"] = Field(alias="PublishStatus") 3366 action_summaries: List[ActionSummaryModel] = Field(alias="ActionSummaries") 3367 created_time: datetime = Field(alias="CreatedTime") 3368 last_updated_time: datetime = Field(alias="LastUpdatedTime")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3371class AgentContactReferenceModel(BaseModel): 3372 contact_id: Optional[str] = Field(default=None, alias="ContactId") 3373 channel: Optional[Literal["CHAT", "TASK", "VOICE"]] = Field( 3374 default=None, alias="Channel" 3375 ) 3376 initiation_method: Optional[ 3377 Literal[ 3378 "API", 3379 "CALLBACK", 3380 "DISCONNECT", 3381 "INBOUND", 3382 "MONITOR", 3383 "OUTBOUND", 3384 "QUEUE_TRANSFER", 3385 "TRANSFER", 3386 ] 3387 ] = Field(default=None, alias="InitiationMethod") 3388 agent_contact_state: Optional[ 3389 Literal[ 3390 "CONNECTED", 3391 "CONNECTED_ONHOLD", 3392 "CONNECTING", 3393 "ENDED", 3394 "ERROR", 3395 "INCOMING", 3396 "MISSED", 3397 "PENDING", 3398 "REJECTED", 3399 ] 3400 ] = Field(default=None, alias="AgentContactState") 3401 state_start_timestamp: Optional[datetime] = Field( 3402 default=None, alias="StateStartTimestamp" 3403 ) 3404 connected_to_agent_timestamp: Optional[datetime] = Field( 3405 default=None, alias="ConnectedToAgentTimestamp" 3406 ) 3407 queue: Optional[QueueReferenceModel] = Field(default=None, alias="Queue")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3410class StartOutboundVoiceContactRequestModel(BaseModel): 3411 destination_phone_number: str = Field(alias="DestinationPhoneNumber") 3412 contact_flow_id: str = Field(alias="ContactFlowId") 3413 instance_id: str = Field(alias="InstanceId") 3414 client_token: Optional[str] = Field(default=None, alias="ClientToken") 3415 source_phone_number: Optional[str] = Field(default=None, alias="SourcePhoneNumber") 3416 queue_id: Optional[str] = Field(default=None, alias="QueueId") 3417 attributes: Optional[Mapping[str, str]] = Field(default=None, alias="Attributes") 3418 answer_machine_detection_config: Optional[ 3419 AnswerMachineDetectionConfigModel 3420 ] = Field(default=None, alias="AnswerMachineDetectionConfig") 3421 campaign_id: Optional[str] = Field(default=None, alias="CampaignId") 3422 traffic_type: Optional[Literal["CAMPAIGN", "GENERAL"]] = Field( 3423 default=None, alias="TrafficType" 3424 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3427class AssociateLexBotRequestModel(BaseModel): 3428 instance_id: str = Field(alias="InstanceId") 3429 lex_bot: LexBotModel = Field(alias="LexBot")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3432class AssociateBotRequestModel(BaseModel): 3433 instance_id: str = Field(alias="InstanceId") 3434 lex_bot: Optional[LexBotModel] = Field(default=None, alias="LexBot") 3435 lex_v2_bot: Optional[LexV2BotModel] = Field(default=None, alias="LexV2Bot")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3438class DisassociateBotRequestModel(BaseModel): 3439 instance_id: str = Field(alias="InstanceId") 3440 lex_bot: Optional[LexBotModel] = Field(default=None, alias="LexBot") 3441 lex_v2_bot: Optional[LexV2BotModel] = Field(default=None, alias="LexV2Bot")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3444class LexBotConfigModel(BaseModel): 3445 lex_bot: Optional[LexBotModel] = Field(default=None, alias="LexBot") 3446 lex_v2_bot: Optional[LexV2BotModel] = Field(default=None, alias="LexV2Bot")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3449class AssociateInstanceStorageConfigResponseModel(BaseModel): 3450 association_id: str = Field(alias="AssociationId") 3451 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3454class AssociateSecurityKeyResponseModel(BaseModel): 3455 association_id: str = Field(alias="AssociationId") 3456 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3459class ClaimPhoneNumberResponseModel(BaseModel): 3460 phone_number_id: str = Field(alias="PhoneNumberId") 3461 phone_number_arn: str = Field(alias="PhoneNumberArn") 3462 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3465class CreateAgentStatusResponseModel(BaseModel): 3466 agent_status_arn: str = Field(alias="AgentStatusARN") 3467 agent_status_id: str = Field(alias="AgentStatusId") 3468 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3471class CreateContactFlowModuleResponseModel(BaseModel): 3472 id: str = Field(alias="Id") 3473 arn: str = Field(alias="Arn") 3474 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3477class CreateContactFlowResponseModel(BaseModel): 3478 contact_flow_id: str = Field(alias="ContactFlowId") 3479 contact_flow_arn: str = Field(alias="ContactFlowArn") 3480 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3483class CreateHoursOfOperationResponseModel(BaseModel): 3484 hours_of_operation_id: str = Field(alias="HoursOfOperationId") 3485 hours_of_operation_arn: str = Field(alias="HoursOfOperationArn") 3486 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3489class CreateInstanceResponseModel(BaseModel): 3490 id: str = Field(alias="Id") 3491 arn: str = Field(alias="Arn") 3492 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3495class CreateIntegrationAssociationResponseModel(BaseModel): 3496 integration_association_id: str = Field(alias="IntegrationAssociationId") 3497 integration_association_arn: str = Field(alias="IntegrationAssociationArn") 3498 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3501class CreateQueueResponseModel(BaseModel): 3502 queue_arn: str = Field(alias="QueueArn") 3503 queue_id: str = Field(alias="QueueId") 3504 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3507class CreateQuickConnectResponseModel(BaseModel): 3508 quick_connect_arn: str = Field(alias="QuickConnectARN") 3509 quick_connect_id: str = Field(alias="QuickConnectId") 3510 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3513class CreateRoutingProfileResponseModel(BaseModel): 3514 routing_profile_arn: str = Field(alias="RoutingProfileArn") 3515 routing_profile_id: str = Field(alias="RoutingProfileId") 3516 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3519class CreateRuleResponseModel(BaseModel): 3520 rule_arn: str = Field(alias="RuleArn") 3521 rule_id: str = Field(alias="RuleId") 3522 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3525class CreateSecurityProfileResponseModel(BaseModel): 3526 security_profile_id: str = Field(alias="SecurityProfileId") 3527 security_profile_arn: str = Field(alias="SecurityProfileArn") 3528 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3531class CreateTaskTemplateResponseModel(BaseModel): 3532 id: str = Field(alias="Id") 3533 arn: str = Field(alias="Arn") 3534 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3537class CreateTrafficDistributionGroupResponseModel(BaseModel): 3538 id: str = Field(alias="Id") 3539 arn: str = Field(alias="Arn") 3540 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3543class CreateUseCaseResponseModel(BaseModel): 3544 use_case_id: str = Field(alias="UseCaseId") 3545 use_case_arn: str = Field(alias="UseCaseArn") 3546 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3549class CreateUserHierarchyGroupResponseModel(BaseModel): 3550 hierarchy_group_id: str = Field(alias="HierarchyGroupId") 3551 hierarchy_group_arn: str = Field(alias="HierarchyGroupArn") 3552 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3555class CreateUserResponseModel(BaseModel): 3556 user_id: str = Field(alias="UserId") 3557 user_arn: str = Field(alias="UserArn") 3558 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3561class CreateVocabularyResponseModel(BaseModel): 3562 vocabulary_arn: str = Field(alias="VocabularyArn") 3563 vocabulary_id: str = Field(alias="VocabularyId") 3564 state: Literal[ 3565 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 3566 ] = Field(alias="State") 3567 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3570class DeleteVocabularyResponseModel(BaseModel): 3571 vocabulary_arn: str = Field(alias="VocabularyArn") 3572 vocabulary_id: str = Field(alias="VocabularyId") 3573 state: Literal[ 3574 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 3575 ] = Field(alias="State") 3576 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3579class DescribeAgentStatusResponseModel(BaseModel): 3580 agent_status: AgentStatusModel = Field(alias="AgentStatus") 3581 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3584class EmptyResponseMetadataModel(BaseModel): 3585 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3588class GetContactAttributesResponseModel(BaseModel): 3589 attributes: Dict[str, str] = Field(alias="Attributes") 3590 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3593class ListAgentStatusResponseModel(BaseModel): 3594 next_token: str = Field(alias="NextToken") 3595 agent_status_summary_list: List[AgentStatusSummaryModel] = Field( 3596 alias="AgentStatusSummaryList" 3597 ) 3598 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3601class ListApprovedOriginsResponseModel(BaseModel): 3602 origins: List[str] = Field(alias="Origins") 3603 next_token: str = Field(alias="NextToken") 3604 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3607class ListLambdaFunctionsResponseModel(BaseModel): 3608 lambda_functions: List[str] = Field(alias="LambdaFunctions") 3609 next_token: str = Field(alias="NextToken") 3610 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3613class ListLexBotsResponseModel(BaseModel): 3614 lex_bots: List[LexBotModel] = Field(alias="LexBots") 3615 next_token: str = Field(alias="NextToken") 3616 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3619class ListSecurityProfilePermissionsResponseModel(BaseModel): 3620 permissions: List[str] = Field(alias="Permissions") 3621 next_token: str = Field(alias="NextToken") 3622 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3625class ListTagsForResourceResponseModel(BaseModel): 3626 tags: Dict[str, str] = Field(alias="tags") 3627 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3630class MonitorContactResponseModel(BaseModel): 3631 contact_id: str = Field(alias="ContactId") 3632 contact_arn: str = Field(alias="ContactArn") 3633 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3636class ReplicateInstanceResponseModel(BaseModel): 3637 id: str = Field(alias="Id") 3638 arn: str = Field(alias="Arn") 3639 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3642class StartChatContactResponseModel(BaseModel): 3643 contact_id: str = Field(alias="ContactId") 3644 participant_id: str = Field(alias="ParticipantId") 3645 participant_token: str = Field(alias="ParticipantToken") 3646 continued_from_contact_id: str = Field(alias="ContinuedFromContactId") 3647 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3650class StartContactStreamingResponseModel(BaseModel): 3651 streaming_id: str = Field(alias="StreamingId") 3652 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3655class StartOutboundVoiceContactResponseModel(BaseModel): 3656 contact_id: str = Field(alias="ContactId") 3657 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3660class StartTaskContactResponseModel(BaseModel): 3661 contact_id: str = Field(alias="ContactId") 3662 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3665class TransferContactResponseModel(BaseModel): 3666 contact_id: str = Field(alias="ContactId") 3667 contact_arn: str = Field(alias="ContactArn") 3668 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3671class UpdatePhoneNumberResponseModel(BaseModel): 3672 phone_number_id: str = Field(alias="PhoneNumberId") 3673 phone_number_arn: str = Field(alias="PhoneNumberArn") 3674 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3677class DescribeInstanceAttributeResponseModel(BaseModel): 3678 attribute: AttributeModel = Field(alias="Attribute") 3679 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3682class ListInstanceAttributesResponseModel(BaseModel): 3683 attributes: List[AttributeModel] = Field(alias="Attributes") 3684 next_token: str = Field(alias="NextToken") 3685 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3688class SearchAvailablePhoneNumbersResponseModel(BaseModel): 3689 next_token: str = Field(alias="NextToken") 3690 available_numbers_list: List[AvailableNumberSummaryModel] = Field( 3691 alias="AvailableNumbersList" 3692 ) 3693 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3696class StartContactStreamingRequestModel(BaseModel): 3697 instance_id: str = Field(alias="InstanceId") 3698 contact_id: str = Field(alias="ContactId") 3699 chat_streaming_configuration: ChatStreamingConfigurationModel = Field( 3700 alias="ChatStreamingConfiguration" 3701 ) 3702 client_token: str = Field(alias="ClientToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3705class ClaimedPhoneNumberSummaryModel(BaseModel): 3706 phone_number_id: Optional[str] = Field(default=None, alias="PhoneNumberId") 3707 phone_number_arn: Optional[str] = Field(default=None, alias="PhoneNumberArn") 3708 phone_number: Optional[str] = Field(default=None, alias="PhoneNumber") 3709 phone_number_country_code: Optional[ 3710 Literal[ 3711 "AD", 3712 "AE", 3713 "AF", 3714 "AG", 3715 "AI", 3716 "AL", 3717 "AM", 3718 "AN", 3719 "AO", 3720 "AQ", 3721 "AR", 3722 "AS", 3723 "AT", 3724 "AU", 3725 "AW", 3726 "AZ", 3727 "BA", 3728 "BB", 3729 "BD", 3730 "BE", 3731 "BF", 3732 "BG", 3733 "BH", 3734 "BI", 3735 "BJ", 3736 "BL", 3737 "BM", 3738 "BN", 3739 "BO", 3740 "BR", 3741 "BS", 3742 "BT", 3743 "BW", 3744 "BY", 3745 "BZ", 3746 "CA", 3747 "CC", 3748 "CD", 3749 "CF", 3750 "CG", 3751 "CH", 3752 "CI", 3753 "CK", 3754 "CL", 3755 "CM", 3756 "CN", 3757 "CO", 3758 "CR", 3759 "CU", 3760 "CV", 3761 "CW", 3762 "CX", 3763 "CY", 3764 "CZ", 3765 "DE", 3766 "DJ", 3767 "DK", 3768 "DM", 3769 "DO", 3770 "DZ", 3771 "EC", 3772 "EE", 3773 "EG", 3774 "EH", 3775 "ER", 3776 "ES", 3777 "ET", 3778 "FI", 3779 "FJ", 3780 "FK", 3781 "FM", 3782 "FO", 3783 "FR", 3784 "GA", 3785 "GB", 3786 "GD", 3787 "GE", 3788 "GG", 3789 "GH", 3790 "GI", 3791 "GL", 3792 "GM", 3793 "GN", 3794 "GQ", 3795 "GR", 3796 "GT", 3797 "GU", 3798 "GW", 3799 "GY", 3800 "HK", 3801 "HN", 3802 "HR", 3803 "HT", 3804 "HU", 3805 "ID", 3806 "IE", 3807 "IL", 3808 "IM", 3809 "IN", 3810 "Type[IO]", 3811 "IQ", 3812 "IR", 3813 "IS", 3814 "IT", 3815 "JE", 3816 "JM", 3817 "JO", 3818 "JP", 3819 "KE", 3820 "KG", 3821 "KH", 3822 "KI", 3823 "KM", 3824 "KN", 3825 "KP", 3826 "KR", 3827 "KW", 3828 "KY", 3829 "KZ", 3830 "LA", 3831 "LB", 3832 "LC", 3833 "LI", 3834 "LK", 3835 "LR", 3836 "LS", 3837 "LT", 3838 "LU", 3839 "LV", 3840 "LY", 3841 "MA", 3842 "MC", 3843 "MD", 3844 "ME", 3845 "MF", 3846 "MG", 3847 "MH", 3848 "MK", 3849 "ML", 3850 "MM", 3851 "MN", 3852 "MO", 3853 "MP", 3854 "MR", 3855 "MS", 3856 "MT", 3857 "MU", 3858 "MV", 3859 "MW", 3860 "MX", 3861 "MY", 3862 "MZ", 3863 "NA", 3864 "NC", 3865 "NE", 3866 "NG", 3867 "NI", 3868 "NL", 3869 "NO", 3870 "NP", 3871 "NR", 3872 "NU", 3873 "NZ", 3874 "OM", 3875 "PA", 3876 "PE", 3877 "PF", 3878 "PG", 3879 "PH", 3880 "PK", 3881 "PL", 3882 "PM", 3883 "PN", 3884 "PR", 3885 "PT", 3886 "PW", 3887 "PY", 3888 "QA", 3889 "RE", 3890 "RO", 3891 "RS", 3892 "RU", 3893 "RW", 3894 "SA", 3895 "SB", 3896 "SC", 3897 "SD", 3898 "SE", 3899 "SG", 3900 "SH", 3901 "SI", 3902 "SJ", 3903 "SK", 3904 "SL", 3905 "SM", 3906 "SN", 3907 "SO", 3908 "SR", 3909 "ST", 3910 "SV", 3911 "SX", 3912 "SY", 3913 "SZ", 3914 "TC", 3915 "TD", 3916 "TG", 3917 "TH", 3918 "TJ", 3919 "TK", 3920 "TL", 3921 "TM", 3922 "TN", 3923 "TO", 3924 "TR", 3925 "TT", 3926 "TV", 3927 "TW", 3928 "TZ", 3929 "UA", 3930 "UG", 3931 "US", 3932 "UY", 3933 "UZ", 3934 "VA", 3935 "VC", 3936 "VE", 3937 "VG", 3938 "VI", 3939 "VN", 3940 "VU", 3941 "WF", 3942 "WS", 3943 "YE", 3944 "YT", 3945 "ZA", 3946 "ZM", 3947 "ZW", 3948 ] 3949 ] = Field(default=None, alias="PhoneNumberCountryCode") 3950 phone_number_type: Optional[Literal["DID", "TOLL_FREE"]] = Field( 3951 default=None, alias="PhoneNumberType" 3952 ) 3953 phone_number_description: Optional[str] = Field( 3954 default=None, alias="PhoneNumberDescription" 3955 ) 3956 target_arn: Optional[str] = Field(default=None, alias="TargetArn") 3957 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 3958 phone_number_status: Optional[PhoneNumberStatusModel] = Field( 3959 default=None, alias="PhoneNumberStatus" 3960 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3963class UserDataFiltersModel(BaseModel): 3964 queues: Optional[Sequence[str]] = Field(default=None, alias="Queues") 3965 contact_filter: Optional[ContactFilterModel] = Field( 3966 default=None, alias="ContactFilter" 3967 ) 3968 routing_profiles: Optional[Sequence[str]] = Field( 3969 default=None, alias="RoutingProfiles" 3970 ) 3971 agents: Optional[Sequence[str]] = Field(default=None, alias="Agents") 3972 user_hierarchy_groups: Optional[Sequence[str]] = Field( 3973 default=None, alias="UserHierarchyGroups" 3974 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3977class ListContactFlowModulesResponseModel(BaseModel): 3978 contact_flow_modules_summary_list: List[ContactFlowModuleSummaryModel] = Field( 3979 alias="ContactFlowModulesSummaryList" 3980 ) 3981 next_token: str = Field(alias="NextToken") 3982 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3985class DescribeContactFlowModuleResponseModel(BaseModel): 3986 contact_flow_module: ContactFlowModuleModel = Field(alias="ContactFlowModule") 3987 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3990class ListContactFlowsResponseModel(BaseModel): 3991 contact_flow_summary_list: List[ContactFlowSummaryModel] = Field( 3992 alias="ContactFlowSummaryList" 3993 ) 3994 next_token: str = Field(alias="NextToken") 3995 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
3998class DescribeContactFlowResponseModel(BaseModel): 3999 contact_flow: ContactFlowModel = Field(alias="ContactFlow") 4000 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4003class ContactModel(BaseModel): 4004 arn: Optional[str] = Field(default=None, alias="Arn") 4005 id: Optional[str] = Field(default=None, alias="Id") 4006 initial_contact_id: Optional[str] = Field(default=None, alias="InitialContactId") 4007 previous_contact_id: Optional[str] = Field(default=None, alias="PreviousContactId") 4008 initiation_method: Optional[ 4009 Literal[ 4010 "API", 4011 "CALLBACK", 4012 "DISCONNECT", 4013 "INBOUND", 4014 "MONITOR", 4015 "OUTBOUND", 4016 "QUEUE_TRANSFER", 4017 "TRANSFER", 4018 ] 4019 ] = Field(default=None, alias="InitiationMethod") 4020 name: Optional[str] = Field(default=None, alias="Name") 4021 description: Optional[str] = Field(default=None, alias="Description") 4022 channel: Optional[Literal["CHAT", "TASK", "VOICE"]] = Field( 4023 default=None, alias="Channel" 4024 ) 4025 queue_info: Optional[QueueInfoModel] = Field(default=None, alias="QueueInfo") 4026 agent_info: Optional[AgentInfoModel] = Field(default=None, alias="AgentInfo") 4027 initiation_timestamp: Optional[datetime] = Field( 4028 default=None, alias="InitiationTimestamp" 4029 ) 4030 disconnect_timestamp: Optional[datetime] = Field( 4031 default=None, alias="DisconnectTimestamp" 4032 ) 4033 last_update_timestamp: Optional[datetime] = Field( 4034 default=None, alias="LastUpdateTimestamp" 4035 ) 4036 scheduled_timestamp: Optional[datetime] = Field( 4037 default=None, alias="ScheduledTimestamp" 4038 ) 4039 related_contact_id: Optional[str] = Field(default=None, alias="RelatedContactId") 4040 wisdom_info: Optional[WisdomInfoModel] = Field(default=None, alias="WisdomInfo")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4043class ControlPlaneTagFilterModel(BaseModel): 4044 or_conditions: Optional[Sequence[Sequence[TagConditionModel]]] = Field( 4045 default=None, alias="OrConditions" 4046 ) 4047 and_conditions: Optional[Sequence[TagConditionModel]] = Field( 4048 default=None, alias="AndConditions" 4049 ) 4050 tag_condition: Optional[TagConditionModel] = Field( 4051 default=None, alias="TagCondition" 4052 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4055class CreateQueueRequestModel(BaseModel): 4056 instance_id: str = Field(alias="InstanceId") 4057 name: str = Field(alias="Name") 4058 hours_of_operation_id: str = Field(alias="HoursOfOperationId") 4059 description: Optional[str] = Field(default=None, alias="Description") 4060 outbound_caller_config: Optional[OutboundCallerConfigModel] = Field( 4061 default=None, alias="OutboundCallerConfig" 4062 ) 4063 max_contacts: Optional[int] = Field(default=None, alias="MaxContacts") 4064 quick_connect_ids: Optional[Sequence[str]] = Field( 4065 default=None, alias="QuickConnectIds" 4066 ) 4067 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4070class QueueModel(BaseModel): 4071 name: Optional[str] = Field(default=None, alias="Name") 4072 queue_arn: Optional[str] = Field(default=None, alias="QueueArn") 4073 queue_id: Optional[str] = Field(default=None, alias="QueueId") 4074 description: Optional[str] = Field(default=None, alias="Description") 4075 outbound_caller_config: Optional[OutboundCallerConfigModel] = Field( 4076 default=None, alias="OutboundCallerConfig" 4077 ) 4078 hours_of_operation_id: Optional[str] = Field( 4079 default=None, alias="HoursOfOperationId" 4080 ) 4081 max_contacts: Optional[int] = Field(default=None, alias="MaxContacts") 4082 status: Optional[Literal["DISABLED", "ENABLED"]] = Field( 4083 default=None, alias="Status" 4084 ) 4085 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4088class UpdateQueueOutboundCallerConfigRequestModel(BaseModel): 4089 instance_id: str = Field(alias="InstanceId") 4090 queue_id: str = Field(alias="QueueId") 4091 outbound_caller_config: OutboundCallerConfigModel = Field( 4092 alias="OutboundCallerConfig" 4093 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4096class RoutingProfileModel(BaseModel): 4097 instance_id: Optional[str] = Field(default=None, alias="InstanceId") 4098 name: Optional[str] = Field(default=None, alias="Name") 4099 routing_profile_arn: Optional[str] = Field(default=None, alias="RoutingProfileArn") 4100 routing_profile_id: Optional[str] = Field(default=None, alias="RoutingProfileId") 4101 description: Optional[str] = Field(default=None, alias="Description") 4102 media_concurrencies: Optional[List[MediaConcurrencyModel]] = Field( 4103 default=None, alias="MediaConcurrencies" 4104 ) 4105 default_outbound_queue_id: Optional[str] = Field( 4106 default=None, alias="DefaultOutboundQueueId" 4107 ) 4108 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 4109 number_of_associated_queues: Optional[int] = Field( 4110 default=None, alias="NumberOfAssociatedQueues" 4111 ) 4112 number_of_associated_users: Optional[int] = Field( 4113 default=None, alias="NumberOfAssociatedUsers" 4114 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4117class UpdateRoutingProfileConcurrencyRequestModel(BaseModel): 4118 instance_id: str = Field(alias="InstanceId") 4119 routing_profile_id: str = Field(alias="RoutingProfileId") 4120 media_concurrencies: Sequence[MediaConcurrencyModel] = Field( 4121 alias="MediaConcurrencies" 4122 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4125class UpdateUserIdentityInfoRequestModel(BaseModel): 4126 identity_info: UserIdentityInfoModel = Field(alias="IdentityInfo") 4127 user_id: str = Field(alias="UserId") 4128 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4131class CreateUserRequestModel(BaseModel): 4132 username: str = Field(alias="Username") 4133 phone_config: UserPhoneConfigModel = Field(alias="PhoneConfig") 4134 security_profile_ids: Sequence[str] = Field(alias="SecurityProfileIds") 4135 routing_profile_id: str = Field(alias="RoutingProfileId") 4136 instance_id: str = Field(alias="InstanceId") 4137 password: Optional[str] = Field(default=None, alias="Password") 4138 identity_info: Optional[UserIdentityInfoModel] = Field( 4139 default=None, alias="IdentityInfo" 4140 ) 4141 directory_user_id: Optional[str] = Field(default=None, alias="DirectoryUserId") 4142 hierarchy_group_id: Optional[str] = Field(default=None, alias="HierarchyGroupId") 4143 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4146class UpdateUserPhoneConfigRequestModel(BaseModel): 4147 phone_config: UserPhoneConfigModel = Field(alias="PhoneConfig") 4148 user_id: str = Field(alias="UserId") 4149 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4152class UserModel(BaseModel): 4153 id: Optional[str] = Field(default=None, alias="Id") 4154 arn: Optional[str] = Field(default=None, alias="Arn") 4155 username: Optional[str] = Field(default=None, alias="Username") 4156 identity_info: Optional[UserIdentityInfoModel] = Field( 4157 default=None, alias="IdentityInfo" 4158 ) 4159 phone_config: Optional[UserPhoneConfigModel] = Field( 4160 default=None, alias="PhoneConfig" 4161 ) 4162 directory_user_id: Optional[str] = Field(default=None, alias="DirectoryUserId") 4163 security_profile_ids: Optional[List[str]] = Field( 4164 default=None, alias="SecurityProfileIds" 4165 ) 4166 routing_profile_id: Optional[str] = Field(default=None, alias="RoutingProfileId") 4167 hierarchy_group_id: Optional[str] = Field(default=None, alias="HierarchyGroupId") 4168 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4171class GetFederationTokenResponseModel(BaseModel): 4172 credentials: CredentialsModel = Field(alias="Credentials") 4173 sign_in_url: str = Field(alias="SignInUrl") 4174 user_arn: str = Field(alias="UserArn") 4175 user_id: str = Field(alias="UserId") 4176 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4179class CurrentMetricDataModel(BaseModel): 4180 metric: Optional[CurrentMetricModel] = Field(default=None, alias="Metric") 4181 value: Optional[float] = Field(default=None, alias="Value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4184class ListDefaultVocabulariesResponseModel(BaseModel): 4185 default_vocabulary_list: List[DefaultVocabularyModel] = Field( 4186 alias="DefaultVocabularyList" 4187 ) 4188 next_token: str = Field(alias="NextToken") 4189 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4192class DescribeSecurityProfileResponseModel(BaseModel): 4193 security_profile: SecurityProfileModel = Field(alias="SecurityProfile") 4194 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4197class DescribeTrafficDistributionGroupResponseModel(BaseModel): 4198 traffic_distribution_group: TrafficDistributionGroupModel = Field( 4199 alias="TrafficDistributionGroup" 4200 ) 4201 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4204class DescribeVocabularyResponseModel(BaseModel): 4205 vocabulary: VocabularyModel = Field(alias="Vocabulary") 4206 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4209class DimensionsModel(BaseModel): 4210 queue: Optional[QueueReferenceModel] = Field(default=None, alias="Queue") 4211 channel: Optional[Literal["CHAT", "TASK", "VOICE"]] = Field( 4212 default=None, alias="Channel" 4213 ) 4214 routing_profile: Optional[RoutingProfileReferenceModel] = Field( 4215 default=None, alias="RoutingProfile" 4216 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4219class DisassociateRoutingProfileQueuesRequestModel(BaseModel): 4220 instance_id: str = Field(alias="InstanceId") 4221 routing_profile_id: str = Field(alias="RoutingProfileId") 4222 queue_references: Sequence[RoutingProfileQueueReferenceModel] = Field( 4223 alias="QueueReferences" 4224 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4227class RoutingProfileQueueConfigModel(BaseModel): 4228 queue_reference: RoutingProfileQueueReferenceModel = Field(alias="QueueReference") 4229 priority: int = Field(alias="Priority") 4230 delay: int = Field(alias="Delay")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4233class TelephonyConfigModel(BaseModel): 4234 distributions: List[DistributionModel] = Field(alias="Distributions")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4237class KinesisVideoStreamConfigModel(BaseModel): 4238 prefix: str = Field(alias="Prefix") 4239 retention_period_hours: int = Field(alias="RetentionPeriodHours") 4240 encryption_config: EncryptionConfigModel = Field(alias="EncryptionConfig")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4243class S3ConfigModel(BaseModel): 4244 bucket_name: str = Field(alias="BucketName") 4245 bucket_prefix: str = Field(alias="BucketPrefix") 4246 encryption_config: Optional[EncryptionConfigModel] = Field( 4247 default=None, alias="EncryptionConfig" 4248 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4251class GetCurrentMetricDataRequestModel(BaseModel): 4252 instance_id: str = Field(alias="InstanceId") 4253 filters: FiltersModel = Field(alias="Filters") 4254 current_metrics: Sequence[CurrentMetricModel] = Field(alias="CurrentMetrics") 4255 groupings: Optional[ 4256 Sequence[Literal["CHANNEL", "QUEUE", "ROUTING_PROFILE"]] 4257 ] = Field(default=None, alias="Groupings") 4258 next_token: Optional[str] = Field(default=None, alias="NextToken") 4259 max_results: Optional[int] = Field(default=None, alias="MaxResults") 4260 sort_criteria: Optional[Sequence[CurrentMetricSortCriteriaModel]] = Field( 4261 default=None, alias="SortCriteria" 4262 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4265class ListAgentStatusRequestListAgentStatusesPaginateModel(BaseModel): 4266 instance_id: str = Field(alias="InstanceId") 4267 agent_status_types: Optional[ 4268 Sequence[Literal["CUSTOM", "OFFLINE", "ROUTABLE"]] 4269 ] = Field(default=None, alias="AgentStatusTypes") 4270 pagination_config: Optional[PaginatorConfigModel] = Field( 4271 default=None, alias="PaginationConfig" 4272 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListApprovedOriginsRequestListApprovedOriginsPaginateModel(mypydantic.models.base_model.BaseModel):
4275class ListApprovedOriginsRequestListApprovedOriginsPaginateModel(BaseModel): 4276 instance_id: str = Field(alias="InstanceId") 4277 pagination_config: Optional[PaginatorConfigModel] = Field( 4278 default=None, alias="PaginationConfig" 4279 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4282class ListBotsRequestListBotsPaginateModel(BaseModel): 4283 instance_id: str = Field(alias="InstanceId") 4284 lex_version: Literal["V1", "V2"] = Field(alias="LexVersion") 4285 pagination_config: Optional[PaginatorConfigModel] = Field( 4286 default=None, alias="PaginationConfig" 4287 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListContactFlowModulesRequestListContactFlowModulesPaginateModel(mypydantic.models.base_model.BaseModel):
4290class ListContactFlowModulesRequestListContactFlowModulesPaginateModel(BaseModel): 4291 instance_id: str = Field(alias="InstanceId") 4292 contact_flow_module_state: Optional[Literal["ACTIVE", "ARCHIVED"]] = Field( 4293 default=None, alias="ContactFlowModuleState" 4294 ) 4295 pagination_config: Optional[PaginatorConfigModel] = Field( 4296 default=None, alias="PaginationConfig" 4297 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4300class ListContactFlowsRequestListContactFlowsPaginateModel(BaseModel): 4301 instance_id: str = Field(alias="InstanceId") 4302 contact_flow_types: Optional[ 4303 Sequence[ 4304 Literal[ 4305 "AGENT_HOLD", 4306 "AGENT_TRANSFER", 4307 "AGENT_WHISPER", 4308 "CONTACT_FLOW", 4309 "CUSTOMER_HOLD", 4310 "CUSTOMER_QUEUE", 4311 "CUSTOMER_WHISPER", 4312 "OUTBOUND_WHISPER", 4313 "QUEUE_TRANSFER", 4314 ] 4315 ] 4316 ] = Field(default=None, alias="ContactFlowTypes") 4317 pagination_config: Optional[PaginatorConfigModel] = Field( 4318 default=None, alias="PaginationConfig" 4319 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListContactReferencesRequestListContactReferencesPaginateModel(mypydantic.models.base_model.BaseModel):
4322class ListContactReferencesRequestListContactReferencesPaginateModel(BaseModel): 4323 instance_id: str = Field(alias="InstanceId") 4324 contact_id: str = Field(alias="ContactId") 4325 reference_types: Sequence[ 4326 Literal["ATTACHMENT", "DATE", "EMAIL", "NUMBER", "STRING", "URL"] 4327 ] = Field(alias="ReferenceTypes") 4328 pagination_config: Optional[PaginatorConfigModel] = Field( 4329 default=None, alias="PaginationConfig" 4330 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateModel(mypydantic.models.base_model.BaseModel):
4333class ListDefaultVocabulariesRequestListDefaultVocabulariesPaginateModel(BaseModel): 4334 instance_id: str = Field(alias="InstanceId") 4335 language_code: Optional[ 4336 Literal[ 4337 "ar-AE", 4338 "de-CH", 4339 "de-DE", 4340 "en-AB", 4341 "en-AU", 4342 "en-GB", 4343 "en-IE", 4344 "en-IN", 4345 "en-NZ", 4346 "en-US", 4347 "en-WL", 4348 "en-ZA", 4349 "es-ES", 4350 "es-US", 4351 "fr-CA", 4352 "fr-FR", 4353 "hi-IN", 4354 "it-IT", 4355 "ja-JP", 4356 "ko-KR", 4357 "pt-BR", 4358 "pt-PT", 4359 "zh-CN", 4360 ] 4361 ] = Field(default=None, alias="LanguageCode") 4362 pagination_config: Optional[PaginatorConfigModel] = Field( 4363 default=None, alias="PaginationConfig" 4364 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListHoursOfOperationsRequestListHoursOfOperationsPaginateModel(mypydantic.models.base_model.BaseModel):
4367class ListHoursOfOperationsRequestListHoursOfOperationsPaginateModel(BaseModel): 4368 instance_id: str = Field(alias="InstanceId") 4369 pagination_config: Optional[PaginatorConfigModel] = Field( 4370 default=None, alias="PaginationConfig" 4371 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListInstanceAttributesRequestListInstanceAttributesPaginateModel(mypydantic.models.base_model.BaseModel):
4374class ListInstanceAttributesRequestListInstanceAttributesPaginateModel(BaseModel): 4375 instance_id: str = Field(alias="InstanceId") 4376 pagination_config: Optional[PaginatorConfigModel] = Field( 4377 default=None, alias="PaginationConfig" 4378 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateModel(mypydantic.models.base_model.BaseModel):
4381class ListInstanceStorageConfigsRequestListInstanceStorageConfigsPaginateModel( 4382 BaseModel 4383): 4384 instance_id: str = Field(alias="InstanceId") 4385 resource_type: Literal[ 4386 "AGENT_EVENTS", 4387 "ATTACHMENTS", 4388 "CALL_RECORDINGS", 4389 "CHAT_TRANSCRIPTS", 4390 "CONTACT_EVALUATIONS", 4391 "CONTACT_TRACE_RECORDS", 4392 "MEDIA_STREAMS", 4393 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 4394 "SCHEDULED_REPORTS", 4395 ] = Field(alias="ResourceType") 4396 pagination_config: Optional[PaginatorConfigModel] = Field( 4397 default=None, alias="PaginationConfig" 4398 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4401class ListInstancesRequestListInstancesPaginateModel(BaseModel): 4402 pagination_config: Optional[PaginatorConfigModel] = Field( 4403 default=None, alias="PaginationConfig" 4404 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateModel(mypydantic.models.base_model.BaseModel):
4407class ListIntegrationAssociationsRequestListIntegrationAssociationsPaginateModel( 4408 BaseModel 4409): 4410 instance_id: str = Field(alias="InstanceId") 4411 integration_type: Optional[ 4412 Literal[ 4413 "CASES_DOMAIN", 4414 "EVENT", 4415 "PINPOINT_APP", 4416 "VOICE_ID", 4417 "WISDOM_ASSISTANT", 4418 "WISDOM_KNOWLEDGE_BASE", 4419 ] 4420 ] = Field(default=None, alias="IntegrationType") 4421 pagination_config: Optional[PaginatorConfigModel] = Field( 4422 default=None, alias="PaginationConfig" 4423 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListLambdaFunctionsRequestListLambdaFunctionsPaginateModel(mypydantic.models.base_model.BaseModel):
4426class ListLambdaFunctionsRequestListLambdaFunctionsPaginateModel(BaseModel): 4427 instance_id: str = Field(alias="InstanceId") 4428 pagination_config: Optional[PaginatorConfigModel] = Field( 4429 default=None, alias="PaginationConfig" 4430 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4433class ListLexBotsRequestListLexBotsPaginateModel(BaseModel): 4434 instance_id: str = Field(alias="InstanceId") 4435 pagination_config: Optional[PaginatorConfigModel] = Field( 4436 default=None, alias="PaginationConfig" 4437 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4440class ListPhoneNumbersRequestListPhoneNumbersPaginateModel(BaseModel): 4441 instance_id: str = Field(alias="InstanceId") 4442 phone_number_types: Optional[Sequence[Literal["DID", "TOLL_FREE"]]] = Field( 4443 default=None, alias="PhoneNumberTypes" 4444 ) 4445 phone_number_country_codes: Optional[ 4446 Sequence[ 4447 Literal[ 4448 "AD", 4449 "AE", 4450 "AF", 4451 "AG", 4452 "AI", 4453 "AL", 4454 "AM", 4455 "AN", 4456 "AO", 4457 "AQ", 4458 "AR", 4459 "AS", 4460 "AT", 4461 "AU", 4462 "AW", 4463 "AZ", 4464 "BA", 4465 "BB", 4466 "BD", 4467 "BE", 4468 "BF", 4469 "BG", 4470 "BH", 4471 "BI", 4472 "BJ", 4473 "BL", 4474 "BM", 4475 "BN", 4476 "BO", 4477 "BR", 4478 "BS", 4479 "BT", 4480 "BW", 4481 "BY", 4482 "BZ", 4483 "CA", 4484 "CC", 4485 "CD", 4486 "CF", 4487 "CG", 4488 "CH", 4489 "CI", 4490 "CK", 4491 "CL", 4492 "CM", 4493 "CN", 4494 "CO", 4495 "CR", 4496 "CU", 4497 "CV", 4498 "CW", 4499 "CX", 4500 "CY", 4501 "CZ", 4502 "DE", 4503 "DJ", 4504 "DK", 4505 "DM", 4506 "DO", 4507 "DZ", 4508 "EC", 4509 "EE", 4510 "EG", 4511 "EH", 4512 "ER", 4513 "ES", 4514 "ET", 4515 "FI", 4516 "FJ", 4517 "FK", 4518 "FM", 4519 "FO", 4520 "FR", 4521 "GA", 4522 "GB", 4523 "GD", 4524 "GE", 4525 "GG", 4526 "GH", 4527 "GI", 4528 "GL", 4529 "GM", 4530 "GN", 4531 "GQ", 4532 "GR", 4533 "GT", 4534 "GU", 4535 "GW", 4536 "GY", 4537 "HK", 4538 "HN", 4539 "HR", 4540 "HT", 4541 "HU", 4542 "ID", 4543 "IE", 4544 "IL", 4545 "IM", 4546 "IN", 4547 "Type[IO]", 4548 "IQ", 4549 "IR", 4550 "IS", 4551 "IT", 4552 "JE", 4553 "JM", 4554 "JO", 4555 "JP", 4556 "KE", 4557 "KG", 4558 "KH", 4559 "KI", 4560 "KM", 4561 "KN", 4562 "KP", 4563 "KR", 4564 "KW", 4565 "KY", 4566 "KZ", 4567 "LA", 4568 "LB", 4569 "LC", 4570 "LI", 4571 "LK", 4572 "LR", 4573 "LS", 4574 "LT", 4575 "LU", 4576 "LV", 4577 "LY", 4578 "MA", 4579 "MC", 4580 "MD", 4581 "ME", 4582 "MF", 4583 "MG", 4584 "MH", 4585 "MK", 4586 "ML", 4587 "MM", 4588 "MN", 4589 "MO", 4590 "MP", 4591 "MR", 4592 "MS", 4593 "MT", 4594 "MU", 4595 "MV", 4596 "MW", 4597 "MX", 4598 "MY", 4599 "MZ", 4600 "NA", 4601 "NC", 4602 "NE", 4603 "NG", 4604 "NI", 4605 "NL", 4606 "NO", 4607 "NP", 4608 "NR", 4609 "NU", 4610 "NZ", 4611 "OM", 4612 "PA", 4613 "PE", 4614 "PF", 4615 "PG", 4616 "PH", 4617 "PK", 4618 "PL", 4619 "PM", 4620 "PN", 4621 "PR", 4622 "PT", 4623 "PW", 4624 "PY", 4625 "QA", 4626 "RE", 4627 "RO", 4628 "RS", 4629 "RU", 4630 "RW", 4631 "SA", 4632 "SB", 4633 "SC", 4634 "SD", 4635 "SE", 4636 "SG", 4637 "SH", 4638 "SI", 4639 "SJ", 4640 "SK", 4641 "SL", 4642 "SM", 4643 "SN", 4644 "SO", 4645 "SR", 4646 "ST", 4647 "SV", 4648 "SX", 4649 "SY", 4650 "SZ", 4651 "TC", 4652 "TD", 4653 "TG", 4654 "TH", 4655 "TJ", 4656 "TK", 4657 "TL", 4658 "TM", 4659 "TN", 4660 "TO", 4661 "TR", 4662 "TT", 4663 "TV", 4664 "TW", 4665 "TZ", 4666 "UA", 4667 "UG", 4668 "US", 4669 "UY", 4670 "UZ", 4671 "VA", 4672 "VC", 4673 "VE", 4674 "VG", 4675 "VI", 4676 "VN", 4677 "VU", 4678 "WF", 4679 "WS", 4680 "YE", 4681 "YT", 4682 "ZA", 4683 "ZM", 4684 "ZW", 4685 ] 4686 ] 4687 ] = Field(default=None, alias="PhoneNumberCountryCodes") 4688 pagination_config: Optional[PaginatorConfigModel] = Field( 4689 default=None, alias="PaginationConfig" 4690 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateModel(mypydantic.models.base_model.BaseModel):
4693class ListPhoneNumbersV2RequestListPhoneNumbersV2PaginateModel(BaseModel): 4694 target_arn: Optional[str] = Field(default=None, alias="TargetArn") 4695 phone_number_country_codes: Optional[ 4696 Sequence[ 4697 Literal[ 4698 "AD", 4699 "AE", 4700 "AF", 4701 "AG", 4702 "AI", 4703 "AL", 4704 "AM", 4705 "AN", 4706 "AO", 4707 "AQ", 4708 "AR", 4709 "AS", 4710 "AT", 4711 "AU", 4712 "AW", 4713 "AZ", 4714 "BA", 4715 "BB", 4716 "BD", 4717 "BE", 4718 "BF", 4719 "BG", 4720 "BH", 4721 "BI", 4722 "BJ", 4723 "BL", 4724 "BM", 4725 "BN", 4726 "BO", 4727 "BR", 4728 "BS", 4729 "BT", 4730 "BW", 4731 "BY", 4732 "BZ", 4733 "CA", 4734 "CC", 4735 "CD", 4736 "CF", 4737 "CG", 4738 "CH", 4739 "CI", 4740 "CK", 4741 "CL", 4742 "CM", 4743 "CN", 4744 "CO", 4745 "CR", 4746 "CU", 4747 "CV", 4748 "CW", 4749 "CX", 4750 "CY", 4751 "CZ", 4752 "DE", 4753 "DJ", 4754 "DK", 4755 "DM", 4756 "DO", 4757 "DZ", 4758 "EC", 4759 "EE", 4760 "EG", 4761 "EH", 4762 "ER", 4763 "ES", 4764 "ET", 4765 "FI", 4766 "FJ", 4767 "FK", 4768 "FM", 4769 "FO", 4770 "FR", 4771 "GA", 4772 "GB", 4773 "GD", 4774 "GE", 4775 "GG", 4776 "GH", 4777 "GI", 4778 "GL", 4779 "GM", 4780 "GN", 4781 "GQ", 4782 "GR", 4783 "GT", 4784 "GU", 4785 "GW", 4786 "GY", 4787 "HK", 4788 "HN", 4789 "HR", 4790 "HT", 4791 "HU", 4792 "ID", 4793 "IE", 4794 "IL", 4795 "IM", 4796 "IN", 4797 "Type[IO]", 4798 "IQ", 4799 "IR", 4800 "IS", 4801 "IT", 4802 "JE", 4803 "JM", 4804 "JO", 4805 "JP", 4806 "KE", 4807 "KG", 4808 "KH", 4809 "KI", 4810 "KM", 4811 "KN", 4812 "KP", 4813 "KR", 4814 "KW", 4815 "KY", 4816 "KZ", 4817 "LA", 4818 "LB", 4819 "LC", 4820 "LI", 4821 "LK", 4822 "LR", 4823 "LS", 4824 "LT", 4825 "LU", 4826 "LV", 4827 "LY", 4828 "MA", 4829 "MC", 4830 "MD", 4831 "ME", 4832 "MF", 4833 "MG", 4834 "MH", 4835 "MK", 4836 "ML", 4837 "MM", 4838 "MN", 4839 "MO", 4840 "MP", 4841 "MR", 4842 "MS", 4843 "MT", 4844 "MU", 4845 "MV", 4846 "MW", 4847 "MX", 4848 "MY", 4849 "MZ", 4850 "NA", 4851 "NC", 4852 "NE", 4853 "NG", 4854 "NI", 4855 "NL", 4856 "NO", 4857 "NP", 4858 "NR", 4859 "NU", 4860 "NZ", 4861 "OM", 4862 "PA", 4863 "PE", 4864 "PF", 4865 "PG", 4866 "PH", 4867 "PK", 4868 "PL", 4869 "PM", 4870 "PN", 4871 "PR", 4872 "PT", 4873 "PW", 4874 "PY", 4875 "QA", 4876 "RE", 4877 "RO", 4878 "RS", 4879 "RU", 4880 "RW", 4881 "SA", 4882 "SB", 4883 "SC", 4884 "SD", 4885 "SE", 4886 "SG", 4887 "SH", 4888 "SI", 4889 "SJ", 4890 "SK", 4891 "SL", 4892 "SM", 4893 "SN", 4894 "SO", 4895 "SR", 4896 "ST", 4897 "SV", 4898 "SX", 4899 "SY", 4900 "SZ", 4901 "TC", 4902 "TD", 4903 "TG", 4904 "TH", 4905 "TJ", 4906 "TK", 4907 "TL", 4908 "TM", 4909 "TN", 4910 "TO", 4911 "TR", 4912 "TT", 4913 "TV", 4914 "TW", 4915 "TZ", 4916 "UA", 4917 "UG", 4918 "US", 4919 "UY", 4920 "UZ", 4921 "VA", 4922 "VC", 4923 "VE", 4924 "VG", 4925 "VI", 4926 "VN", 4927 "VU", 4928 "WF", 4929 "WS", 4930 "YE", 4931 "YT", 4932 "ZA", 4933 "ZM", 4934 "ZW", 4935 ] 4936 ] 4937 ] = Field(default=None, alias="PhoneNumberCountryCodes") 4938 phone_number_types: Optional[Sequence[Literal["DID", "TOLL_FREE"]]] = Field( 4939 default=None, alias="PhoneNumberTypes" 4940 ) 4941 phone_number_prefix: Optional[str] = Field(default=None, alias="PhoneNumberPrefix") 4942 pagination_config: Optional[PaginatorConfigModel] = Field( 4943 default=None, alias="PaginationConfig" 4944 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4947class ListPromptsRequestListPromptsPaginateModel(BaseModel): 4948 instance_id: str = Field(alias="InstanceId") 4949 pagination_config: Optional[PaginatorConfigModel] = Field( 4950 default=None, alias="PaginationConfig" 4951 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateModel(mypydantic.models.base_model.BaseModel):
4954class ListQueueQuickConnectsRequestListQueueQuickConnectsPaginateModel(BaseModel): 4955 instance_id: str = Field(alias="InstanceId") 4956 queue_id: str = Field(alias="QueueId") 4957 pagination_config: Optional[PaginatorConfigModel] = Field( 4958 default=None, alias="PaginationConfig" 4959 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4962class ListQueuesRequestListQueuesPaginateModel(BaseModel): 4963 instance_id: str = Field(alias="InstanceId") 4964 queue_types: Optional[Sequence[Literal["AGENT", "STANDARD"]]] = Field( 4965 default=None, alias="QueueTypes" 4966 ) 4967 pagination_config: Optional[PaginatorConfigModel] = Field( 4968 default=None, alias="PaginationConfig" 4969 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListQuickConnectsRequestListQuickConnectsPaginateModel(mypydantic.models.base_model.BaseModel):
4972class ListQuickConnectsRequestListQuickConnectsPaginateModel(BaseModel): 4973 instance_id: str = Field(alias="InstanceId") 4974 quick_connect_types: Optional[ 4975 Sequence[Literal["PHONE_NUMBER", "QUEUE", "USER"]] 4976 ] = Field(default=None, alias="QuickConnectTypes") 4977 pagination_config: Optional[PaginatorConfigModel] = Field( 4978 default=None, alias="PaginationConfig" 4979 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateModel(mypydantic.models.base_model.BaseModel):
4982class ListRoutingProfileQueuesRequestListRoutingProfileQueuesPaginateModel(BaseModel): 4983 instance_id: str = Field(alias="InstanceId") 4984 routing_profile_id: str = Field(alias="RoutingProfileId") 4985 pagination_config: Optional[PaginatorConfigModel] = Field( 4986 default=None, alias="PaginationConfig" 4987 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListRoutingProfilesRequestListRoutingProfilesPaginateModel(mypydantic.models.base_model.BaseModel):
4990class ListRoutingProfilesRequestListRoutingProfilesPaginateModel(BaseModel): 4991 instance_id: str = Field(alias="InstanceId") 4992 pagination_config: Optional[PaginatorConfigModel] = Field( 4993 default=None, alias="PaginationConfig" 4994 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
4997class ListRulesRequestListRulesPaginateModel(BaseModel): 4998 instance_id: str = Field(alias="InstanceId") 4999 publish_status: Optional[Literal["DRAFT", "PUBLISHED"]] = Field( 5000 default=None, alias="PublishStatus" 5001 ) 5002 event_source_name: Optional[ 5003 Literal[ 5004 "OnPostCallAnalysisAvailable", 5005 "OnPostChatAnalysisAvailable", 5006 "OnRealTimeCallAnalysisAvailable", 5007 "OnSalesforceCaseCreate", 5008 "OnZendeskTicketCreate", 5009 "OnZendeskTicketStatusUpdate", 5010 ] 5011 ] = Field(default=None, alias="EventSourceName") 5012 pagination_config: Optional[PaginatorConfigModel] = Field( 5013 default=None, alias="PaginationConfig" 5014 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5017class ListSecurityKeysRequestListSecurityKeysPaginateModel(BaseModel): 5018 instance_id: str = Field(alias="InstanceId") 5019 pagination_config: Optional[PaginatorConfigModel] = Field( 5020 default=None, alias="PaginationConfig" 5021 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateModel(mypydantic.models.base_model.BaseModel):
5024class ListSecurityProfilePermissionsRequestListSecurityProfilePermissionsPaginateModel( 5025 BaseModel 5026): 5027 security_profile_id: str = Field(alias="SecurityProfileId") 5028 instance_id: str = Field(alias="InstanceId") 5029 pagination_config: Optional[PaginatorConfigModel] = Field( 5030 default=None, alias="PaginationConfig" 5031 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListSecurityProfilesRequestListSecurityProfilesPaginateModel(mypydantic.models.base_model.BaseModel):
5034class ListSecurityProfilesRequestListSecurityProfilesPaginateModel(BaseModel): 5035 instance_id: str = Field(alias="InstanceId") 5036 pagination_config: Optional[PaginatorConfigModel] = Field( 5037 default=None, alias="PaginationConfig" 5038 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListTaskTemplatesRequestListTaskTemplatesPaginateModel(mypydantic.models.base_model.BaseModel):
5041class ListTaskTemplatesRequestListTaskTemplatesPaginateModel(BaseModel): 5042 instance_id: str = Field(alias="InstanceId") 5043 status: Optional[Literal["ACTIVE", "INACTIVE"]] = Field( 5044 default=None, alias="Status" 5045 ) 5046 name: Optional[str] = Field(default=None, alias="Name") 5047 pagination_config: Optional[PaginatorConfigModel] = Field( 5048 default=None, alias="PaginationConfig" 5049 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateModel(mypydantic.models.base_model.BaseModel):
5052class ListTrafficDistributionGroupsRequestListTrafficDistributionGroupsPaginateModel( 5053 BaseModel 5054): 5055 instance_id: Optional[str] = Field(default=None, alias="InstanceId") 5056 pagination_config: Optional[PaginatorConfigModel] = Field( 5057 default=None, alias="PaginationConfig" 5058 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5061class ListUseCasesRequestListUseCasesPaginateModel(BaseModel): 5062 instance_id: str = Field(alias="InstanceId") 5063 integration_association_id: str = Field(alias="IntegrationAssociationId") 5064 pagination_config: Optional[PaginatorConfigModel] = Field( 5065 default=None, alias="PaginationConfig" 5066 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateModel(mypydantic.models.base_model.BaseModel):
5069class ListUserHierarchyGroupsRequestListUserHierarchyGroupsPaginateModel(BaseModel): 5070 instance_id: str = Field(alias="InstanceId") 5071 pagination_config: Optional[PaginatorConfigModel] = Field( 5072 default=None, alias="PaginationConfig" 5073 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5076class ListUsersRequestListUsersPaginateModel(BaseModel): 5077 instance_id: str = Field(alias="InstanceId") 5078 pagination_config: Optional[PaginatorConfigModel] = Field( 5079 default=None, alias="PaginationConfig" 5080 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateModel(mypydantic.models.base_model.BaseModel):
5083class SearchAvailablePhoneNumbersRequestSearchAvailablePhoneNumbersPaginateModel( 5084 BaseModel 5085): 5086 target_arn: str = Field(alias="TargetArn") 5087 phone_number_country_code: Literal[ 5088 "AD", 5089 "AE", 5090 "AF", 5091 "AG", 5092 "AI", 5093 "AL", 5094 "AM", 5095 "AN", 5096 "AO", 5097 "AQ", 5098 "AR", 5099 "AS", 5100 "AT", 5101 "AU", 5102 "AW", 5103 "AZ", 5104 "BA", 5105 "BB", 5106 "BD", 5107 "BE", 5108 "BF", 5109 "BG", 5110 "BH", 5111 "BI", 5112 "BJ", 5113 "BL", 5114 "BM", 5115 "BN", 5116 "BO", 5117 "BR", 5118 "BS", 5119 "BT", 5120 "BW", 5121 "BY", 5122 "BZ", 5123 "CA", 5124 "CC", 5125 "CD", 5126 "CF", 5127 "CG", 5128 "CH", 5129 "CI", 5130 "CK", 5131 "CL", 5132 "CM", 5133 "CN", 5134 "CO", 5135 "CR", 5136 "CU", 5137 "CV", 5138 "CW", 5139 "CX", 5140 "CY", 5141 "CZ", 5142 "DE", 5143 "DJ", 5144 "DK", 5145 "DM", 5146 "DO", 5147 "DZ", 5148 "EC", 5149 "EE", 5150 "EG", 5151 "EH", 5152 "ER", 5153 "ES", 5154 "ET", 5155 "FI", 5156 "FJ", 5157 "FK", 5158 "FM", 5159 "FO", 5160 "FR", 5161 "GA", 5162 "GB", 5163 "GD", 5164 "GE", 5165 "GG", 5166 "GH", 5167 "GI", 5168 "GL", 5169 "GM", 5170 "GN", 5171 "GQ", 5172 "GR", 5173 "GT", 5174 "GU", 5175 "GW", 5176 "GY", 5177 "HK", 5178 "HN", 5179 "HR", 5180 "HT", 5181 "HU", 5182 "ID", 5183 "IE", 5184 "IL", 5185 "IM", 5186 "IN", 5187 "Type[IO]", 5188 "IQ", 5189 "IR", 5190 "IS", 5191 "IT", 5192 "JE", 5193 "JM", 5194 "JO", 5195 "JP", 5196 "KE", 5197 "KG", 5198 "KH", 5199 "KI", 5200 "KM", 5201 "KN", 5202 "KP", 5203 "KR", 5204 "KW", 5205 "KY", 5206 "KZ", 5207 "LA", 5208 "LB", 5209 "LC", 5210 "LI", 5211 "LK", 5212 "LR", 5213 "LS", 5214 "LT", 5215 "LU", 5216 "LV", 5217 "LY", 5218 "MA", 5219 "MC", 5220 "MD", 5221 "ME", 5222 "MF", 5223 "MG", 5224 "MH", 5225 "MK", 5226 "ML", 5227 "MM", 5228 "MN", 5229 "MO", 5230 "MP", 5231 "MR", 5232 "MS", 5233 "MT", 5234 "MU", 5235 "MV", 5236 "MW", 5237 "MX", 5238 "MY", 5239 "MZ", 5240 "NA", 5241 "NC", 5242 "NE", 5243 "NG", 5244 "NI", 5245 "NL", 5246 "NO", 5247 "NP", 5248 "NR", 5249 "NU", 5250 "NZ", 5251 "OM", 5252 "PA", 5253 "PE", 5254 "PF", 5255 "PG", 5256 "PH", 5257 "PK", 5258 "PL", 5259 "PM", 5260 "PN", 5261 "PR", 5262 "PT", 5263 "PW", 5264 "PY", 5265 "QA", 5266 "RE", 5267 "RO", 5268 "RS", 5269 "RU", 5270 "RW", 5271 "SA", 5272 "SB", 5273 "SC", 5274 "SD", 5275 "SE", 5276 "SG", 5277 "SH", 5278 "SI", 5279 "SJ", 5280 "SK", 5281 "SL", 5282 "SM", 5283 "SN", 5284 "SO", 5285 "SR", 5286 "ST", 5287 "SV", 5288 "SX", 5289 "SY", 5290 "SZ", 5291 "TC", 5292 "TD", 5293 "TG", 5294 "TH", 5295 "TJ", 5296 "TK", 5297 "TL", 5298 "TM", 5299 "TN", 5300 "TO", 5301 "TR", 5302 "TT", 5303 "TV", 5304 "TW", 5305 "TZ", 5306 "UA", 5307 "UG", 5308 "US", 5309 "UY", 5310 "UZ", 5311 "VA", 5312 "VC", 5313 "VE", 5314 "VG", 5315 "VI", 5316 "VN", 5317 "VU", 5318 "WF", 5319 "WS", 5320 "YE", 5321 "YT", 5322 "ZA", 5323 "ZM", 5324 "ZW", 5325 ] = Field(alias="PhoneNumberCountryCode") 5326 phone_number_type: Literal["DID", "TOLL_FREE"] = Field(alias="PhoneNumberType") 5327 phone_number_prefix: Optional[str] = Field(default=None, alias="PhoneNumberPrefix") 5328 pagination_config: Optional[PaginatorConfigModel] = Field( 5329 default=None, alias="PaginationConfig" 5330 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
SearchVocabulariesRequestSearchVocabulariesPaginateModel(mypydantic.models.base_model.BaseModel):
5333class SearchVocabulariesRequestSearchVocabulariesPaginateModel(BaseModel): 5334 instance_id: str = Field(alias="InstanceId") 5335 state: Optional[ 5336 Literal[ 5337 "ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS", "DELETE_IN_PROGRESS" 5338 ] 5339 ] = Field(default=None, alias="State") 5340 name_starts_with: Optional[str] = Field(default=None, alias="NameStartsWith") 5341 language_code: Optional[ 5342 Literal[ 5343 "ar-AE", 5344 "de-CH", 5345 "de-DE", 5346 "en-AB", 5347 "en-AU", 5348 "en-GB", 5349 "en-IE", 5350 "en-IN", 5351 "en-NZ", 5352 "en-US", 5353 "en-WL", 5354 "en-ZA", 5355 "es-ES", 5356 "es-US", 5357 "fr-CA", 5358 "fr-FR", 5359 "hi-IN", 5360 "it-IT", 5361 "ja-JP", 5362 "ko-KR", 5363 "pt-BR", 5364 "pt-PT", 5365 "zh-CN", 5366 ] 5367 ] = Field(default=None, alias="LanguageCode") 5368 pagination_config: Optional[PaginatorConfigModel] = Field( 5369 default=None, alias="PaginationConfig" 5370 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5373class HierarchyPathReferenceModel(BaseModel): 5374 level_one: Optional[HierarchyGroupSummaryReferenceModel] = Field( 5375 default=None, alias="LevelOne" 5376 ) 5377 level_two: Optional[HierarchyGroupSummaryReferenceModel] = Field( 5378 default=None, alias="LevelTwo" 5379 ) 5380 level_three: Optional[HierarchyGroupSummaryReferenceModel] = Field( 5381 default=None, alias="LevelThree" 5382 ) 5383 level_four: Optional[HierarchyGroupSummaryReferenceModel] = Field( 5384 default=None, alias="LevelFour" 5385 ) 5386 level_five: Optional[HierarchyGroupSummaryReferenceModel] = Field( 5387 default=None, alias="LevelFive" 5388 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5391class HierarchyPathModel(BaseModel): 5392 level_one: Optional[HierarchyGroupSummaryModel] = Field( 5393 default=None, alias="LevelOne" 5394 ) 5395 level_two: Optional[HierarchyGroupSummaryModel] = Field( 5396 default=None, alias="LevelTwo" 5397 ) 5398 level_three: Optional[HierarchyGroupSummaryModel] = Field( 5399 default=None, alias="LevelThree" 5400 ) 5401 level_four: Optional[HierarchyGroupSummaryModel] = Field( 5402 default=None, alias="LevelFour" 5403 ) 5404 level_five: Optional[HierarchyGroupSummaryModel] = Field( 5405 default=None, alias="LevelFive" 5406 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5409class ListUserHierarchyGroupsResponseModel(BaseModel): 5410 user_hierarchy_group_summary_list: List[HierarchyGroupSummaryModel] = Field( 5411 alias="UserHierarchyGroupSummaryList" 5412 ) 5413 next_token: str = Field(alias="NextToken") 5414 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5417class HierarchyStructureModel(BaseModel): 5418 level_one: Optional[HierarchyLevelModel] = Field(default=None, alias="LevelOne") 5419 level_two: Optional[HierarchyLevelModel] = Field(default=None, alias="LevelTwo") 5420 level_three: Optional[HierarchyLevelModel] = Field(default=None, alias="LevelThree") 5421 level_four: Optional[HierarchyLevelModel] = Field(default=None, alias="LevelFour") 5422 level_five: Optional[HierarchyLevelModel] = Field(default=None, alias="LevelFive")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5425class HierarchyStructureUpdateModel(BaseModel): 5426 level_one: Optional[HierarchyLevelUpdateModel] = Field( 5427 default=None, alias="LevelOne" 5428 ) 5429 level_two: Optional[HierarchyLevelUpdateModel] = Field( 5430 default=None, alias="LevelTwo" 5431 ) 5432 level_three: Optional[HierarchyLevelUpdateModel] = Field( 5433 default=None, alias="LevelThree" 5434 ) 5435 level_four: Optional[HierarchyLevelUpdateModel] = Field( 5436 default=None, alias="LevelFour" 5437 ) 5438 level_five: Optional[HierarchyLevelUpdateModel] = Field( 5439 default=None, alias="LevelFive" 5440 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5443class HistoricalMetricModel(BaseModel): 5444 name: Optional[ 5445 Literal[ 5446 "ABANDON_TIME", 5447 "AFTER_CONTACT_WORK_TIME", 5448 "API_CONTACTS_HANDLED", 5449 "CALLBACK_CONTACTS_HANDLED", 5450 "CONTACTS_ABANDONED", 5451 "CONTACTS_AGENT_HUNG_UP_FIRST", 5452 "CONTACTS_CONSULTED", 5453 "CONTACTS_HANDLED", 5454 "CONTACTS_HANDLED_INCOMING", 5455 "CONTACTS_HANDLED_OUTBOUND", 5456 "CONTACTS_HOLD_ABANDONS", 5457 "CONTACTS_MISSED", 5458 "CONTACTS_QUEUED", 5459 "CONTACTS_TRANSFERRED_IN", 5460 "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", 5461 "CONTACTS_TRANSFERRED_OUT", 5462 "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", 5463 "HANDLE_TIME", 5464 "HOLD_TIME", 5465 "INTERACTION_AND_HOLD_TIME", 5466 "INTERACTION_TIME", 5467 "OCCUPANCY", 5468 "QUEUED_TIME", 5469 "QUEUE_ANSWER_TIME", 5470 "SERVICE_LEVEL", 5471 ] 5472 ] = Field(default=None, alias="Name") 5473 threshold: Optional[ThresholdModel] = Field(default=None, alias="Threshold") 5474 statistic: Optional[Literal["AVG", "MAX", "SUM"]] = Field( 5475 default=None, alias="Statistic" 5476 ) 5477 unit: Optional[Literal["COUNT", "PERCENT", "SECONDS"]] = Field( 5478 default=None, alias="Unit" 5479 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5482class HoursOfOperationConfigModel(BaseModel): 5483 day: Literal[ 5484 "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" 5485 ] = Field(alias="Day") 5486 start_time: HoursOfOperationTimeSliceModel = Field(alias="StartTime") 5487 end_time: HoursOfOperationTimeSliceModel = Field(alias="EndTime")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5490class ListHoursOfOperationsResponseModel(BaseModel): 5491 hours_of_operation_summary_list: List[HoursOfOperationSummaryModel] = Field( 5492 alias="HoursOfOperationSummaryList" 5493 ) 5494 next_token: str = Field(alias="NextToken") 5495 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5498class InstanceModel(BaseModel): 5499 id: Optional[str] = Field(default=None, alias="Id") 5500 arn: Optional[str] = Field(default=None, alias="Arn") 5501 identity_management_type: Optional[ 5502 Literal["CONNECT_MANAGED", "EXISTING_DIRECTORY", "SAML"] 5503 ] = Field(default=None, alias="IdentityManagementType") 5504 instance_alias: Optional[str] = Field(default=None, alias="InstanceAlias") 5505 created_time: Optional[datetime] = Field(default=None, alias="CreatedTime") 5506 service_role: Optional[str] = Field(default=None, alias="ServiceRole") 5507 instance_status: Optional[ 5508 Literal["ACTIVE", "CREATION_FAILED", "CREATION_IN_PROGRESS"] 5509 ] = Field(default=None, alias="InstanceStatus") 5510 status_reason: Optional[InstanceStatusReasonModel] = Field( 5511 default=None, alias="StatusReason" 5512 ) 5513 inbound_calls_enabled: Optional[bool] = Field( 5514 default=None, alias="InboundCallsEnabled" 5515 ) 5516 outbound_calls_enabled: Optional[bool] = Field( 5517 default=None, alias="OutboundCallsEnabled" 5518 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5521class ListInstancesResponseModel(BaseModel): 5522 instance_summary_list: List[InstanceSummaryModel] = Field( 5523 alias="InstanceSummaryList" 5524 ) 5525 next_token: str = Field(alias="NextToken") 5526 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5529class ListIntegrationAssociationsResponseModel(BaseModel): 5530 integration_association_summary_list: List[ 5531 IntegrationAssociationSummaryModel 5532 ] = Field(alias="IntegrationAssociationSummaryList") 5533 next_token: str = Field(alias="NextToken") 5534 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5537class InvisibleFieldInfoModel(BaseModel): 5538 id: Optional[TaskTemplateFieldIdentifierModel] = Field(default=None, alias="Id")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5541class ReadOnlyFieldInfoModel(BaseModel): 5542 id: Optional[TaskTemplateFieldIdentifierModel] = Field(default=None, alias="Id")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5545class RequiredFieldInfoModel(BaseModel): 5546 id: Optional[TaskTemplateFieldIdentifierModel] = Field(default=None, alias="Id")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5549class TaskTemplateDefaultFieldValueModel(BaseModel): 5550 id: Optional[TaskTemplateFieldIdentifierModel] = Field(default=None, alias="Id") 5551 default_value: Optional[str] = Field(default=None, alias="DefaultValue")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5554class TaskTemplateFieldModel(BaseModel): 5555 id: TaskTemplateFieldIdentifierModel = Field(alias="Id") 5556 description: Optional[str] = Field(default=None, alias="Description") 5557 type: Optional[ 5558 Literal[ 5559 "BOOLEAN", 5560 "DATE_TIME", 5561 "DESCRIPTION", 5562 "EMAIL", 5563 "NAME", 5564 "NUMBER", 5565 "QUICK_CONNECT", 5566 "SCHEDULED_TIME", 5567 "SINGLE_SELECT", 5568 "TEXT", 5569 "TEXT_AREA", 5570 "URL", 5571 ] 5572 ] = Field(default=None, alias="Type") 5573 single_select_options: Optional[Sequence[str]] = Field( 5574 default=None, alias="SingleSelectOptions" 5575 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5578class ListPhoneNumbersResponseModel(BaseModel): 5579 phone_number_summary_list: List[PhoneNumberSummaryModel] = Field( 5580 alias="PhoneNumberSummaryList" 5581 ) 5582 next_token: str = Field(alias="NextToken") 5583 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5586class ListPhoneNumbersV2ResponseModel(BaseModel): 5587 next_token: str = Field(alias="NextToken") 5588 list_phone_numbers_summary_list: List[ListPhoneNumbersSummaryModel] = Field( 5589 alias="ListPhoneNumbersSummaryList" 5590 ) 5591 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5594class ListPromptsResponseModel(BaseModel): 5595 prompt_summary_list: List[PromptSummaryModel] = Field(alias="PromptSummaryList") 5596 next_token: str = Field(alias="NextToken") 5597 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5600class ListQueueQuickConnectsResponseModel(BaseModel): 5601 next_token: str = Field(alias="NextToken") 5602 quick_connect_summary_list: List[QuickConnectSummaryModel] = Field( 5603 alias="QuickConnectSummaryList" 5604 ) 5605 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5608class ListQuickConnectsResponseModel(BaseModel): 5609 quick_connect_summary_list: List[QuickConnectSummaryModel] = Field( 5610 alias="QuickConnectSummaryList" 5611 ) 5612 next_token: str = Field(alias="NextToken") 5613 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5616class ListQueuesResponseModel(BaseModel): 5617 queue_summary_list: List[QueueSummaryModel] = Field(alias="QueueSummaryList") 5618 next_token: str = Field(alias="NextToken") 5619 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5622class ListRoutingProfileQueuesResponseModel(BaseModel): 5623 next_token: str = Field(alias="NextToken") 5624 routing_profile_queue_config_summary_list: List[ 5625 RoutingProfileQueueConfigSummaryModel 5626 ] = Field(alias="RoutingProfileQueueConfigSummaryList") 5627 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5630class ListRoutingProfilesResponseModel(BaseModel): 5631 routing_profile_summary_list: List[RoutingProfileSummaryModel] = Field( 5632 alias="RoutingProfileSummaryList" 5633 ) 5634 next_token: str = Field(alias="NextToken") 5635 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5638class ListSecurityKeysResponseModel(BaseModel): 5639 security_keys: List[SecurityKeyModel] = Field(alias="SecurityKeys") 5640 next_token: str = Field(alias="NextToken") 5641 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5644class ListSecurityProfilesResponseModel(BaseModel): 5645 security_profile_summary_list: List[SecurityProfileSummaryModel] = Field( 5646 alias="SecurityProfileSummaryList" 5647 ) 5648 next_token: str = Field(alias="NextToken") 5649 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5652class ListTaskTemplatesResponseModel(BaseModel): 5653 task_templates: List[TaskTemplateMetadataModel] = Field(alias="TaskTemplates") 5654 next_token: str = Field(alias="NextToken") 5655 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5658class ListTrafficDistributionGroupsResponseModel(BaseModel): 5659 next_token: str = Field(alias="NextToken") 5660 traffic_distribution_group_summary_list: List[ 5661 TrafficDistributionGroupSummaryModel 5662 ] = Field(alias="TrafficDistributionGroupSummaryList") 5663 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5666class ListUseCasesResponseModel(BaseModel): 5667 use_case_summary_list: List[UseCaseModel] = Field(alias="UseCaseSummaryList") 5668 next_token: str = Field(alias="NextToken") 5669 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5672class ListUsersResponseModel(BaseModel): 5673 user_summary_list: List[UserSummaryModel] = Field(alias="UserSummaryList") 5674 next_token: str = Field(alias="NextToken") 5675 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5678class SendNotificationActionDefinitionModel(BaseModel): 5679 delivery_method: Literal["EMAIL"] = Field(alias="DeliveryMethod") 5680 content: str = Field(alias="Content") 5681 content_type: Literal["PLAIN_TEXT"] = Field(alias="ContentType") 5682 recipient: NotificationRecipientTypeModel = Field(alias="Recipient") 5683 subject: Optional[str] = Field(default=None, alias="Subject")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5686class ParticipantTimerConfigurationModel(BaseModel): 5687 participant_role: Literal["AGENT", "CUSTOMER"] = Field(alias="ParticipantRole") 5688 timer_type: Literal["DISCONNECT_NONCUSTOMER", "IDLE"] = Field(alias="TimerType") 5689 timer_value: ParticipantTimerValueModel = Field(alias="TimerValue")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5692class StartChatContactRequestModel(BaseModel): 5693 instance_id: str = Field(alias="InstanceId") 5694 contact_flow_id: str = Field(alias="ContactFlowId") 5695 participant_details: ParticipantDetailsModel = Field(alias="ParticipantDetails") 5696 attributes: Optional[Mapping[str, str]] = Field(default=None, alias="Attributes") 5697 initial_message: Optional[ChatMessageModel] = Field( 5698 default=None, alias="InitialMessage" 5699 ) 5700 client_token: Optional[str] = Field(default=None, alias="ClientToken") 5701 chat_duration_in_minutes: Optional[int] = Field( 5702 default=None, alias="ChatDurationInMinutes" 5703 ) 5704 supported_messaging_content_types: Optional[Sequence[str]] = Field( 5705 default=None, alias="SupportedMessagingContentTypes" 5706 ) 5707 persistent_chat: Optional[PersistentChatModel] = Field( 5708 default=None, alias="PersistentChat" 5709 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5712class QueueSearchCriteriaModel(BaseModel): 5713 or_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5714 default=None, alias="OrConditions" 5715 ) 5716 and_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5717 default=None, alias="AndConditions" 5718 ) 5719 string_condition: Optional[StringConditionModel] = Field( 5720 default=None, alias="StringCondition" 5721 ) 5722 queue_type_condition: Optional[Literal["STANDARD"]] = Field( 5723 default=None, alias="QueueTypeCondition" 5724 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5727class RoutingProfileSearchCriteriaModel(BaseModel): 5728 or_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5729 default=None, alias="OrConditions" 5730 ) 5731 and_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5732 default=None, alias="AndConditions" 5733 ) 5734 string_condition: Optional[StringConditionModel] = Field( 5735 default=None, alias="StringCondition" 5736 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5739class SecurityProfileSearchCriteriaModel(BaseModel): 5740 or_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5741 default=None, alias="OrConditions" 5742 ) 5743 and_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5744 default=None, alias="AndConditions" 5745 ) 5746 string_condition: Optional[StringConditionModel] = Field( 5747 default=None, alias="StringCondition" 5748 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5751class UserSearchCriteriaModel(BaseModel): 5752 or_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5753 default=None, alias="OrConditions" 5754 ) 5755 and_conditions: Optional[Sequence[Dict[str, Any]]] = Field( 5756 default=None, alias="AndConditions" 5757 ) 5758 string_condition: Optional[StringConditionModel] = Field( 5759 default=None, alias="StringCondition" 5760 ) 5761 hierarchy_group_condition: Optional[HierarchyGroupConditionModel] = Field( 5762 default=None, alias="HierarchyGroupCondition" 5763 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5766class QuickConnectConfigModel(BaseModel): 5767 quick_connect_type: Literal["PHONE_NUMBER", "QUEUE", "USER"] = Field( 5768 alias="QuickConnectType" 5769 ) 5770 user_config: Optional[UserQuickConnectConfigModel] = Field( 5771 default=None, alias="UserConfig" 5772 ) 5773 queue_config: Optional[QueueQuickConnectConfigModel] = Field( 5774 default=None, alias="QueueConfig" 5775 ) 5776 phone_config: Optional[PhoneNumberQuickConnectConfigModel] = Field( 5777 default=None, alias="PhoneConfig" 5778 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5781class ReferenceSummaryModel(BaseModel): 5782 url: Optional[UrlReferenceModel] = Field(default=None, alias="Url") 5783 attachment: Optional[AttachmentReferenceModel] = Field( 5784 default=None, alias="Attachment" 5785 ) 5786 string: Optional[StringReferenceModel] = Field(default=None, alias="String") 5787 number: Optional[NumberReferenceModel] = Field(default=None, alias="Number") 5788 date: Optional[DateReferenceModel] = Field(default=None, alias="Date") 5789 email: Optional[EmailReferenceModel] = Field(default=None, alias="Email")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5792class StartTaskContactRequestModel(BaseModel): 5793 instance_id: str = Field(alias="InstanceId") 5794 name: str = Field(alias="Name") 5795 previous_contact_id: Optional[str] = Field(default=None, alias="PreviousContactId") 5796 contact_flow_id: Optional[str] = Field(default=None, alias="ContactFlowId") 5797 attributes: Optional[Mapping[str, str]] = Field(default=None, alias="Attributes") 5798 references: Optional[Mapping[str, ReferenceModel]] = Field( 5799 default=None, alias="References" 5800 ) 5801 description: Optional[str] = Field(default=None, alias="Description") 5802 client_token: Optional[str] = Field(default=None, alias="ClientToken") 5803 scheduled_time: Optional[Union[datetime, str]] = Field( 5804 default=None, alias="ScheduledTime" 5805 ) 5806 task_template_id: Optional[str] = Field(default=None, alias="TaskTemplateId") 5807 quick_connect_id: Optional[str] = Field(default=None, alias="QuickConnectId") 5808 related_contact_id: Optional[str] = Field(default=None, alias="RelatedContactId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5811class TaskActionDefinitionModel(BaseModel): 5812 name: str = Field(alias="Name") 5813 contact_flow_id: str = Field(alias="ContactFlowId") 5814 description: Optional[str] = Field(default=None, alias="Description") 5815 references: Optional[Mapping[str, ReferenceModel]] = Field( 5816 default=None, alias="References" 5817 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5820class UpdateContactRequestModel(BaseModel): 5821 instance_id: str = Field(alias="InstanceId") 5822 contact_id: str = Field(alias="ContactId") 5823 name: Optional[str] = Field(default=None, alias="Name") 5824 description: Optional[str] = Field(default=None, alias="Description") 5825 references: Optional[Mapping[str, ReferenceModel]] = Field( 5826 default=None, alias="References" 5827 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5830class SearchSecurityProfilesResponseModel(BaseModel): 5831 security_profiles: List[SecurityProfileSearchSummaryModel] = Field( 5832 alias="SecurityProfiles" 5833 ) 5834 next_token: str = Field(alias="NextToken") 5835 approximate_total_count: int = Field(alias="ApproximateTotalCount") 5836 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5839class SearchVocabulariesResponseModel(BaseModel): 5840 vocabulary_summary_list: List[VocabularySummaryModel] = Field( 5841 alias="VocabularySummaryList" 5842 ) 5843 next_token: str = Field(alias="NextToken") 5844 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5847class StartContactRecordingRequestModel(BaseModel): 5848 instance_id: str = Field(alias="InstanceId") 5849 contact_id: str = Field(alias="ContactId") 5850 initial_contact_id: str = Field(alias="InitialContactId") 5851 voice_recording_configuration: VoiceRecordingConfigurationModel = Field( 5852 alias="VoiceRecordingConfiguration" 5853 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5856class UserSearchSummaryModel(BaseModel): 5857 arn: Optional[str] = Field(default=None, alias="Arn") 5858 directory_user_id: Optional[str] = Field(default=None, alias="DirectoryUserId") 5859 hierarchy_group_id: Optional[str] = Field(default=None, alias="HierarchyGroupId") 5860 id: Optional[str] = Field(default=None, alias="Id") 5861 identity_info: Optional[UserIdentityInfoLiteModel] = Field( 5862 default=None, alias="IdentityInfo" 5863 ) 5864 phone_config: Optional[UserPhoneConfigModel] = Field( 5865 default=None, alias="PhoneConfig" 5866 ) 5867 routing_profile_id: Optional[str] = Field(default=None, alias="RoutingProfileId") 5868 security_profile_ids: Optional[List[str]] = Field( 5869 default=None, alias="SecurityProfileIds" 5870 ) 5871 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags") 5872 username: Optional[str] = Field(default=None, alias="Username")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5875class ListRulesResponseModel(BaseModel): 5876 rule_summary_list: List[RuleSummaryModel] = Field(alias="RuleSummaryList") 5877 next_token: str = Field(alias="NextToken") 5878 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5881class ListBotsResponseModel(BaseModel): 5882 lex_bots: List[LexBotConfigModel] = Field(alias="LexBots") 5883 next_token: str = Field(alias="NextToken") 5884 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5887class DescribePhoneNumberResponseModel(BaseModel): 5888 claimed_phone_number_summary: ClaimedPhoneNumberSummaryModel = Field( 5889 alias="ClaimedPhoneNumberSummary" 5890 ) 5891 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5894class GetCurrentUserDataRequestModel(BaseModel): 5895 instance_id: str = Field(alias="InstanceId") 5896 filters: UserDataFiltersModel = Field(alias="Filters") 5897 next_token: Optional[str] = Field(default=None, alias="NextToken") 5898 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5901class DescribeContactResponseModel(BaseModel): 5902 contact: ContactModel = Field(alias="Contact") 5903 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5906class QueueSearchFilterModel(BaseModel): 5907 tag_filter: Optional[ControlPlaneTagFilterModel] = Field( 5908 default=None, alias="TagFilter" 5909 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5912class RoutingProfileSearchFilterModel(BaseModel): 5913 tag_filter: Optional[ControlPlaneTagFilterModel] = Field( 5914 default=None, alias="TagFilter" 5915 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5918class SecurityProfilesSearchFilterModel(BaseModel): 5919 tag_filter: Optional[ControlPlaneTagFilterModel] = Field( 5920 default=None, alias="TagFilter" 5921 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5924class UserSearchFilterModel(BaseModel): 5925 tag_filter: Optional[ControlPlaneTagFilterModel] = Field( 5926 default=None, alias="TagFilter" 5927 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5930class DescribeQueueResponseModel(BaseModel): 5931 queue: QueueModel = Field(alias="Queue") 5932 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5935class SearchQueuesResponseModel(BaseModel): 5936 queues: List[QueueModel] = Field(alias="Queues") 5937 next_token: str = Field(alias="NextToken") 5938 approximate_total_count: int = Field(alias="ApproximateTotalCount") 5939 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5942class DescribeRoutingProfileResponseModel(BaseModel): 5943 routing_profile: RoutingProfileModel = Field(alias="RoutingProfile") 5944 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5947class SearchRoutingProfilesResponseModel(BaseModel): 5948 routing_profiles: List[RoutingProfileModel] = Field(alias="RoutingProfiles") 5949 next_token: str = Field(alias="NextToken") 5950 approximate_total_count: int = Field(alias="ApproximateTotalCount") 5951 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5954class DescribeUserResponseModel(BaseModel): 5955 user: UserModel = Field(alias="User") 5956 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5959class CurrentMetricResultModel(BaseModel): 5960 dimensions: Optional[DimensionsModel] = Field(default=None, alias="Dimensions") 5961 collections: Optional[List[CurrentMetricDataModel]] = Field( 5962 default=None, alias="Collections" 5963 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5966class AssociateRoutingProfileQueuesRequestModel(BaseModel): 5967 instance_id: str = Field(alias="InstanceId") 5968 routing_profile_id: str = Field(alias="RoutingProfileId") 5969 queue_configs: Sequence[RoutingProfileQueueConfigModel] = Field( 5970 alias="QueueConfigs" 5971 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5974class CreateRoutingProfileRequestModel(BaseModel): 5975 instance_id: str = Field(alias="InstanceId") 5976 name: str = Field(alias="Name") 5977 description: str = Field(alias="Description") 5978 default_outbound_queue_id: str = Field(alias="DefaultOutboundQueueId") 5979 media_concurrencies: Sequence[MediaConcurrencyModel] = Field( 5980 alias="MediaConcurrencies" 5981 ) 5982 queue_configs: Optional[Sequence[RoutingProfileQueueConfigModel]] = Field( 5983 default=None, alias="QueueConfigs" 5984 ) 5985 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5988class UpdateRoutingProfileQueuesRequestModel(BaseModel): 5989 instance_id: str = Field(alias="InstanceId") 5990 routing_profile_id: str = Field(alias="RoutingProfileId") 5991 queue_configs: Sequence[RoutingProfileQueueConfigModel] = Field( 5992 alias="QueueConfigs" 5993 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
5996class GetTrafficDistributionResponseModel(BaseModel): 5997 telephony_config: TelephonyConfigModel = Field(alias="TelephonyConfig") 5998 id: str = Field(alias="Id") 5999 arn: str = Field(alias="Arn") 6000 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6003class UpdateTrafficDistributionRequestModel(BaseModel): 6004 id: str = Field(alias="Id") 6005 telephony_config: Optional[TelephonyConfigModel] = Field( 6006 default=None, alias="TelephonyConfig" 6007 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6010class InstanceStorageConfigModel(BaseModel): 6011 storage_type: Literal[ 6012 "KINESIS_FIREHOSE", "KINESIS_STREAM", "KINESIS_VIDEO_STREAM", "S3" 6013 ] = Field(alias="StorageType") 6014 association_id: Optional[str] = Field(default=None, alias="AssociationId") 6015 s3_config: Optional[S3ConfigModel] = Field(default=None, alias="S3Config") 6016 kinesis_video_stream_config: Optional[KinesisVideoStreamConfigModel] = Field( 6017 default=None, alias="KinesisVideoStreamConfig" 6018 ) 6019 kinesis_stream_config: Optional[KinesisStreamConfigModel] = Field( 6020 default=None, alias="KinesisStreamConfig" 6021 ) 6022 kinesis_firehose_config: Optional[KinesisFirehoseConfigModel] = Field( 6023 default=None, alias="KinesisFirehoseConfig" 6024 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6027class UserDataModel(BaseModel): 6028 user: Optional[UserReferenceModel] = Field(default=None, alias="User") 6029 routing_profile: Optional[RoutingProfileReferenceModel] = Field( 6030 default=None, alias="RoutingProfile" 6031 ) 6032 hierarchy_path: Optional[HierarchyPathReferenceModel] = Field( 6033 default=None, alias="HierarchyPath" 6034 ) 6035 status: Optional[AgentStatusReferenceModel] = Field(default=None, alias="Status") 6036 available_slots_by_channel: Optional[ 6037 Dict[Literal["CHAT", "TASK", "VOICE"], int] 6038 ] = Field(default=None, alias="AvailableSlotsByChannel") 6039 max_slots_by_channel: Optional[Dict[Literal["CHAT", "TASK", "VOICE"], int]] = Field( 6040 default=None, alias="MaxSlotsByChannel" 6041 ) 6042 active_slots_by_channel: Optional[ 6043 Dict[Literal["CHAT", "TASK", "VOICE"], int] 6044 ] = Field(default=None, alias="ActiveSlotsByChannel") 6045 contacts: Optional[List[AgentContactReferenceModel]] = Field( 6046 default=None, alias="Contacts" 6047 ) 6048 next_status: Optional[str] = Field(default=None, alias="NextStatus")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6051class HierarchyGroupModel(BaseModel): 6052 id: Optional[str] = Field(default=None, alias="Id") 6053 arn: Optional[str] = Field(default=None, alias="Arn") 6054 name: Optional[str] = Field(default=None, alias="Name") 6055 level_id: Optional[str] = Field(default=None, alias="LevelId") 6056 hierarchy_path: Optional[HierarchyPathModel] = Field( 6057 default=None, alias="HierarchyPath" 6058 ) 6059 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6062class DescribeUserHierarchyStructureResponseModel(BaseModel): 6063 hierarchy_structure: HierarchyStructureModel = Field(alias="HierarchyStructure") 6064 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6067class UpdateUserHierarchyStructureRequestModel(BaseModel): 6068 hierarchy_structure: HierarchyStructureUpdateModel = Field( 6069 alias="HierarchyStructure" 6070 ) 6071 instance_id: str = Field(alias="InstanceId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6074class GetMetricDataRequestGetMetricDataPaginateModel(BaseModel): 6075 instance_id: str = Field(alias="InstanceId") 6076 start_time: Union[datetime, str] = Field(alias="StartTime") 6077 end_time: Union[datetime, str] = Field(alias="EndTime") 6078 filters: FiltersModel = Field(alias="Filters") 6079 historical_metrics: Sequence[HistoricalMetricModel] = Field( 6080 alias="HistoricalMetrics" 6081 ) 6082 groupings: Optional[ 6083 Sequence[Literal["CHANNEL", "QUEUE", "ROUTING_PROFILE"]] 6084 ] = Field(default=None, alias="Groupings") 6085 pagination_config: Optional[PaginatorConfigModel] = Field( 6086 default=None, alias="PaginationConfig" 6087 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6090class GetMetricDataRequestModel(BaseModel): 6091 instance_id: str = Field(alias="InstanceId") 6092 start_time: Union[datetime, str] = Field(alias="StartTime") 6093 end_time: Union[datetime, str] = Field(alias="EndTime") 6094 filters: FiltersModel = Field(alias="Filters") 6095 historical_metrics: Sequence[HistoricalMetricModel] = Field( 6096 alias="HistoricalMetrics" 6097 ) 6098 groupings: Optional[ 6099 Sequence[Literal["CHANNEL", "QUEUE", "ROUTING_PROFILE"]] 6100 ] = Field(default=None, alias="Groupings") 6101 next_token: Optional[str] = Field(default=None, alias="NextToken") 6102 max_results: Optional[int] = Field(default=None, alias="MaxResults")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6105class HistoricalMetricDataModel(BaseModel): 6106 metric: Optional[HistoricalMetricModel] = Field(default=None, alias="Metric") 6107 value: Optional[float] = Field(default=None, alias="Value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6110class CreateHoursOfOperationRequestModel(BaseModel): 6111 instance_id: str = Field(alias="InstanceId") 6112 name: str = Field(alias="Name") 6113 time_zone: str = Field(alias="TimeZone") 6114 config: Sequence[HoursOfOperationConfigModel] = Field(alias="Config") 6115 description: Optional[str] = Field(default=None, alias="Description") 6116 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6119class HoursOfOperationModel(BaseModel): 6120 hours_of_operation_id: Optional[str] = Field( 6121 default=None, alias="HoursOfOperationId" 6122 ) 6123 hours_of_operation_arn: Optional[str] = Field( 6124 default=None, alias="HoursOfOperationArn" 6125 ) 6126 name: Optional[str] = Field(default=None, alias="Name") 6127 description: Optional[str] = Field(default=None, alias="Description") 6128 time_zone: Optional[str] = Field(default=None, alias="TimeZone") 6129 config: Optional[List[HoursOfOperationConfigModel]] = Field( 6130 default=None, alias="Config" 6131 ) 6132 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6135class UpdateHoursOfOperationRequestModel(BaseModel): 6136 instance_id: str = Field(alias="InstanceId") 6137 hours_of_operation_id: str = Field(alias="HoursOfOperationId") 6138 name: Optional[str] = Field(default=None, alias="Name") 6139 description: Optional[str] = Field(default=None, alias="Description") 6140 time_zone: Optional[str] = Field(default=None, alias="TimeZone") 6141 config: Optional[Sequence[HoursOfOperationConfigModel]] = Field( 6142 default=None, alias="Config" 6143 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6146class DescribeInstanceResponseModel(BaseModel): 6147 instance: InstanceModel = Field(alias="Instance") 6148 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6151class TaskTemplateConstraintsModel(BaseModel): 6152 required_fields: Optional[Sequence[RequiredFieldInfoModel]] = Field( 6153 default=None, alias="RequiredFields" 6154 ) 6155 read_only_fields: Optional[Sequence[ReadOnlyFieldInfoModel]] = Field( 6156 default=None, alias="ReadOnlyFields" 6157 ) 6158 invisible_fields: Optional[Sequence[InvisibleFieldInfoModel]] = Field( 6159 default=None, alias="InvisibleFields" 6160 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6163class TaskTemplateDefaultsModel(BaseModel): 6164 default_field_values: Optional[ 6165 Sequence[TaskTemplateDefaultFieldValueModel] 6166 ] = Field(default=None, alias="DefaultFieldValues")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6169class ChatParticipantRoleConfigModel(BaseModel): 6170 participant_timer_config_list: Sequence[ParticipantTimerConfigurationModel] = Field( 6171 alias="ParticipantTimerConfigList" 6172 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6175class CreateQuickConnectRequestModel(BaseModel): 6176 instance_id: str = Field(alias="InstanceId") 6177 name: str = Field(alias="Name") 6178 quick_connect_config: QuickConnectConfigModel = Field(alias="QuickConnectConfig") 6179 description: Optional[str] = Field(default=None, alias="Description") 6180 tags: Optional[Mapping[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6183class QuickConnectModel(BaseModel): 6184 quick_connect_arn: Optional[str] = Field(default=None, alias="QuickConnectARN") 6185 quick_connect_id: Optional[str] = Field(default=None, alias="QuickConnectId") 6186 name: Optional[str] = Field(default=None, alias="Name") 6187 description: Optional[str] = Field(default=None, alias="Description") 6188 quick_connect_config: Optional[QuickConnectConfigModel] = Field( 6189 default=None, alias="QuickConnectConfig" 6190 ) 6191 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6194class UpdateQuickConnectConfigRequestModel(BaseModel): 6195 instance_id: str = Field(alias="InstanceId") 6196 quick_connect_id: str = Field(alias="QuickConnectId") 6197 quick_connect_config: QuickConnectConfigModel = Field(alias="QuickConnectConfig")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6200class ListContactReferencesResponseModel(BaseModel): 6201 reference_summary_list: List[ReferenceSummaryModel] = Field( 6202 alias="ReferenceSummaryList" 6203 ) 6204 next_token: str = Field(alias="NextToken") 6205 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6208class RuleActionModel(BaseModel): 6209 action_type: Literal[ 6210 "ASSIGN_CONTACT_CATEGORY", 6211 "CREATE_TASK", 6212 "GENERATE_EVENTBRIDGE_EVENT", 6213 "SEND_NOTIFICATION", 6214 ] = Field(alias="ActionType") 6215 task_action: Optional[TaskActionDefinitionModel] = Field( 6216 default=None, alias="TaskAction" 6217 ) 6218 event_bridge_action: Optional[EventBridgeActionDefinitionModel] = Field( 6219 default=None, alias="EventBridgeAction" 6220 ) 6221 assign_contact_category_action: Optional[Mapping[str, Any]] = Field( 6222 default=None, alias="AssignContactCategoryAction" 6223 ) 6224 send_notification_action: Optional[SendNotificationActionDefinitionModel] = Field( 6225 default=None, alias="SendNotificationAction" 6226 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6229class SearchUsersResponseModel(BaseModel): 6230 users: List[UserSearchSummaryModel] = Field(alias="Users") 6231 next_token: str = Field(alias="NextToken") 6232 approximate_total_count: int = Field(alias="ApproximateTotalCount") 6233 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6236class SearchQueuesRequestModel(BaseModel): 6237 instance_id: str = Field(alias="InstanceId") 6238 next_token: Optional[str] = Field(default=None, alias="NextToken") 6239 max_results: Optional[int] = Field(default=None, alias="MaxResults") 6240 search_filter: Optional[QueueSearchFilterModel] = Field( 6241 default=None, alias="SearchFilter" 6242 ) 6243 search_criteria: Optional[QueueSearchCriteriaModel] = Field( 6244 default=None, alias="SearchCriteria" 6245 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6248class SearchQueuesRequestSearchQueuesPaginateModel(BaseModel): 6249 instance_id: str = Field(alias="InstanceId") 6250 search_filter: Optional[QueueSearchFilterModel] = Field( 6251 default=None, alias="SearchFilter" 6252 ) 6253 search_criteria: Optional[QueueSearchCriteriaModel] = Field( 6254 default=None, alias="SearchCriteria" 6255 ) 6256 pagination_config: Optional[PaginatorConfigModel] = Field( 6257 default=None, alias="PaginationConfig" 6258 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6261class SearchRoutingProfilesRequestModel(BaseModel): 6262 instance_id: str = Field(alias="InstanceId") 6263 next_token: Optional[str] = Field(default=None, alias="NextToken") 6264 max_results: Optional[int] = Field(default=None, alias="MaxResults") 6265 search_filter: Optional[RoutingProfileSearchFilterModel] = Field( 6266 default=None, alias="SearchFilter" 6267 ) 6268 search_criteria: Optional[RoutingProfileSearchCriteriaModel] = Field( 6269 default=None, alias="SearchCriteria" 6270 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
SearchRoutingProfilesRequestSearchRoutingProfilesPaginateModel(mypydantic.models.base_model.BaseModel):
6273class SearchRoutingProfilesRequestSearchRoutingProfilesPaginateModel(BaseModel): 6274 instance_id: str = Field(alias="InstanceId") 6275 search_filter: Optional[RoutingProfileSearchFilterModel] = Field( 6276 default=None, alias="SearchFilter" 6277 ) 6278 search_criteria: Optional[RoutingProfileSearchCriteriaModel] = Field( 6279 default=None, alias="SearchCriteria" 6280 ) 6281 pagination_config: Optional[PaginatorConfigModel] = Field( 6282 default=None, alias="PaginationConfig" 6283 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6286class SearchSecurityProfilesRequestModel(BaseModel): 6287 instance_id: str = Field(alias="InstanceId") 6288 next_token: Optional[str] = Field(default=None, alias="NextToken") 6289 max_results: Optional[int] = Field(default=None, alias="MaxResults") 6290 search_criteria: Optional[SecurityProfileSearchCriteriaModel] = Field( 6291 default=None, alias="SearchCriteria" 6292 ) 6293 search_filter: Optional[SecurityProfilesSearchFilterModel] = Field( 6294 default=None, alias="SearchFilter" 6295 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
SearchSecurityProfilesRequestSearchSecurityProfilesPaginateModel(mypydantic.models.base_model.BaseModel):
6298class SearchSecurityProfilesRequestSearchSecurityProfilesPaginateModel(BaseModel): 6299 instance_id: str = Field(alias="InstanceId") 6300 search_criteria: Optional[SecurityProfileSearchCriteriaModel] = Field( 6301 default=None, alias="SearchCriteria" 6302 ) 6303 search_filter: Optional[SecurityProfilesSearchFilterModel] = Field( 6304 default=None, alias="SearchFilter" 6305 ) 6306 pagination_config: Optional[PaginatorConfigModel] = Field( 6307 default=None, alias="PaginationConfig" 6308 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6311class SearchUsersRequestModel(BaseModel): 6312 instance_id: Optional[str] = Field(default=None, alias="InstanceId") 6313 next_token: Optional[str] = Field(default=None, alias="NextToken") 6314 max_results: Optional[int] = Field(default=None, alias="MaxResults") 6315 search_filter: Optional[UserSearchFilterModel] = Field( 6316 default=None, alias="SearchFilter" 6317 ) 6318 search_criteria: Optional[UserSearchCriteriaModel] = Field( 6319 default=None, alias="SearchCriteria" 6320 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6323class SearchUsersRequestSearchUsersPaginateModel(BaseModel): 6324 instance_id: Optional[str] = Field(default=None, alias="InstanceId") 6325 search_filter: Optional[UserSearchFilterModel] = Field( 6326 default=None, alias="SearchFilter" 6327 ) 6328 search_criteria: Optional[UserSearchCriteriaModel] = Field( 6329 default=None, alias="SearchCriteria" 6330 ) 6331 pagination_config: Optional[PaginatorConfigModel] = Field( 6332 default=None, alias="PaginationConfig" 6333 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6336class GetCurrentMetricDataResponseModel(BaseModel): 6337 next_token: str = Field(alias="NextToken") 6338 metric_results: List[CurrentMetricResultModel] = Field(alias="MetricResults") 6339 data_snapshot_time: datetime = Field(alias="DataSnapshotTime") 6340 approximate_total_count: int = Field(alias="ApproximateTotalCount") 6341 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6344class AssociateInstanceStorageConfigRequestModel(BaseModel): 6345 instance_id: str = Field(alias="InstanceId") 6346 resource_type: Literal[ 6347 "AGENT_EVENTS", 6348 "ATTACHMENTS", 6349 "CALL_RECORDINGS", 6350 "CHAT_TRANSCRIPTS", 6351 "CONTACT_EVALUATIONS", 6352 "CONTACT_TRACE_RECORDS", 6353 "MEDIA_STREAMS", 6354 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 6355 "SCHEDULED_REPORTS", 6356 ] = Field(alias="ResourceType") 6357 storage_config: InstanceStorageConfigModel = Field(alias="StorageConfig")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6360class DescribeInstanceStorageConfigResponseModel(BaseModel): 6361 storage_config: InstanceStorageConfigModel = Field(alias="StorageConfig") 6362 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6365class ListInstanceStorageConfigsResponseModel(BaseModel): 6366 storage_configs: List[InstanceStorageConfigModel] = Field(alias="StorageConfigs") 6367 next_token: str = Field(alias="NextToken") 6368 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6371class UpdateInstanceStorageConfigRequestModel(BaseModel): 6372 instance_id: str = Field(alias="InstanceId") 6373 association_id: str = Field(alias="AssociationId") 6374 resource_type: Literal[ 6375 "AGENT_EVENTS", 6376 "ATTACHMENTS", 6377 "CALL_RECORDINGS", 6378 "CHAT_TRANSCRIPTS", 6379 "CONTACT_EVALUATIONS", 6380 "CONTACT_TRACE_RECORDS", 6381 "MEDIA_STREAMS", 6382 "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", 6383 "SCHEDULED_REPORTS", 6384 ] = Field(alias="ResourceType") 6385 storage_config: InstanceStorageConfigModel = Field(alias="StorageConfig")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6388class GetCurrentUserDataResponseModel(BaseModel): 6389 next_token: str = Field(alias="NextToken") 6390 user_data_list: List[UserDataModel] = Field(alias="UserDataList") 6391 approximate_total_count: int = Field(alias="ApproximateTotalCount") 6392 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6395class DescribeUserHierarchyGroupResponseModel(BaseModel): 6396 hierarchy_group: HierarchyGroupModel = Field(alias="HierarchyGroup") 6397 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6400class HistoricalMetricResultModel(BaseModel): 6401 dimensions: Optional[DimensionsModel] = Field(default=None, alias="Dimensions") 6402 collections: Optional[List[HistoricalMetricDataModel]] = Field( 6403 default=None, alias="Collections" 6404 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6407class DescribeHoursOfOperationResponseModel(BaseModel): 6408 hours_of_operation: HoursOfOperationModel = Field(alias="HoursOfOperation") 6409 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6412class CreateTaskTemplateRequestModel(BaseModel): 6413 instance_id: str = Field(alias="InstanceId") 6414 name: str = Field(alias="Name") 6415 fields: Sequence[TaskTemplateFieldModel] = Field(alias="Fields") 6416 description: Optional[str] = Field(default=None, alias="Description") 6417 contact_flow_id: Optional[str] = Field(default=None, alias="ContactFlowId") 6418 constraints: Optional[TaskTemplateConstraintsModel] = Field( 6419 default=None, alias="Constraints" 6420 ) 6421 defaults: Optional[TaskTemplateDefaultsModel] = Field( 6422 default=None, alias="Defaults" 6423 ) 6424 status: Optional[Literal["ACTIVE", "INACTIVE"]] = Field( 6425 default=None, alias="Status" 6426 ) 6427 client_token: Optional[str] = Field(default=None, alias="ClientToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6430class GetTaskTemplateResponseModel(BaseModel): 6431 instance_id: str = Field(alias="InstanceId") 6432 id: str = Field(alias="Id") 6433 arn: str = Field(alias="Arn") 6434 name: str = Field(alias="Name") 6435 description: str = Field(alias="Description") 6436 contact_flow_id: str = Field(alias="ContactFlowId") 6437 constraints: TaskTemplateConstraintsModel = Field(alias="Constraints") 6438 defaults: TaskTemplateDefaultsModel = Field(alias="Defaults") 6439 fields: List[TaskTemplateFieldModel] = Field(alias="Fields") 6440 status: Literal["ACTIVE", "INACTIVE"] = Field(alias="Status") 6441 last_modified_time: datetime = Field(alias="LastModifiedTime") 6442 created_time: datetime = Field(alias="CreatedTime") 6443 tags: Dict[str, str] = Field(alias="Tags") 6444 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6447class UpdateTaskTemplateRequestModel(BaseModel): 6448 task_template_id: str = Field(alias="TaskTemplateId") 6449 instance_id: str = Field(alias="InstanceId") 6450 name: Optional[str] = Field(default=None, alias="Name") 6451 description: Optional[str] = Field(default=None, alias="Description") 6452 contact_flow_id: Optional[str] = Field(default=None, alias="ContactFlowId") 6453 constraints: Optional[TaskTemplateConstraintsModel] = Field( 6454 default=None, alias="Constraints" 6455 ) 6456 defaults: Optional[TaskTemplateDefaultsModel] = Field( 6457 default=None, alias="Defaults" 6458 ) 6459 status: Optional[Literal["ACTIVE", "INACTIVE"]] = Field( 6460 default=None, alias="Status" 6461 ) 6462 fields: Optional[Sequence[TaskTemplateFieldModel]] = Field( 6463 default=None, alias="Fields" 6464 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6467class UpdateTaskTemplateResponseModel(BaseModel): 6468 instance_id: str = Field(alias="InstanceId") 6469 id: str = Field(alias="Id") 6470 arn: str = Field(alias="Arn") 6471 name: str = Field(alias="Name") 6472 description: str = Field(alias="Description") 6473 contact_flow_id: str = Field(alias="ContactFlowId") 6474 constraints: TaskTemplateConstraintsModel = Field(alias="Constraints") 6475 defaults: TaskTemplateDefaultsModel = Field(alias="Defaults") 6476 fields: List[TaskTemplateFieldModel] = Field(alias="Fields") 6477 status: Literal["ACTIVE", "INACTIVE"] = Field(alias="Status") 6478 last_modified_time: datetime = Field(alias="LastModifiedTime") 6479 created_time: datetime = Field(alias="CreatedTime") 6480 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6483class UpdateParticipantRoleConfigChannelInfoModel(BaseModel): 6484 chat: Optional[ChatParticipantRoleConfigModel] = Field(default=None, alias="Chat")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6487class DescribeQuickConnectResponseModel(BaseModel): 6488 quick_connect: QuickConnectModel = Field(alias="QuickConnect") 6489 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6492class CreateRuleRequestModel(BaseModel): 6493 instance_id: str = Field(alias="InstanceId") 6494 name: str = Field(alias="Name") 6495 trigger_event_source: RuleTriggerEventSourceModel = Field( 6496 alias="TriggerEventSource" 6497 ) 6498 function: str = Field(alias="Function") 6499 actions: Sequence[RuleActionModel] = Field(alias="Actions") 6500 publish_status: Literal["DRAFT", "PUBLISHED"] = Field(alias="PublishStatus") 6501 client_token: Optional[str] = Field(default=None, alias="ClientToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6504class RuleModel(BaseModel): 6505 name: str = Field(alias="Name") 6506 rule_id: str = Field(alias="RuleId") 6507 rule_arn: str = Field(alias="RuleArn") 6508 trigger_event_source: RuleTriggerEventSourceModel = Field( 6509 alias="TriggerEventSource" 6510 ) 6511 function: str = Field(alias="Function") 6512 actions: List[RuleActionModel] = Field(alias="Actions") 6513 publish_status: Literal["DRAFT", "PUBLISHED"] = Field(alias="PublishStatus") 6514 created_time: datetime = Field(alias="CreatedTime") 6515 last_updated_time: datetime = Field(alias="LastUpdatedTime") 6516 last_updated_by: str = Field(alias="LastUpdatedBy") 6517 tags: Optional[Dict[str, str]] = Field(default=None, alias="Tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6520class UpdateRuleRequestModel(BaseModel): 6521 rule_id: str = Field(alias="RuleId") 6522 instance_id: str = Field(alias="InstanceId") 6523 name: str = Field(alias="Name") 6524 function: str = Field(alias="Function") 6525 actions: Sequence[RuleActionModel] = Field(alias="Actions") 6526 publish_status: Literal["DRAFT", "PUBLISHED"] = Field(alias="PublishStatus")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6529class GetMetricDataResponseModel(BaseModel): 6530 next_token: str = Field(alias="NextToken") 6531 metric_results: List[HistoricalMetricResultModel] = Field(alias="MetricResults") 6532 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6535class UpdateParticipantRoleConfigRequestModel(BaseModel): 6536 instance_id: str = Field(alias="InstanceId") 6537 contact_id: str = Field(alias="ContactId") 6538 channel_configuration: UpdateParticipantRoleConfigChannelInfoModel = Field( 6539 alias="ChannelConfiguration" 6540 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
6543class DescribeRuleResponseModel(BaseModel): 6544 rule: RuleModel = Field(alias="Rule") 6545 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs